From 70faf927fdd5f93b2e7e1f93cf9c0bf080b58c7d Mon Sep 17 00:00:00 2001 From: Natalie Rose Date: Sun, 6 Sep 2026 19:27:15 +1000 Subject: [PATCH] Updates after updating the client --- lib/core/config.ts | 2 - lib/endpoints/empire.test.ts | 2 - lib/lacuna.ts | 3 +- lib/types/empire.ts | 8 +- lib/types/schema.ts | 36140 +++++++++++++++++++++++++-------- package-lock.json | 14 +- package.json | 2 +- 7 files changed, 27206 insertions(+), 8965 deletions(-) diff --git a/lib/core/config.ts b/lib/core/config.ts index d196fa5..2fd5983 100644 --- a/lib/core/config.ts +++ b/lib/core/config.ts @@ -7,14 +7,12 @@ class Config { serverUrl = 'https://lacuna.allosaurus-chromatic.ts.net/'; apiKey = 'anonymous'; - fingerprintToken = 'TODO'; constructor(lacuna: Lacuna, config: LacunaConfig) { this.lacuna = lacuna; if (config.serverUrl) this.serverUrl = ensureTrailingSlash(config.serverUrl); if (config.apiKey) this.apiKey = config.apiKey; - if (config.fingerprintToken) this.fingerprintToken = config.fingerprintToken; } } diff --git a/lib/endpoints/empire.test.ts b/lib/endpoints/empire.test.ts index a778035..dcfde93 100644 --- a/lib/endpoints/empire.test.ts +++ b/lib/endpoints/empire.test.ts @@ -28,7 +28,6 @@ test('login with errors', async () => { const { error } = await lacuna.empire.login({ empire_name: 'non-existant-empire', password: 'incorrect-password', - browser: 'todo', api_key: 'anonymous', }); @@ -42,7 +41,6 @@ test('login', async () => { const { result } = await lacuna.empire.login({ empire_name: 'nataliethistime', password: '1234qwer', - browser: 'todo', api_key: 'anonymous', }); expect(result?.session_id).toBeDefined(); diff --git a/lib/lacuna.ts b/lib/lacuna.ts index 6902f5a..e2f62d4 100644 --- a/lib/lacuna.ts +++ b/lib/lacuna.ts @@ -201,7 +201,7 @@ class Lacuna { this.security = new Security(this, 'security'); this.shipyard = new Shipyard(this, 'shipyard'); this.spacePort = new SpacePort(this, 'spaceport'); - this.spaceStationLab = new SpaceStationLab(this, 'spacestationlab'); + this.spaceStationLab = new SpaceStationLab(this, 'ssla'); this.stationCommand = new StationCommand(this, 'stationcommand'); this.stats = new Stats(this, 'stats'); this.subspaceSupplyDepot = new SubspaceSupplyDepot(this, 'subspacesupplydepot'); @@ -221,7 +221,6 @@ class Lacuna { empire_name: name, password, api_key: this.config.apiKey, - browser: this.config.fingerprintToken, }); if (result) { diff --git a/lib/types/empire.ts b/lib/types/empire.ts index 8cfef5d..f42c46b 100644 --- a/lib/types/empire.ts +++ b/lib/types/empire.ts @@ -31,7 +31,6 @@ interface ProfileSkipFlags { skip_resource_warnings: IntBool; skip_pollution_warnings: IntBool; skip_medal_messages: IntBool; - skip_facebook_wall_posts: IntBool; skip_found_nothing: IntBool; skip_excavator_resources: IntBool; skip_excavator_glyph: IntBool; @@ -189,16 +188,13 @@ export interface CreateParams { captcha_guid: string; captcha_solution: string; /** - * Must be between 6 and 30 characters. Required unless a valid - * facebook_uid/facebook_token pair is supplied. + * Must be between 6 and 30 characters. */ password?: string; /** Must match `password`. Required whenever `password` is supplied. */ password1?: string; /** Not required, but used for password recovery. */ email?: string; - facebook_uid?: string; - facebook_token?: string; /** A 36 character code sent to the user by a friend. Usable only once. */ invite_code?: string; } @@ -279,8 +275,6 @@ export interface LoginParams { empire_name: string; password: string; api_key: string; - /** Optional client identifier recorded against the session. */ - browser?: string; } export interface LoginResponse { diff --git a/lib/types/schema.ts b/lib/types/schema.ts index d0a8e2e..ccd3925 100644 --- a/lib/types/schema.ts +++ b/lib/types/schema.ts @@ -13,6 +13,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -23,8 +27,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -85,6 +92,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -95,6 +106,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -155,6 +167,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -165,6 +181,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -217,6 +234,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -227,6 +248,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -278,6 +300,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -288,6 +314,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -340,6 +367,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -350,7 +381,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -423,6 +456,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -433,6 +470,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -484,6 +522,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -494,8 +536,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -556,6 +601,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -566,6 +615,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -626,6 +676,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -636,6 +690,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -688,6 +743,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -698,6 +757,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -749,6 +809,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -759,6 +823,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -811,6 +876,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -821,7 +890,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -894,6 +965,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -904,6 +979,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -955,6 +1031,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View an alliance's public profile. + * @description Provides a list of the data that is publicly known about an alliance. Throws 1002. + */ post: { parameters: { query?: never; @@ -965,6 +1045,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the alliance for which you'd like to retrieve the public profile. */ alliance_id: number; }; }; @@ -1033,6 +1114,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Find alliances by name. + * @description Finds an alliance by name. Returns a hash reference containing alliance ids and alliance names. + */ post: { parameters: { query?: never; @@ -1043,6 +1128,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The name you're searching for. Case insensitive, and partial names work fine. Must be at least 3 characters. */ name: string; }; }; @@ -1097,6 +1183,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -1107,8 +1197,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -1169,6 +1262,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -1179,6 +1276,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -1239,6 +1337,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -1249,6 +1351,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -1301,6 +1404,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -1311,6 +1418,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -1362,6 +1470,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -1372,6 +1484,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -1424,6 +1537,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -1434,7 +1551,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -1507,6 +1626,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -1517,6 +1640,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -1568,6 +1692,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -1578,8 +1706,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -1640,6 +1771,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -1650,6 +1785,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -1710,6 +1846,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -1720,6 +1860,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -1772,6 +1913,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -1782,6 +1927,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -1833,6 +1979,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -1843,6 +1993,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -1895,6 +2046,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -1905,7 +2060,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -1978,6 +2135,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -1988,6 +2149,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -2039,6 +2201,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -2049,8 +2215,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -2111,6 +2280,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -2121,6 +2294,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -2181,6 +2355,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -2191,6 +2369,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -2243,6 +2422,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -2253,6 +2436,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -2304,6 +2488,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -2314,6 +2502,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -2366,6 +2555,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -2376,7 +2569,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -2449,6 +2644,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -2459,6 +2658,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -2510,6 +2710,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Search for glyph. + * @description Searches ore for an ancient glyph. Returns the building view. + */ post: { parameters: { query?: never; @@ -2520,6 +2724,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; /** * @description Consumes 10,000 of this ore type to search for a glyph. @@ -2576,6 +2781,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Subsidize search. + * @description Spends 2 essentia to complete the current glyph search immediately. Returns the building view. + */ post: { parameters: { query?: never; @@ -2586,6 +2795,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -2637,6 +2847,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get glyph summary. + * @description Returns the glyphs available for assembly. + */ post: { parameters: { query?: never; @@ -2647,6 +2861,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -2703,6 +2918,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Assemble glyphs. + * @description Converts glyphs into a rare ancient item. + */ post: { parameters: { query?: never; @@ -2713,6 +2932,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; /** @description Up to four glyph type names to combine. */ glyphs: string[]; @@ -2768,6 +2988,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get ores available for processing. + * @description Lists ore types with sufficient quantity in storage to search for a glyph. + */ post: { parameters: { query?: never; @@ -2778,6 +3002,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -2832,6 +3057,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View excavators. + * @description Lists the active excavator sites controlled by this ministry. + */ post: { parameters: { query?: never; @@ -2842,6 +3071,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -2910,6 +3140,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Abandon excavator. + * @description Closes a single excavator site. + */ post: { parameters: { query?: never; @@ -2920,7 +3154,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the excavator site. */ site_id: number; }; }; @@ -2971,6 +3207,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Mass abandon excavator. + * @description Destroys all excavators belonging to this ministry. + */ post: { parameters: { query?: never; @@ -2981,6 +3221,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -3031,6 +3272,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this module's properties. + * @description Retrieves the properties of this module. + */ post: { parameters: { query?: never; @@ -3041,6 +3286,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -3100,6 +3346,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -3110,8 +3360,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -3172,6 +3425,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -3182,6 +3439,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -3242,6 +3500,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -3252,6 +3514,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -3304,6 +3567,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -3314,6 +3581,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -3365,6 +3633,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -3375,6 +3647,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -3427,6 +3700,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -3437,7 +3714,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -3510,6 +3789,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -3520,6 +3803,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -3562,7 +3846,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beach/build": { + "/v2/beach1/build": { parameters: { query?: never; header?: never; @@ -3571,6 +3855,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -3581,8 +3869,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -3634,7 +3925,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beach/upgrade": { + "/v2/beach1/upgrade": { parameters: { query?: never; header?: never; @@ -3643,6 +3934,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -3653,6 +3948,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -3704,7 +4000,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beach/downgrade": { + "/v2/beach1/downgrade": { parameters: { query?: never; header?: never; @@ -3713,6 +4009,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -3723,6 +4023,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -3766,7 +4067,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beach/demolish": { + "/v2/beach1/demolish": { parameters: { query?: never; header?: never; @@ -3775,6 +4076,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -3785,6 +4090,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -3827,7 +4133,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beach/repair": { + "/v2/beach1/repair": { parameters: { query?: never; header?: never; @@ -3836,6 +4142,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -3846,6 +4156,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -3889,7 +4200,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beach/get_stats_for_level": { + "/v2/beach1/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -3898,6 +4209,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -3908,7 +4223,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -3972,7 +4289,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beach/view": { + "/v2/beach1/view": { parameters: { query?: never; header?: never; @@ -3981,6 +4298,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -3991,6 +4312,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -4033,7 +4355,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/bean/build": { + "/v2/beach2/build": { parameters: { query?: never; header?: never; @@ -4042,6 +4364,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -4052,8 +4378,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -4105,7 +4434,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/bean/upgrade": { + "/v2/beach2/upgrade": { parameters: { query?: never; header?: never; @@ -4114,6 +4443,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -4124,6 +4457,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -4175,7 +4509,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/bean/downgrade": { + "/v2/beach2/downgrade": { parameters: { query?: never; header?: never; @@ -4184,6 +4518,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -4194,6 +4532,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -4237,7 +4576,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/bean/demolish": { + "/v2/beach2/demolish": { parameters: { query?: never; header?: never; @@ -4246,6 +4585,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -4256,6 +4599,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -4298,7 +4642,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/bean/repair": { + "/v2/beach2/repair": { parameters: { query?: never; header?: never; @@ -4307,6 +4651,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -4317,6 +4665,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -4360,7 +4709,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/bean/get_stats_for_level": { + "/v2/beach2/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -4369,6 +4718,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -4379,7 +4732,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -4443,7 +4798,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/bean/view": { + "/v2/beach2/view": { parameters: { query?: never; header?: never; @@ -4452,6 +4807,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -4462,6 +4821,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -4504,7 +4864,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beeldeban/build": { + "/v2/beach3/build": { parameters: { query?: never; header?: never; @@ -4513,6 +4873,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -4523,8 +4887,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -4576,7 +4943,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beeldeban/upgrade": { + "/v2/beach3/upgrade": { parameters: { query?: never; header?: never; @@ -4585,6 +4952,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -4595,6 +4966,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -4646,7 +5018,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beeldeban/downgrade": { + "/v2/beach3/downgrade": { parameters: { query?: never; header?: never; @@ -4655,6 +5027,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -4665,6 +5041,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -4708,7 +5085,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beeldeban/demolish": { + "/v2/beach3/demolish": { parameters: { query?: never; header?: never; @@ -4717,6 +5094,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -4727,6 +5108,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -4769,7 +5151,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beeldeban/repair": { + "/v2/beach3/repair": { parameters: { query?: never; header?: never; @@ -4778,6 +5160,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -4788,6 +5174,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -4831,7 +5218,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beeldeban/get_stats_for_level": { + "/v2/beach3/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -4840,6 +5227,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -4850,7 +5241,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -4914,7 +5307,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beeldeban/view": { + "/v2/beach3/view": { parameters: { query?: never; header?: never; @@ -4923,6 +5316,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -4933,6 +5330,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -4975,7 +5373,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beeldebannest/build": { + "/v2/beach4/build": { parameters: { query?: never; header?: never; @@ -4984,6 +5382,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -4994,8 +5396,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -5047,7 +5452,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beeldebannest/upgrade": { + "/v2/beach4/upgrade": { parameters: { query?: never; header?: never; @@ -5056,6 +5461,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -5066,6 +5475,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -5117,7 +5527,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beeldebannest/downgrade": { + "/v2/beach4/downgrade": { parameters: { query?: never; header?: never; @@ -5126,6 +5536,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -5136,6 +5550,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -5179,7 +5594,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beeldebannest/demolish": { + "/v2/beach4/demolish": { parameters: { query?: never; header?: never; @@ -5188,6 +5603,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -5198,6 +5617,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -5240,7 +5660,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beeldebannest/repair": { + "/v2/beach4/repair": { parameters: { query?: never; header?: never; @@ -5249,6 +5669,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -5259,6 +5683,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -5302,7 +5727,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beeldebannest/get_stats_for_level": { + "/v2/beach4/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -5311,6 +5736,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -5321,7 +5750,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -5385,7 +5816,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/beeldebannest/view": { + "/v2/beach4/view": { parameters: { query?: never; header?: never; @@ -5394,6 +5825,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -5404,6 +5839,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -5446,7 +5882,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/blackholegenerator/build": { + "/v2/beach5/build": { parameters: { query?: never; header?: never; @@ -5455,6 +5891,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -5465,8 +5905,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -5518,7 +5961,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/blackholegenerator/upgrade": { + "/v2/beach5/upgrade": { parameters: { query?: never; header?: never; @@ -5527,6 +5970,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -5537,6 +5984,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -5588,7 +6036,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/blackholegenerator/downgrade": { + "/v2/beach5/downgrade": { parameters: { query?: never; header?: never; @@ -5597,6 +6045,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -5607,6 +6059,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -5650,7 +6103,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/blackholegenerator/demolish": { + "/v2/beach5/demolish": { parameters: { query?: never; header?: never; @@ -5659,6 +6112,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -5669,6 +6126,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -5711,7 +6169,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/blackholegenerator/repair": { + "/v2/beach5/repair": { parameters: { query?: never; header?: never; @@ -5720,6 +6178,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -5730,6 +6192,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -5773,7 +6236,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/blackholegenerator/get_stats_for_level": { + "/v2/beach5/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -5782,6 +6245,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -5792,7 +6259,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -5856,7 +6325,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/blackholegenerator/view": { + "/v2/beach5/view": { parameters: { query?: never; header?: never; @@ -5865,6 +6334,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -5875,6 +6348,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -5896,27 +6370,85 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - /** @description Tasks the generator can currently attempt (range is not factored in). */ - tasks?: { - /** @enum {string} */ - name: "Make Asteroid" | "Make Planet" | "Increase Size" | "Change Type" | "Swap Places" | "Jump Zone" | "Move System"; - base_fail?: number; - min_level?: number; - /** @enum {integer} */ - occupied?: 0 | 1; - /** @description Cooldown, in seconds, before the task can be used again. */ - recovery?: number; - side_chance?: number; - types?: string[]; - waste_cost?: number; - /** @description Present when the task cannot currently be used. */ - reason?: string; - }[]; - task_options?: { - asteroid_types?: number[]; - planet_types?: number[]; - zones?: string[]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/beach6/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -5938,7 +6470,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/blackholegenerator/generate_singularity": { + "/v2/beach6/upgrade": { parameters: { query?: never; header?: never; @@ -5947,6 +6479,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -5957,39 +6493,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - /** @description Identifies the target body, star, or zone for the task. Provide one addressing scheme. */ - target: { - /** @description Case insensitive; throws if it doesn't match a body. */ - body_name?: string; - body_id?: number; - x?: number; - y?: number; - /** @description Case insensitive; throws if it doesn't match a star. */ - star_name?: string; - star_id?: number; - /** @description Used with star_name/star_id to target a specific (possibly unoccupied) orbit around that star. */ - orbit?: number; - /** @description Zone name, e.g. '-1|4'. Only used for the Jump Zone task. */ - zone?: string; - }; - /** @enum {string} */ - task_name: "Make Asteroid" | "Make Planet" | "Increase Size" | "Change Type" | "Swap Places" | "Jump Zone" | "Move System"; - /** @description Only used for the 'Change Type' task. */ - params?: { - /** @description One of the 40 basic planet type ids. */ - newtype?: number; - }; - /** - * @description Spend essentia to guarantee 'perfection' (100% success). Only supported via this named-argument form. - * @enum {integer} - */ - subsidize?: 0 | 1; }; }; }; responses: { - /** @description Attempts a Black Hole Generator task against the target body. Returns the success, failure, and side-effect results (not all fields are populated for every outcome). Throws 1002, 1009, 1010, 1013. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -5999,31 +6509,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - /** @description Present when the task failed. */ - fail?: Record; - /** @description Present when a side effect occurred. */ - side?: Record; - /** @description Present when the task succeeded (or produced a side effect). */ - target?: { - class?: string; - id?: number; - name?: string; - old_class?: string; - old_size?: number; - message?: string; - size?: number; - /** @enum {string} */ - type?: "asteroid" | "gas giant" | "habitable planet" | "space station"; - /** @enum {integer} */ - variance?: -1 | 0 | 1; - /** @enum {string} */ - waste?: "Zero" | "Random" | "Filled"; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -6045,7 +6545,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/blackholegenerator/get_actions_for": { + "/v2/beach6/downgrade": { parameters: { query?: never; header?: never; @@ -6054,6 +6554,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -6064,27 +6568,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - /** @description Identifies the target body, star, or zone for the task. Provide one addressing scheme. */ - target: { - /** @description Case insensitive; throws if it doesn't match a body. */ - body_name?: string; - body_id?: number; - x?: number; - y?: number; - /** @description Case insensitive; throws if it doesn't match a star. */ - star_name?: string; - star_id?: number; - /** @description Used with star_name/star_id to target a specific (possibly unoccupied) orbit around that star. */ - orbit?: number; - /** @description Zone name, e.g. '-1|4'. Only used for the Jump Zone task. */ - zone?: string; - }; }; }; }; responses: { - /** @description Returns the task list with success percentage and Essentia cost for the given target. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -6094,40 +6584,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - building?: components["schemas"]["building"]; - tasks: { - /** @enum {string} */ - name: "Make Asteroid" | "Make Planet" | "Increase Size" | "Change Type" | "Swap Places" | "Jump Zone" | "Move System"; - base_fail?: number; - body_id?: number; - dist?: number; - min_level?: number; - /** @enum {integer} */ - occupied?: 0 | 1; - range?: number; - /** @description Present when the task cannot currently be used. */ - reason?: string; - recovery?: number; - side_chance?: number; - /** @description Percentage chance of success. */ - success?: number; - /** @description Essentia cost to make the task 'perfect' (100% success). Minimum is 2. */ - essentia_cost?: number; - /** @description RPC error code thrown if the task cannot be used. */ - throw?: number; - types?: string[]; - waste_cost?: number; - /** - * @description Present only when name is 'Change Type'. - * @enum {string} - */ - body_type?: "asteroid" | "habitable planet"; - }[]; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -6149,7 +6612,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/blackholegenerator/subsidize_cooldown": { + "/v2/beach6/demolish": { parameters: { query?: never; header?: never; @@ -6158,6 +6621,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -6168,12 +6635,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Spends 2 essentia to cool down the generator immediately. Returns the building view. Throws 1011. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -6183,12 +6651,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -6210,7 +6678,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/body/get_status": { + "/v2/beach6/repair": { parameters: { query?: never; header?: never; @@ -6219,6 +6687,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -6229,12 +6701,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Returns information about the current state of this body. Must be owned or a sitter of the current empire. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -6244,9 +6717,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - server?: components["schemas"]["server_status"]; - empire: components["schemas"]["empire_status"]; - body: components["schemas"]["body_status"]; + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -6268,7 +6745,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/body/get_body_status": { + "/v2/beach6/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -6277,6 +6754,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -6287,12 +6768,15 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Usd in the Star Map. Returns public information about the given body. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -6302,8 +6786,29 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - body: components["schemas"]["body_status"]; - status?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; + status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; @@ -6329,7 +6834,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/body/get_buildings": { + "/v2/beach6/view": { parameters: { query?: never; header?: never; @@ -6338,6 +6843,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -6348,12 +6857,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; + /** @description The id of the building you wish to retrieve. */ + building_id: number; }; }; }; responses: { - /** @description Retrieves the buildings on a planet's 11x11 (-5 to 5) surface grid. The planetary command building is always at 0,0. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -6363,10 +6873,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - buildings: components["schemas"]["buildings_list"]; - body: { - surface_image: string; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -6393,7 +6900,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/body/get_buildings_resources": { + "/v2/beach7/build": { parameters: { query?: never; header?: never; @@ -6402,6 +6909,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -6412,12 +6923,17 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Like get_buildings, but every building entry additionally carries a `resources` object: hourly production/consumption and storage capacity for food/ore/water/waste/energy plus happiness_hour, and per-food-type / per-ore-type production breakdowns (each omitted when the building produces none of that resource). */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -6427,15 +6943,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - buildings: components["schemas"]["buildings_resources_list"]; - body: { - surface_image: string; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -6457,7 +6979,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/body/repair_list": { + "/v2/beach7/upgrade": { parameters: { query?: never; header?: never; @@ -6466,6 +6988,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -6476,13 +7002,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - building_ids: number[]; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Repairs the given buildings, in the order provided. Returns the same shape as get_buildings, but only for the repaired buildings. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -6492,15 +7018,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - buildings: components["schemas"]["buildings_list"]; - body: { - surface_image: string; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -6522,7 +7054,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/body/rearrange_buildings": { + "/v2/beach7/downgrade": { parameters: { query?: never; header?: never; @@ -6531,6 +7063,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -6541,18 +7077,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - /** @description Every building being moved must be included. The Planetary Command/Station Command must end up at 0,0. */ - arrangement: { - id: number; - x: number; - y: number; - }[]; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Rearranges buildings to the supplied coordinates. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -6562,20 +7093,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - moved: { - id: number; - name: string; - x: number; - y: number; - }[]; - body: { - surface_image: string; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -6597,7 +7121,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/body/get_buildable": { + "/v2/beach7/demolish": { parameters: { query?: never; header?: never; @@ -6606,6 +7130,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -6616,16 +7144,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; - /** @description A tag to filter buildable types by. Cannot be Now, Soon, or Later. */ - tag: string; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Lists the building types buildable at a given spot for a given tag. If multiple plans apply, returns the one with the highest extra_build_level. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -6635,42 +7160,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - max_items_in_build_queue: number; - build_queue: { - max: number; - current: number; - }; - /** @description Keyed by building type name. */ - buildable: { - [key: string]: { - url: string; - image: string; - build: { - /** @enum {integer} */ - can: 1 | 0; - /** @enum {integer} */ - no_plot_use: 1 | 0; - cost: components["schemas"]["building_cost"]; - extra_level?: number; - tags: string[]; - /** @description [code, message, data], same shape as an rpc_error. */ - reason: unknown[]; - }; - production: { - food_hour?: number; - energy_hour?: number; - ore_hour?: number; - water_hour?: number; - waste_hour?: number; - happiness_hour?: number; - }; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -6692,7 +7187,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/body/get_buildable_locations": { + "/v2/beach7/repair": { parameters: { query?: never; header?: never; @@ -6701,6 +7196,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -6711,14 +7210,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - /** @description Optional building footprint size. 9 = center tile (LCOT), 4 = northwest tile (SSLA); omitted/other values return locations for single-tile buildings. */ - size?: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Lists unoccupied buildable locations on the planet. Order is not guaranteed. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -6728,12 +7226,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - unoccupied: number[][]; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -6755,7 +7254,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/body/rename": { + "/v2/beach7/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -6764,6 +7263,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -6774,68 +7277,15 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - name: string; - }; - }; - }; - responses: { - /** @description Renames a body owned by the empire attached to this session. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - /** @enum {integer} */ - result?: 1; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/body/abandon": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - body_id: number; + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Abandons a colony, destroying everything on the planet. The home planet cannot be abandoned. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -6845,6 +7295,28 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -6871,7 +7343,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/body/view_laws": { + "/v2/beach7/view": { parameters: { query?: never; header?: never; @@ -6880,6 +7352,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -6890,13 +7366,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description The id of the space station itself, not its Parliament building. */ - body_id: number; + /** @description The id of the building you wish to retrieve. */ + building_id: number; }; }; }; responses: { - /** @description Returns the laws enacted by this space station. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -6906,17 +7382,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - laws: { - id: number; - name: string; - description: string; - date_enacted: string; - }[]; }; }; }; @@ -6938,7 +7409,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/body/set_colony_notes": { + "/v2/beach8/build": { parameters: { query?: never; header?: never; @@ -6947,6 +7418,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -6957,15 +7432,17 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; - options: { - notes: string; - }; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Sets the per-colony notes for an owned body (colony or station). */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -6975,11 +7452,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -7001,7 +7488,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/bread/build": { + "/v2/beach8/upgrade": { parameters: { query?: never; header?: never; @@ -7010,6 +7497,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -7020,14 +7511,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -7073,7 +7563,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/bread/upgrade": { + "/v2/beach8/downgrade": { parameters: { query?: never; header?: never; @@ -7082,6 +7572,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -7092,12 +7586,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -7107,15 +7602,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -7143,7 +7630,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/bread/downgrade": { + "/v2/beach8/demolish": { parameters: { query?: never; header?: never; @@ -7152,6 +7639,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -7162,12 +7653,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -7177,7 +7669,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -7205,68 +7696,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/bread/demolish": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; - responses: { - /** @description Instantly destroys a building. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/bread/repair": { + "/v2/beach8/repair": { parameters: { query?: never; header?: never; @@ -7275,6 +7705,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -7285,6 +7719,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -7328,7 +7763,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/bread/get_stats_for_level": { + "/v2/beach8/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -7337,6 +7772,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -7347,7 +7786,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -7411,7 +7852,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/bread/view": { + "/v2/beach8/view": { parameters: { query?: never; header?: never; @@ -7420,6 +7861,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -7430,6 +7875,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -7472,7 +7918,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/burger/build": { + "/v2/beach9/build": { parameters: { query?: never; header?: never; @@ -7481,6 +7927,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -7491,8 +7941,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -7544,7 +7997,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/burger/upgrade": { + "/v2/beach9/upgrade": { parameters: { query?: never; header?: never; @@ -7553,6 +8006,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -7563,6 +8020,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -7614,7 +8072,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/burger/downgrade": { + "/v2/beach9/downgrade": { parameters: { query?: never; header?: never; @@ -7623,6 +8081,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -7633,6 +8095,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -7676,7 +8139,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/burger/demolish": { + "/v2/beach9/demolish": { parameters: { query?: never; header?: never; @@ -7685,6 +8148,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -7695,6 +8162,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -7737,7 +8205,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/burger/repair": { + "/v2/beach9/repair": { parameters: { query?: never; header?: never; @@ -7746,6 +8214,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -7756,6 +8228,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -7799,7 +8272,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/burger/get_stats_for_level": { + "/v2/beach9/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -7808,6 +8281,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -7818,7 +8295,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -7882,7 +8361,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/burger/view": { + "/v2/beach9/view": { parameters: { query?: never; header?: never; @@ -7891,6 +8370,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -7901,6 +8384,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -7943,7 +8427,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/capitol/build": { + "/v2/beach10/build": { parameters: { query?: never; header?: never; @@ -7952,6 +8436,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -7962,8 +8450,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -8015,7 +8506,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/capitol/upgrade": { + "/v2/beach10/upgrade": { parameters: { query?: never; header?: never; @@ -8024,6 +8515,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -8034,6 +8529,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -8085,7 +8581,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/capitol/downgrade": { + "/v2/beach10/downgrade": { parameters: { query?: never; header?: never; @@ -8094,6 +8590,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -8104,6 +8604,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -8147,7 +8648,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/capitol/demolish": { + "/v2/beach10/demolish": { parameters: { query?: never; header?: never; @@ -8156,6 +8657,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -8166,6 +8671,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -8208,7 +8714,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/capitol/repair": { + "/v2/beach10/repair": { parameters: { query?: never; header?: never; @@ -8217,6 +8723,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -8227,6 +8737,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -8270,7 +8781,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/capitol/get_stats_for_level": { + "/v2/beach10/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -8279,6 +8790,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -8289,7 +8804,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -8353,7 +8870,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/capitol/view": { + "/v2/beach10/view": { parameters: { query?: never; header?: never; @@ -8362,6 +8879,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -8372,6 +8893,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -8393,7 +8915,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - rename_empire_cost?: number; }; }; }; @@ -8415,177 +8936,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/capitol/rename_empire": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - name: string; - }; - }; - }; - responses: { - /** @description Spends essentia to change the empire's name (cost given by view's rename_empire_cost). */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/captcha/fetch": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Retrieves a captcha required to call solve. Display it, then call solve with the user's response. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - guid: string; - url: string; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/captcha/solve": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** @description Must match the guid from fetch. */ - guid: string; - /** @description The user's typed solution. */ - solution: string; - }; - }; - }; - responses: { - /** @description Validates the solution against the given guid. On success the captcha remains valid for thirty minutes and this returns 1. Captchas are single-use; throws 1014 on mismatch, with new captcha data in the error data that must be used for the next attempt. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - /** @enum {integer} */ - result?: 1; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/cheese/build": { + "/v2/beach11/build": { parameters: { query?: never; header?: never; @@ -8594,6 +8945,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -8604,8 +8959,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -8657,7 +9015,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cheese/upgrade": { + "/v2/beach11/upgrade": { parameters: { query?: never; header?: never; @@ -8666,6 +9024,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -8676,6 +9038,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -8727,7 +9090,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cheese/downgrade": { + "/v2/beach11/downgrade": { parameters: { query?: never; header?: never; @@ -8736,6 +9099,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -8746,6 +9113,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -8789,7 +9157,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cheese/demolish": { + "/v2/beach11/demolish": { parameters: { query?: never; header?: never; @@ -8798,6 +9166,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -8808,6 +9180,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -8850,7 +9223,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cheese/repair": { + "/v2/beach11/repair": { parameters: { query?: never; header?: never; @@ -8859,6 +9232,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -8869,6 +9246,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -8912,7 +9290,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cheese/get_stats_for_level": { + "/v2/beach11/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -8921,6 +9299,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -8931,7 +9313,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -8995,7 +9379,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cheese/view": { + "/v2/beach11/view": { parameters: { query?: never; header?: never; @@ -9004,6 +9388,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -9014,6 +9402,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -9056,7 +9445,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/chip/build": { + "/v2/beach12/build": { parameters: { query?: never; header?: never; @@ -9065,6 +9454,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -9075,8 +9468,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -9128,7 +9524,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/chip/upgrade": { + "/v2/beach12/upgrade": { parameters: { query?: never; header?: never; @@ -9137,6 +9533,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -9147,6 +9547,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -9198,7 +9599,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/chip/downgrade": { + "/v2/beach12/downgrade": { parameters: { query?: never; header?: never; @@ -9207,6 +9608,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -9217,6 +9622,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -9260,7 +9666,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/chip/demolish": { + "/v2/beach12/demolish": { parameters: { query?: never; header?: never; @@ -9269,6 +9675,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -9279,6 +9689,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -9321,7 +9732,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/chip/repair": { + "/v2/beach12/repair": { parameters: { query?: never; header?: never; @@ -9330,6 +9741,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -9340,6 +9755,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -9383,7 +9799,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/chip/get_stats_for_level": { + "/v2/beach12/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -9392,6 +9808,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -9402,7 +9822,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -9466,7 +9888,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/chip/view": { + "/v2/beach12/view": { parameters: { query?: never; header?: never; @@ -9475,6 +9897,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -9485,6 +9911,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -9527,7 +9954,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cider/build": { + "/v2/beach13/build": { parameters: { query?: never; header?: never; @@ -9536,6 +9963,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -9546,8 +9977,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -9599,7 +10033,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cider/upgrade": { + "/v2/beach13/upgrade": { parameters: { query?: never; header?: never; @@ -9608,6 +10042,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -9618,6 +10056,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -9669,7 +10108,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cider/downgrade": { + "/v2/beach13/downgrade": { parameters: { query?: never; header?: never; @@ -9678,6 +10117,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -9688,6 +10131,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -9731,7 +10175,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cider/demolish": { + "/v2/beach13/demolish": { parameters: { query?: never; header?: never; @@ -9740,6 +10184,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -9750,6 +10198,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -9792,7 +10241,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cider/repair": { + "/v2/beach13/repair": { parameters: { query?: never; header?: never; @@ -9801,6 +10250,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -9811,6 +10264,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -9854,7 +10308,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cider/get_stats_for_level": { + "/v2/beach13/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -9863,6 +10317,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -9873,7 +10331,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -9937,7 +10397,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cider/view": { + "/v2/beach13/view": { parameters: { query?: never; header?: never; @@ -9946,6 +10406,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -9956,6 +10420,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -9998,7 +10463,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/citadelofknope/build": { + "/v2/bean/build": { parameters: { query?: never; header?: never; @@ -10007,6 +10472,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -10017,8 +10486,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -10070,7 +10542,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/citadelofknope/upgrade": { + "/v2/bean/upgrade": { parameters: { query?: never; header?: never; @@ -10079,6 +10551,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -10089,6 +10565,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -10140,7 +10617,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/citadelofknope/downgrade": { + "/v2/bean/downgrade": { parameters: { query?: never; header?: never; @@ -10149,6 +10626,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -10159,6 +10640,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -10202,7 +10684,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/citadelofknope/demolish": { + "/v2/bean/demolish": { parameters: { query?: never; header?: never; @@ -10211,6 +10693,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -10221,6 +10707,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -10263,7 +10750,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/citadelofknope/repair": { + "/v2/bean/repair": { parameters: { query?: never; header?: never; @@ -10272,6 +10759,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -10282,6 +10773,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -10325,7 +10817,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/citadelofknope/get_stats_for_level": { + "/v2/bean/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -10334,6 +10826,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -10344,7 +10840,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -10408,7 +10906,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/citadelofknope/view": { + "/v2/bean/view": { parameters: { query?: never; header?: never; @@ -10417,6 +10915,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -10427,6 +10929,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -10469,7 +10972,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cloakinglab/build": { + "/v2/beeldeban/build": { parameters: { query?: never; header?: never; @@ -10478,6 +10981,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -10488,8 +10995,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -10541,7 +11051,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cloakinglab/upgrade": { + "/v2/beeldeban/upgrade": { parameters: { query?: never; header?: never; @@ -10550,6 +11060,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -10560,6 +11074,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -10611,7 +11126,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cloakinglab/downgrade": { + "/v2/beeldeban/downgrade": { parameters: { query?: never; header?: never; @@ -10620,6 +11135,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -10630,6 +11149,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -10673,7 +11193,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cloakinglab/demolish": { + "/v2/beeldeban/demolish": { parameters: { query?: never; header?: never; @@ -10682,6 +11202,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -10692,6 +11216,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -10734,7 +11259,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cloakinglab/repair": { + "/v2/beeldeban/repair": { parameters: { query?: never; header?: never; @@ -10743,6 +11268,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -10753,6 +11282,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -10796,7 +11326,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cloakinglab/get_stats_for_level": { + "/v2/beeldeban/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -10805,6 +11335,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -10815,7 +11349,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -10879,7 +11415,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cloakinglab/view": { + "/v2/beeldeban/view": { parameters: { query?: never; header?: never; @@ -10888,6 +11424,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -10898,6 +11438,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -10940,7 +11481,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/corn/build": { + "/v2/beeldebannest/build": { parameters: { query?: never; header?: never; @@ -10949,6 +11490,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -10959,8 +11504,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -11012,7 +11560,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/corn/upgrade": { + "/v2/beeldebannest/upgrade": { parameters: { query?: never; header?: never; @@ -11021,6 +11569,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -11031,6 +11583,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -11082,7 +11635,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/corn/downgrade": { + "/v2/beeldebannest/downgrade": { parameters: { query?: never; header?: never; @@ -11091,6 +11644,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -11101,6 +11658,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -11144,7 +11702,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/corn/demolish": { + "/v2/beeldebannest/demolish": { parameters: { query?: never; header?: never; @@ -11153,6 +11711,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -11163,6 +11725,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -11205,7 +11768,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/corn/repair": { + "/v2/beeldebannest/repair": { parameters: { query?: never; header?: never; @@ -11214,6 +11777,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -11224,6 +11791,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -11267,7 +11835,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/corn/get_stats_for_level": { + "/v2/beeldebannest/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -11276,6 +11844,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -11286,7 +11858,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -11350,7 +11924,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/corn/view": { + "/v2/beeldebannest/view": { parameters: { query?: never; header?: never; @@ -11359,6 +11933,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -11369,6 +11947,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -11411,7 +11990,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cornmeal/build": { + "/v2/blackholegenerator/build": { parameters: { query?: never; header?: never; @@ -11420,6 +11999,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -11430,8 +12013,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -11483,7 +12069,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cornmeal/upgrade": { + "/v2/blackholegenerator/upgrade": { parameters: { query?: never; header?: never; @@ -11492,6 +12078,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -11502,6 +12092,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -11553,7 +12144,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cornmeal/downgrade": { + "/v2/blackholegenerator/downgrade": { parameters: { query?: never; header?: never; @@ -11562,6 +12153,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -11572,6 +12167,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -11615,7 +12211,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cornmeal/demolish": { + "/v2/blackholegenerator/demolish": { parameters: { query?: never; header?: never; @@ -11624,6 +12220,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -11634,6 +12234,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -11676,7 +12277,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cornmeal/repair": { + "/v2/blackholegenerator/repair": { parameters: { query?: never; header?: never; @@ -11685,6 +12286,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -11695,6 +12300,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -11738,7 +12344,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cornmeal/get_stats_for_level": { + "/v2/blackholegenerator/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -11747,6 +12353,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -11757,7 +12367,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -11821,7 +12433,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/cornmeal/view": { + "/v2/blackholegenerator/view": { parameters: { query?: never; header?: never; @@ -11830,6 +12442,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -11840,6 +12456,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -11861,6 +12478,27 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + /** @description Tasks the generator can currently attempt (range is not factored in). */ + tasks?: { + /** @enum {string} */ + name: "Make Asteroid" | "Make Planet" | "Increase Size" | "Change Type" | "Swap Places" | "Jump Zone" | "Move System"; + base_fail?: number; + min_level?: number; + /** @enum {integer} */ + occupied?: 0 | 1; + /** @description Cooldown, in seconds, before the task can be used again. */ + recovery?: number; + side_chance?: number; + types?: string[]; + waste_cost?: number; + /** @description Present when the task cannot currently be used. */ + reason?: string; + }[]; + task_options?: { + asteroid_types?: number[]; + planet_types?: number[]; + zones?: string[]; + }; }; }; }; @@ -11882,7 +12520,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/crashedshipsite/build": { + "/v2/blackholegenerator/generate_singularity": { parameters: { query?: never; header?: never; @@ -11891,6 +12529,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Attempt a Black Hole Generator task. + * @description Attempts a Black Hole Generator task against the target body, star, or zone. Returns the success, failure, and side-effect results; not every field is populated for every outcome. Failure rates increase with range, and side effects occur more often the harder the task. Throws 1002, 1009, 1010, and 1013. + */ post: { parameters: { query?: never; @@ -11901,14 +12543,43 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; + /** @description Identifies the target body, star, or zone for the task. Provide one addressing scheme. */ + target: { + /** @description Case insensitive; throws if it doesn't match a body. */ + body_name?: string; + body_id?: number; + x?: number; + y?: number; + /** @description Case insensitive; throws if it doesn't match a star. */ + star_name?: string; + star_id?: number; + /** @description Used with star_name/star_id to target a specific (possibly unoccupied) orbit around that star. */ + orbit?: number; + /** @description Zone name, e.g. '-1|4'. Only used for the Jump Zone task. */ + zone?: string; + }; + /** + * @description The task to perform. + * @enum {string} + */ + task_name: "Make Asteroid" | "Make Planet" | "Increase Size" | "Change Type" | "Swap Places" | "Jump Zone" | "Move System"; + /** @description Only used for the 'Change Type' task. */ + params?: { + /** @description One of the 40 basic planet type ids. */ + newtype?: number; + }; + /** + * @description Spend essentia to guarantee 'perfection' (100% success). Only supported via this named-argument form. + * @enum {integer} + */ + subsidize?: 0 | 1; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Attempts a Black Hole Generator task against the target body. Returns the success, failure, and side-effect results (not all fields are populated for every outcome). Throws 1002, 1009, 1010, 1013. */ 200: { headers: { [name: string]: unknown; @@ -11918,21 +12589,140 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; }; + /** @description Present when the task failed. */ + fail?: Record; + /** @description Present when a side effect occurred. */ + side?: Record; + /** @description Present when the task succeeded (or produced a side effect). */ + target?: { + class?: string; + id?: number; + name?: string; + old_class?: string; + old_size?: number; + message?: string; + size?: number; + /** @enum {string} */ + type?: "asteroid" | "gas giant" | "habitable planet" | "space station"; + /** @enum {integer} */ + variance?: -1 | 0 | 1; + /** @enum {string} */ + waste?: "Zero" | "Random" | "Filled"; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/blackholegenerator/get_actions_for": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Preview task odds and cost for a target. + * @description Returns the task list with the success percentage and essentia cost for the given target. The essentia cost makes a task perfect (100% success); the lower the odds, the higher the cost, with a minimum of 2. A zero chance of success cannot be bought up. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description Identifies the target body, star, or zone for the task. Provide one addressing scheme. */ + target: { + /** @description Case insensitive; throws if it doesn't match a body. */ + body_name?: string; + body_id?: number; + x?: number; + y?: number; + /** @description Case insensitive; throws if it doesn't match a star. */ + star_name?: string; + star_id?: number; + /** @description Used with star_name/star_id to target a specific (possibly unoccupied) orbit around that star. */ + orbit?: number; + /** @description Zone name, e.g. '-1|4'. Only used for the Jump Zone task. */ + zone?: string; + }; + }; + }; + }; + responses: { + /** @description Returns the task list with success percentage and Essentia cost for the given target. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; + building?: components["schemas"]["building"]; + tasks: { + /** @enum {string} */ + name: "Make Asteroid" | "Make Planet" | "Increase Size" | "Change Type" | "Swap Places" | "Jump Zone" | "Move System"; + base_fail?: number; + body_id?: number; + dist?: number; + min_level?: number; + /** @enum {integer} */ + occupied?: 0 | 1; + range?: number; + /** @description Present when the task cannot currently be used. */ + reason?: string; + recovery?: number; + side_chance?: number; + /** @description Percentage chance of success. */ + success?: number; + /** @description Essentia cost to make the task 'perfect' (100% success). Minimum is 2. */ + essentia_cost?: number; + /** @description RPC error code thrown if the task cannot be used. */ + throw?: number; + types?: string[]; + waste_cost?: number; + /** + * @description Present only when name is 'Change Type'. + * @enum {string} + */ + body_type?: "asteroid" | "habitable planet"; + }[]; }; }; }; @@ -11954,7 +12744,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/crashedshipsite/upgrade": { + "/v2/blackholegenerator/subsidize_cooldown": { parameters: { query?: never; header?: never; @@ -11963,6 +12753,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Subsidize the generator cooldown. + * @description Spends 2 essentia to cool the generator down immediately, then returns the building view. Throws 1011. + */ post: { parameters: { query?: never; @@ -11973,12 +12767,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Spends 2 essentia to cool down the generator immediately. Returns the building view. Throws 1011. */ 200: { headers: { [name: string]: unknown; @@ -11988,21 +12783,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -12024,7 +12810,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/crashedshipsite/downgrade": { + "/v2/body/get_status": { parameters: { query?: never; header?: never; @@ -12033,6 +12819,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get detailed status for a body. + * @description Returns detailed statistics about a body owned or sat for by the current empire. You should probably never call this directly — the same data comes back in the status block of every relevant request. + */ post: { parameters: { query?: never; @@ -12043,12 +12833,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the body you wish to retrieve. */ + body_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Returns information about the current state of this body. Must be owned or a sitter of the current empire. */ 200: { headers: { [name: string]: unknown; @@ -12058,13 +12849,9 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; + server?: components["schemas"]["server_status"]; + empire: components["schemas"]["empire_status"]; + body: components["schemas"]["body_status"]; }; }; }; @@ -12086,7 +12873,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/crashedshipsite/demolish": { + "/v2/body/get_body_status": { parameters: { query?: never; header?: never; @@ -12095,6 +12882,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get the public star-map status for a body. + * @description Returns the public star-map view of any body. This endpoint is not part of the original API documentation. + */ post: { parameters: { query?: never; @@ -12105,12 +12896,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the body you wish to retrieve. */ + body_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Usd in the Star Map. Returns public information about the given body. */ 200: { headers: { [name: string]: unknown; @@ -12120,12 +12912,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - status: { + body: components["schemas"]["body_status"]; + status?: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -12147,7 +12939,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/crashedshipsite/repair": { + "/v2/body/get_buildings": { parameters: { query?: never; header?: never; @@ -12156,6 +12948,10 @@ export interface paths { }; get?: never; put?: never; + /** + * List the buildings on a body. + * @description Retrieves the buildings on a body. The surface is an 11x11 tile grid running from -5 to 5 on both axes, with the Planetary Command Center always at 0,0; fill the remaining tiles with blank ground. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -12166,12 +12962,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the body you wish to retrieve the buildings on. */ + body_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Retrieves the buildings on a planet's 11x11 (-5 to 5) surface grid. The planetary command building is always at 0,0. */ 200: { headers: { [name: string]: unknown; @@ -12181,13 +12978,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + buildings: components["schemas"]["buildings_list"]; + body: { + surface_image: string; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -12209,7 +13008,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/crashedshipsite/get_stats_for_level": { + "/v2/body/get_buildings_resources": { parameters: { query?: never; header?: never; @@ -12218,6 +13017,10 @@ export interface paths { }; get?: never; put?: never; + /** + * List buildings on a body with each one's resource contribution. + * @description Like get_buildings, but every building entry additionally carries a `resources` object describing that building's hourly production/consumption and storage capacity for each resource, plus per-food-type and per-ore-type breakdowns. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -12228,13 +13031,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - level: number; + /** @description The id of the body you wish to retrieve the buildings on. */ + body_id: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Like get_buildings, but every building entry additionally carries a `resources` object: hourly production/consumption and storage capacity for food/ore/water/waste/energy plus happiness_hour, and per-food-type / per-ore-type production breakdowns (each omitted when the building produces none of that resource). */ 200: { headers: { [name: string]: unknown; @@ -12244,27 +13047,9 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; + buildings: components["schemas"]["buildings_resources_list"]; + body: { + surface_image: string; }; status: { server: components["schemas"]["server_status"]; @@ -12292,7 +13077,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/crashedshipsite/view": { + "/v2/body/repair_list": { parameters: { query?: never; header?: never; @@ -12301,6 +13086,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair a list of buildings. + * @description Repairs the given buildings, in the order their ids are supplied. Returns the same shape as get_buildings, but only for the repaired buildings. + */ post: { parameters: { query?: never; @@ -12311,12 +13100,15 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the body the buildings are on. */ + body_id: number; + /** @description The building ids to repair, in the order they should be repaired. */ + building_ids: number[]; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Repairs the given buildings, in the order provided. Returns the same shape as get_buildings, but only for the repaired buildings. */ 200: { headers: { [name: string]: unknown; @@ -12326,7 +13118,10 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + buildings: components["schemas"]["buildings_list"]; + body: { + surface_image: string; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -12353,7 +13148,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/crater/build": { + "/v2/body/rearrange_buildings": { parameters: { query?: never; header?: never; @@ -12362,6 +13157,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Move buildings to new coordinates. + * @description Rearranges buildings to the coordinates supplied in the arrangement array. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -12372,14 +13171,22 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the body you wish to arrange buildings on. */ body_id: number; - x: number; - y: number; + /** @description Every building being moved must be included. The Planetary Command/Station Command must end up at 0,0. */ + arrangement: { + /** @description The id of the building to move. */ + id: number; + /** @description The new x coordinate for the building. */ + x: number; + /** @description The new y coordinate for the building. */ + y: number; + }[]; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Rearranges buildings to the supplied coordinates. */ 200: { headers: { [name: string]: unknown; @@ -12389,21 +13196,20 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { + moved: { id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; + name: string; + x: number; + y: number; + }[]; + body: { + surface_image: string; }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -12425,7 +13231,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/crater/upgrade": { + "/v2/body/get_buildable": { parameters: { query?: never; header?: never; @@ -12434,6 +13240,10 @@ export interface paths { }; get?: never; put?: never; + /** + * List building types buildable on a tile. + * @description Lists every building type that can be built on the given tile and matches the given tag. If several plans apply, returns the one with the highest extra_build_level. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -12444,12 +13254,19 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the body you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface. Valid values are between -5 and 5 inclusive. */ + y: number; + /** @description A tag that limits which building types are returned. Required. Cannot be Now, Soon, or Later; all other tags are allowed. */ + tag: string; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Lists the building types buildable at a given spot for a given tag. If multiple plans apply, returns the one with the highest extra_build_level. */ 200: { headers: { [name: string]: unknown; @@ -12459,13 +13276,35 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; + max_items_in_build_queue: number; + build_queue: { + max: number; + current: number; + }; + /** @description Keyed by building type name. */ + buildable: { + [key: string]: { + url: string; + image: string; + build: { + /** @enum {integer} */ + can: 1 | 0; + /** @enum {integer} */ + no_plot_use: 1 | 0; + cost: components["schemas"]["building_cost"]; + extra_level?: number; + tags: string[]; + /** @description [code, message, data], same shape as an rpc_error. */ + reason: unknown[]; + }; + production: { + food_hour?: number; + energy_hour?: number; + ore_hour?: number; + water_hour?: number; + waste_hour?: number; + happiness_hour?: number; + }; }; }; status: { @@ -12473,7 +13312,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -12495,7 +13333,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/crater/downgrade": { + "/v2/body/get_buildable_locations": { parameters: { query?: never; header?: never; @@ -12504,6 +13342,10 @@ export interface paths { }; get?: never; put?: never; + /** + * List unoccupied buildable locations. + * @description Tells you where buildings can be placed on the body. The order of the returned list is not guaranteed. + */ post: { parameters: { query?: never; @@ -12514,12 +13356,15 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the body you wish to get the free locations of. */ + body_id: number; + /** @description Optional building footprint size. 9 = center tile (LCOT), 4 = northwest tile (SSLA); omitted/other values return locations for single-tile buildings. */ + size?: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Lists unoccupied buildable locations on the planet. Order is not guaranteed. */ 200: { headers: { [name: string]: unknown; @@ -12529,13 +13374,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + unoccupied: number[][]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -12557,7 +13401,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/crater/demolish": { + "/v2/body/rename": { parameters: { query?: never; header?: never; @@ -12566,6 +13410,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Rename a body. + * @description Renames a body owned by the empire attached to this session. Throws 1000, 1002, and 1010. + */ post: { parameters: { query?: never; @@ -12576,12 +13424,15 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the body you wish to rename. */ + body_id: number; + /** @description The new name for the body. */ + name: string; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Renames a body owned by the empire attached to this session. */ 200: { headers: { [name: string]: unknown; @@ -12590,14 +13441,8 @@ export interface paths { "application/json": { id?: number; jsonrpc?: string; - result?: { - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; - }; + /** @enum {integer} */ + result?: 1; }; }; }; @@ -12618,7 +13463,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/crater/repair": { + "/v2/body/abandon": { parameters: { query?: never; header?: never; @@ -12627,6 +13472,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Abandon a colony. + * @description Abandons a colony, destroying everything on the planet. You cannot abandon your home planet. + */ post: { parameters: { query?: never; @@ -12637,12 +13486,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The unique id of the colony you wish to abandon. You cannot abandon your home planet. */ + body_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Abandons a colony, destroying everything on the planet. The home planet cannot be abandoned. */ 200: { headers: { [name: string]: unknown; @@ -12652,13 +13502,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -12680,7 +13528,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/crater/get_stats_for_level": { + "/v2/body/view_laws": { parameters: { query?: never; header?: never; @@ -12689,6 +13537,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View the laws of a space station. + * @description Returns the laws enacted by this space station. Pass the id of the station itself, not its Parliament building, since anyone may view the laws in a jurisdiction. + */ post: { parameters: { query?: never; @@ -12699,13 +13551,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - level: number; + /** @description The id of the space station itself, not its Parliament building. */ + body_id: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Returns the laws enacted by this space station. */ 200: { headers: { [name: string]: unknown; @@ -12715,33 +13567,17 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + laws: { + id: number; + name: string; + description: string; + date_enacted: string; + }[]; }; }; }; @@ -12763,7 +13599,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/crater/view": { + "/v2/body/set_colony_notes": { parameters: { query?: never; header?: never; @@ -12772,6 +13608,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Set the notes for a colony. + * @description Sets the per-colony notes for an owned body (colony or station). + */ post: { parameters: { query?: never; @@ -12782,12 +13622,18 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The unique id of the body whose notes you want to update. */ + body_id: number; + /** @description A hash of options. Currently the only valid key is `notes`. */ + options: { + /** @description The notes to assign to the body. */ + notes: string; + }; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Sets the per-colony notes for an owned body (colony or station). */ 200: { headers: { [name: string]: unknown; @@ -12797,7 +13643,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -12824,7 +13669,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/culinaryinstitute/view": { + "/v2/bread/build": { parameters: { query?: never; header?: never; @@ -12833,6 +13678,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -12843,12 +13692,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Retrieves the properties of this module. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -12860,18 +13714,19 @@ export interface paths { result?: { building: { id: number; - name: string; - image: string; level: number; - x: number; - y: number; - efficiency: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -12893,79 +13748,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/dairy/build": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - body_id: number; - x: number; - y: number; - }; - }; - }; - responses: { - /** @description Adds this building to the planet's build queue. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/dairy/upgrade": { + "/v2/bread/upgrade": { parameters: { query?: never; header?: never; @@ -12974,6 +13757,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -12984,6 +13771,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -13035,7 +13823,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/dairy/downgrade": { + "/v2/bread/downgrade": { parameters: { query?: never; header?: never; @@ -13044,6 +13832,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -13054,6 +13846,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -13097,7 +13890,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/dairy/demolish": { + "/v2/bread/demolish": { parameters: { query?: never; header?: never; @@ -13106,6 +13899,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -13116,6 +13913,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -13158,7 +13956,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/dairy/repair": { + "/v2/bread/repair": { parameters: { query?: never; header?: never; @@ -13167,6 +13965,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -13177,6 +13979,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -13220,7 +14023,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/dairy/get_stats_for_level": { + "/v2/bread/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -13229,6 +14032,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -13239,7 +14046,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -13303,7 +14112,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/dairy/view": { + "/v2/bread/view": { parameters: { query?: never; header?: never; @@ -13312,6 +14121,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -13322,6 +14135,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -13364,7 +14178,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/denton/build": { + "/v2/burger/build": { parameters: { query?: never; header?: never; @@ -13373,6 +14187,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -13383,8 +14201,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -13436,7 +14257,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/denton/upgrade": { + "/v2/burger/upgrade": { parameters: { query?: never; header?: never; @@ -13445,6 +14266,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -13455,6 +14280,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -13506,7 +14332,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/denton/downgrade": { + "/v2/burger/downgrade": { parameters: { query?: never; header?: never; @@ -13515,6 +14341,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -13525,6 +14355,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -13568,7 +14399,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/denton/demolish": { + "/v2/burger/demolish": { parameters: { query?: never; header?: never; @@ -13577,6 +14408,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -13587,6 +14422,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -13629,7 +14465,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/denton/repair": { + "/v2/burger/repair": { parameters: { query?: never; header?: never; @@ -13638,6 +14474,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -13648,6 +14488,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -13691,7 +14532,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/denton/get_stats_for_level": { + "/v2/burger/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -13700,6 +14541,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -13710,7 +14555,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -13774,7 +14621,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/denton/view": { + "/v2/burger/view": { parameters: { query?: never; header?: never; @@ -13783,6 +14630,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -13793,6 +14644,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -13835,7 +14687,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/dentonbrambles/build": { + "/v2/capitol/build": { parameters: { query?: never; header?: never; @@ -13844,6 +14696,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -13854,8 +14710,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -13907,7 +14766,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/dentonbrambles/upgrade": { + "/v2/capitol/upgrade": { parameters: { query?: never; header?: never; @@ -13916,6 +14775,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -13926,6 +14789,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -13977,7 +14841,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/dentonbrambles/downgrade": { + "/v2/capitol/downgrade": { parameters: { query?: never; header?: never; @@ -13986,6 +14850,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -13996,6 +14864,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -14039,7 +14908,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/dentonbrambles/demolish": { + "/v2/capitol/demolish": { parameters: { query?: never; header?: never; @@ -14048,6 +14917,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -14058,6 +14931,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -14100,7 +14974,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/dentonbrambles/repair": { + "/v2/capitol/repair": { parameters: { query?: never; header?: never; @@ -14109,6 +14983,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -14119,6 +14997,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -14162,7 +15041,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/dentonbrambles/get_stats_for_level": { + "/v2/capitol/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -14171,6 +15050,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -14181,7 +15064,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -14245,7 +15130,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/dentonbrambles/view": { + "/v2/capitol/view": { parameters: { query?: never; header?: never; @@ -14254,6 +15139,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -14264,6 +15153,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -14285,6 +15175,8 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + /** @description The essentia cost to rename the empire via rename_empire. */ + rename_empire_cost?: number; }; }; }; @@ -14306,79 +15198,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/deployedbleeder/build": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - body_id: number; - x: number; - y: number; - }; - }; - }; - responses: { - /** @description Adds this building to the planet's build queue. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/deployedbleeder/upgrade": { + "/v2/capitol/rename_empire": { parameters: { query?: never; header?: never; @@ -14387,6 +15207,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Rename the empire. + * @description Spends essentia to rename your empire. + */ post: { parameters: { query?: never; @@ -14397,12 +15221,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The new name of your empire. */ + name: string; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Spends essentia to change the empire's name (cost given by view's rename_empire_cost). */ 200: { headers: { [name: string]: unknown; @@ -14412,21 +15239,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -14448,7 +15265,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/deployedbleeder/downgrade": { + "/v2/captcha/fetch": { parameters: { query?: never; header?: never; @@ -14457,6 +15274,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Fetch a captcha. + * @description Retrieves a captcha that is required in order to call the solve method. Display the resulting captcha and then call solve with the user's response. + */ post: { parameters: { query?: never; @@ -14464,15 +15285,9 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; + requestBody?: never; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Retrieves a captcha required to call solve. Display it, then call solve with the user's response. */ 200: { headers: { [name: string]: unknown; @@ -14482,13 +15297,8 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; + guid: string; + url: string; }; }; }; @@ -14510,7 +15320,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/deployedbleeder/demolish": { + "/v2/captcha/solve": { parameters: { query?: never; header?: never; @@ -14519,6 +15329,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Solve a captcha. + * @description Validates the user's solution against the known solution for the given guid. On success the captcha stays valid for thirty minutes and this returns 1. A captcha cannot be used more than once; on a mismatch it throws 1014, with fresh captcha data in the error data that must be used for the next attempt. + */ post: { parameters: { query?: never; @@ -14529,12 +15343,15 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description Must match the guid field returned by the fetch method. */ + guid: string; + /** @description The text typed in by the user as the solution of the captcha. */ + solution: string; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Validates the solution against the given guid. On success the captcha remains valid for thirty minutes and this returns 1. Captchas are single-use; throws 1014 on mismatch, with new captcha data in the error data that must be used for the next attempt. */ 200: { headers: { [name: string]: unknown; @@ -14543,14 +15360,8 @@ export interface paths { "application/json": { id?: number; jsonrpc?: string; - result?: { - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; - }; + /** @enum {integer} */ + result?: 1; }; }; }; @@ -14571,7 +15382,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/deployedbleeder/repair": { + "/v2/cheese/build": { parameters: { query?: never; header?: never; @@ -14580,6 +15391,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -14590,12 +15405,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -14605,7 +15425,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -14633,7 +15461,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/deployedbleeder/get_stats_for_level": { + "/v2/cheese/upgrade": { parameters: { query?: never; header?: never; @@ -14642,6 +15470,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -14652,13 +15484,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -14670,24 +15502,11 @@ export interface paths { result?: { building: { id: number; - name: string; - image: string; level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; }; status: { @@ -14695,6 +15514,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -14716,7 +15536,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/deployedbleeder/view": { + "/v2/cheese/downgrade": { parameters: { query?: never; header?: never; @@ -14725,6 +15545,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -14735,12 +15559,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -14756,6 +15581,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -14777,7 +15603,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/development/build": { + "/v2/cheese/demolish": { parameters: { query?: never; header?: never; @@ -14786,6 +15612,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -14796,14 +15626,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -14813,15 +15642,73 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/cheese/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -14849,7 +15736,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/development/upgrade": { + "/v2/cheese/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -14858,6 +15745,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -14868,12 +15759,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -14885,11 +15779,24 @@ export interface paths { result?: { building: { id: number; + name: string; + image: string; level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; }; }; status: { @@ -14897,7 +15804,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -14919,7 +15825,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/development/downgrade": { + "/v2/cheese/view": { parameters: { query?: never; header?: never; @@ -14928,6 +15834,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -14938,12 +15848,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -14959,6 +15870,84 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/chip/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; buildings: components["schemas"]["buildings_list"]; }; }; @@ -14981,7 +15970,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/development/demolish": { + "/v2/chip/upgrade": { parameters: { query?: never; header?: never; @@ -14990,6 +15979,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -15000,12 +15993,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -15015,6 +16009,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -15042,7 +16045,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/development/repair": { + "/v2/chip/downgrade": { parameters: { query?: never; header?: never; @@ -15051,6 +16054,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -15061,12 +16068,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -15104,7 +16112,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/development/get_stats_for_level": { + "/v2/chip/demolish": { parameters: { query?: never; header?: never; @@ -15113,6 +16121,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -15123,13 +16135,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -15139,33 +16151,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -15187,7 +16178,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/development/view": { + "/v2/chip/repair": { parameters: { query?: never; header?: never; @@ -15196,6 +16187,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -15206,12 +16201,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -15227,18 +16223,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - build_queue: { - building_id: number; - name: string; - to_level: number; - seconds_remaining: number; - x: number; - y: number; - /** @description The essentia cost to subsidize just this building. */ - subsidy_cost: number; - }[]; - /** @description The essentia cost to subsidize the whole build queue. */ - subsidy_cost: number; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -15260,7 +16245,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/development/subsidize_build_queue": { + "/v2/chip/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -15269,6 +16254,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -15279,12 +16268,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Instantly finishes all buildings in the build queue. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -15294,12 +16286,33 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - essentia_spent: number; }; }; }; @@ -15321,7 +16334,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/development/subsidize_one_build": { + "/v2/chip/view": { parameters: { query?: never; header?: never; @@ -15330,6 +16343,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -15340,14 +16357,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; - /** @description The ID of the building scheduled to be built/upgraded that you wish to subsidize. */ - scheduled_id: number; }; }; }; responses: { - /** @description Subsidizes the immediate build of one job on the build queue. Later jobs (if any) are brought forward by the (remaining) time of the subsidized build. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -15357,12 +16373,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - essentia_spent: number; }; }; }; @@ -15384,7 +16400,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/development/cancel_build": { + "/v2/cider/build": { parameters: { query?: never; header?: never; @@ -15393,6 +16409,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -15403,16 +16423,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - /** @description The ID, or array of IDs, of the building(s) scheduled to be built/upgraded that you wish to cancel. One of scheduled_id or cancel_all is required. */ - scheduled_id?: number | number[]; - /** @description If true, cancels all builds currently scheduled. */ - cancel_all?: boolean; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Cancels a build. All following builds in the build queue are brought forward. Resources or plans used when the build/upgrade was requested are not returned. Returns the same as the view method. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -15422,24 +16443,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - build_queue: { - building_id: number; - name: string; - to_level: number; - seconds_remaining: number; - x: number; - y: number; - /** @description The essentia cost to subsidize just this building. */ - subsidy_cost: number; - }[]; - /** @description The essentia cost to subsidize the whole build queue. */ - subsidy_cost: number; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -15461,7 +16479,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/distributioncenter/build": { + "/v2/cider/upgrade": { parameters: { query?: never; header?: never; @@ -15470,6 +16488,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -15480,14 +16502,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -15533,7 +16554,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/distributioncenter/upgrade": { + "/v2/cider/downgrade": { parameters: { query?: never; header?: never; @@ -15542,6 +16563,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -15552,12 +16577,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -15567,15 +16593,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -15603,7 +16621,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/distributioncenter/downgrade": { + "/v2/cider/demolish": { parameters: { query?: never; header?: never; @@ -15612,6 +16630,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -15622,12 +16644,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -15637,7 +16660,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -15665,7 +16687,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/distributioncenter/demolish": { + "/v2/cider/repair": { parameters: { query?: never; header?: never; @@ -15674,6 +16696,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -15684,12 +16710,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -15699,6 +16726,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -15726,7 +16754,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/distributioncenter/repair": { + "/v2/cider/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -15735,6 +16763,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -15745,12 +16777,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -15760,13 +16795,33 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -15788,7 +16843,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/distributioncenter/get_stats_for_level": { + "/v2/cider/view": { parameters: { query?: never; header?: never; @@ -15797,6 +16852,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -15807,13 +16866,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -15823,28 +16882,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -15871,7 +16909,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/distributioncenter/view": { + "/v2/citadelofknope/build": { parameters: { query?: never; header?: never; @@ -15880,6 +16918,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -15890,12 +16932,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -15905,27 +16952,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - reserve: { - /** @enum {integer} */ - can: 1 | 0; - /** @description Time until reserved resources will automatically be released. */ - seconds_remaining: number; - /** @description Max length resources can be kept in reserve. */ - max_reserve_duration: number; - /** @description Max amount of resources that can be reserved. */ - max_reserve_size: number; - /** @description Resources currently in reserve. */ - resources: { - type: string; - quantity: number; - }[]; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -15947,7 +16988,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/distributioncenter/reserve": { + "/v2/citadelofknope/upgrade": { parameters: { query?: never; header?: never; @@ -15956,6 +16997,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -15966,17 +17011,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - /** @description Resources to reserve so they don't get automatically spent. */ - resources: { - type: string; - quantity: number; - }[]; }; }; }; responses: { - /** @description Reserves resources so they are held until the timer expires or manually released. Returns the building view. Throws 1009, 1010, and 1011. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -15986,27 +17027,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - reserve: { - /** @enum {integer} */ - can: 1 | 0; - /** @description Time until reserved resources will automatically be released. */ - seconds_remaining: number; - /** @description Max length resources can be kept in reserve. */ - max_reserve_duration: number; - /** @description Max amount of resources that can be reserved. */ - max_reserve_size: number; - /** @description Resources currently in reserve. */ - resources: { - type: string; - quantity: number; - }[]; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -16028,7 +17063,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/distributioncenter/release_reserve": { + "/v2/citadelofknope/downgrade": { parameters: { query?: never; header?: never; @@ -16037,6 +17072,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -16047,12 +17086,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Returns the resources held in reserve back to the planet. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -16062,11 +17102,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -16088,7 +17130,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/distributioncenter/get_stored_resources": { + "/v2/citadelofknope/demolish": { parameters: { query?: never; header?: never; @@ -16097,6 +17139,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -16107,12 +17153,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Returns a list of the resources you have stored, to make it easier to identify what you want to store. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -16127,11 +17174,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - cargo_space_used_each: number; - /** @description Keyed by resource type. */ - resources: { - [key: string]: number; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -16153,7 +17196,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/build": { + "/v2/citadelofknope/repair": { parameters: { query?: never; header?: never; @@ -16162,6 +17205,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -16172,14 +17219,82 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/citadelofknope/get_stats_for_level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; + responses: { + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -16191,11 +17306,24 @@ export interface paths { result?: { building: { id: number; + name: string; + image: string; level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; }; }; status: { @@ -16203,7 +17331,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -16225,7 +17352,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/upgrade": { + "/v2/citadelofknope/view": { parameters: { query?: never; header?: never; @@ -16234,6 +17361,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -16244,12 +17375,83 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/cloakinglab/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -16295,7 +17497,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/downgrade": { + "/v2/cloakinglab/upgrade": { parameters: { query?: never; header?: never; @@ -16304,6 +17506,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -16314,12 +17520,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -16329,7 +17536,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -16357,7 +17572,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/demolish": { + "/v2/cloakinglab/downgrade": { parameters: { query?: never; header?: never; @@ -16366,6 +17581,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -16376,12 +17595,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -16391,6 +17611,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -16418,7 +17639,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/repair": { + "/v2/cloakinglab/demolish": { parameters: { query?: never; header?: never; @@ -16427,6 +17648,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -16437,12 +17662,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -16452,7 +17678,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -16480,7 +17705,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/get_stats_for_level": { + "/v2/cloakinglab/repair": { parameters: { query?: never; header?: never; @@ -16489,6 +17714,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -16499,13 +17728,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -16515,33 +17744,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -16563,7 +17772,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/view": { + "/v2/cloakinglab/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -16572,6 +17781,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -16582,12 +17795,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -16597,26 +17813,33 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - /** @description Present only when this empire is in an alliance. */ - alliance_status?: { - id?: number; - name?: string; - members?: { - empire_id?: number; - name?: string; - }[]; - leader_id?: number; - forum_uri?: string; - description?: string; - announcements?: string; - date_created?: string; - }; }; }; }; @@ -16638,7 +17861,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/create_alliance": { + "/v2/cloakinglab/view": { parameters: { query?: never; header?: never; @@ -16647,6 +17870,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -16657,13 +17884,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; - name: string; }; }; }; responses: { - /** @description Creates a new alliance with this empire as leader. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -16673,6 +17900,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -16699,7 +17927,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/get_alliance_status": { + "/v2/corn/build": { parameters: { query?: never; header?: never; @@ -16708,6 +17936,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -16718,12 +17950,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Returns this empire's alliance data. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -16733,22 +17970,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - id?: number; - name?: string; - members?: { - empire_id?: number; - name?: string; - }[]; - leader_id?: number; - forum_uri?: string; - description?: string; - announcements?: string; - date_created?: string; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -16770,7 +18006,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/dissolve_alliance": { + "/v2/corn/upgrade": { parameters: { query?: never; header?: never; @@ -16779,6 +18015,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -16789,12 +18029,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Leader-only. Disbands the alliance and converts its space stations to asteroids. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -16804,11 +18045,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -16830,7 +18081,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/update_alliance": { + "/v2/corn/downgrade": { parameters: { query?: never; header?: never; @@ -16839,6 +18090,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -16849,17 +18104,80 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - params: { - forum_uri?: string; - description?: string; - announcements?: string; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; }; }; }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/corn/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; }; responses: { - /** @description Leader-only. Updates alliance metadata. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -16874,6 +18192,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -16895,7 +18214,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/send_invite": { + "/v2/corn/repair": { parameters: { query?: never; header?: never; @@ -16904,6 +18223,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -16914,14 +18237,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - message?: string; - invitee_id: number; }; }; }; responses: { - /** @description Leader-only. Invites an empire to join the alliance. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -16931,11 +18253,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -16957,7 +18281,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/withdraw_invite": { + "/v2/corn/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -16966,6 +18290,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -16976,14 +18304,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; - message?: string; - invite_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Leader-only. Withdraws a pending invite. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -16993,6 +18322,28 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -17019,7 +18370,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/get_pending_invites": { + "/v2/corn/view": { parameters: { query?: never; header?: never; @@ -17028,6 +18379,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -17038,12 +18393,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; }; responses: { - /** @description Leader-only. Lists outstanding invites sent by the alliance. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -17053,11 +18409,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - invites: { - id?: number; - name?: string; - empire_id?: number; - }[]; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -17084,7 +18436,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/accept_invite": { + "/v2/cornmeal/build": { parameters: { query?: never; header?: never; @@ -17093,6 +18445,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -17103,14 +18459,92 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/cornmeal/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ building_id: number; - message?: string; - invite_id: number; }; }; }; responses: { - /** @description Accepts an invite to join an alliance. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -17120,11 +18554,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -17146,7 +18590,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/reject_invite": { + "/v2/cornmeal/downgrade": { parameters: { query?: never; header?: never; @@ -17155,6 +18599,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -17165,14 +18613,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - message?: string; - invite_id: number; }; }; }; responses: { - /** @description Declines an invite to join an alliance. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -17182,11 +18629,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -17208,7 +18657,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/get_my_invites": { + "/v2/cornmeal/demolish": { parameters: { query?: never; header?: never; @@ -17217,6 +18666,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -17227,12 +18680,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Lists invites this empire has received. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -17242,16 +18696,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - invites: { - id?: number; - name?: string; - alliance_id?: number; - }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -17273,7 +18723,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/leave_alliance": { + "/v2/cornmeal/repair": { parameters: { query?: never; header?: never; @@ -17282,6 +18732,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -17292,13 +18746,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - message?: string; }; }; }; responses: { - /** @description Leaves the current alliance. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -17308,11 +18762,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -17334,7 +18790,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/expel_member": { + "/v2/cornmeal/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -17343,6 +18799,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -17353,14 +18813,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; - message?: string; - empire_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Leader-only. Removes a member from the alliance. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -17370,6 +18831,28 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -17396,7 +18879,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/assign_alliance_leader": { + "/v2/cornmeal/view": { parameters: { query?: never; header?: never; @@ -17405,6 +18888,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -17415,13 +18902,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; - new_leader_id: number; }; }; }; responses: { - /** @description Leader-only. Transfers alliance leadership to another current member. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -17431,6 +18918,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -17457,7 +18945,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/view_stash": { + "/v2/crashedshipsite/build": { parameters: { query?: never; header?: never; @@ -17466,6 +18954,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -17476,12 +18968,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Returns the alliance stash's contents. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -17491,21 +18988,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - /** @description The alliance stash's contents, keyed by resource name. */ - stash: { - [key: string]: number; - }; - /** @description The calling planet's own storable resources, keyed by resource name. */ - stored: { - [key: string]: number; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; }; - max_exchange_size: number; - exchanges_remaining_today: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -17527,7 +19024,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/donate_to_stash": { + "/v2/crashedshipsite/upgrade": { parameters: { query?: never; header?: never; @@ -17536,6 +19033,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -17546,16 +19047,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - /** @description Resource name to quantity, e.g. {"water": 4500, "bread": 5000}. Waste is not allowed. */ - donation: { - [key: string]: number; - }; }; }; }; responses: { - /** @description Donates resources to the alliance stash. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -17565,11 +19063,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -17591,7 +19099,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/exchange_with_stash": { + "/v2/crashedshipsite/downgrade": { parameters: { query?: never; header?: never; @@ -17600,6 +19108,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -17610,19 +19122,80 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - /** @description Must equal request in total value. Waste is not allowed. */ - donation: { - [key: string]: number; - }; - request: { - [key: string]: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; }; }; }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/crashedshipsite/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; }; responses: { - /** @description Exchanges resources with the alliance stash. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -17637,6 +19210,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -17658,7 +19232,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/view_propositions": { + "/v2/crashedshipsite/repair": { parameters: { query?: never; header?: never; @@ -17667,6 +19241,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -17677,12 +19255,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Lists pending propositions the alliance is voting on. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -17692,30 +19271,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - propositions: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }[]; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -17737,7 +19299,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/embassy/cast_vote": { + "/v2/crashedshipsite/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -17746,6 +19308,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -17756,15 +19322,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; - proposition_id: number; - /** @enum {integer} */ - vote: 1 | 0; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Casts a vote on a proposition. Throws 1018 if already voted. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -17774,6 +19340,28 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -17800,7 +19388,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/is_name_available": { + "/v2/crashedshipsite/view": { parameters: { query?: never; header?: never; @@ -17809,6 +19397,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -17819,13 +19411,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description The name of the empire to search for. */ - name: string; + /** @description The id of the building you wish to retrieve. */ + building_id: number; }; }; }; responses: { - /** @description Returns a 1 if the name is available, or throws an exception if it is not. Throws 1000. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -17834,8 +19426,14 @@ export interface paths { "application/json": { id?: number; jsonrpc?: string; - /** @enum {integer} */ - result?: 1 | 0; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; }; }; }; @@ -17856,7 +19454,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/logout": { + "/v2/crater/build": { parameters: { query?: never; header?: never; @@ -17865,6 +19463,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -17872,9 +19474,20 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; responses: { - /** @description Ends a session. Returns 1. Throws 1006. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -17883,8 +19496,23 @@ export interface paths { "application/json": { id?: number; jsonrpc?: string; - /** @enum {integer} */ - result?: 1; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; }; }; }; @@ -17905,7 +19533,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/login": { + "/v2/crater/upgrade": { parameters: { query?: never; header?: never; @@ -17914,6 +19542,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -17924,22 +19556,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description The name of the empire. */ - empire_name: string; - /** - * Format: password - * @description The password to authenticate to the empire. - */ - password: string; - /** @description Your client's unique API key, identifying it from all other clients. See ApiKeys for details. */ - api_key: string; - /** @description Optional client identifier recorded against the session. Not part of the original API documentation. */ - browser?: string; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Confirms the password matches the empire and returns a session id alongside the empire and server status. A session survives up to 2 hours of inactivity, so there is no need to log in again while an existing session is still valid. Throws 1004 and 1005. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -17949,12 +19572,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - session_id: string; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -17976,7 +19608,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/fetch_captcha": { + "/v2/crater/downgrade": { parameters: { query?: never; header?: never; @@ -17985,6 +19617,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -17992,9 +19628,16 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; responses: { - /** @description Retrieves a captcha that is required in order to call the create method. Display the resulting captcha in your creation form and then call create with the user's response. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -18004,8 +19647,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - guid: string; - url: string; + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -18027,7 +19675,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/create": { + "/v2/crater/demolish": { parameters: { query?: never; header?: never; @@ -18036,6 +19684,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -18046,29 +19698,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description The name of the empire to create. */ - name: string; - /** @description The password to log in to the empire. Must be between 6 and 30 characters. Required unless you have a valid facebook_uid and facebook_token, and still recommended even when authenticating through Facebook. */ - password?: string; - /** @description Retyping the password again. This must match password to succeed. Required whenever password is supplied. */ - password1?: string; - /** @description Must match the guid field returned by the fetch_captcha method. */ - captcha_guid: string; - /** @description The text typed in by the user as the solution of the captcha. */ - captcha_solution: string; - /** @description The user's email address. Not required, but used for system vital functions like password recovery. */ - email?: string; - /** @description A Facebook user id passed in through Lacuna's Facebook integration system. Optional, but required alongside facebook_token. */ - facebook_uid?: string; - /** @description A Facebook access token passed in through Lacuna's Facebook integration system. Optional, but required alongside facebook_uid. */ - facebook_token?: string; - /** @description A 36 character code that was sent to the user by a friend. Usable only once, it ensures that their friend gets a home planet in relatively close proximity to their own. */ - invite_code?: string; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Creates a new empire and returns its empire_id. The empire is not playable yet — either call update_species and then found, or skip the species step and call found directly. Throws 1000, 1001, 1002, and 1014. On a 1014 the error data carries fresh captcha information that must be used for the next attempt, since a captcha cannot be used more than once. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -18077,8 +19713,14 @@ export interface paths { "application/json": { id?: number; jsonrpc?: string; - /** @description The new empire id. */ - result?: number; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; }; }; }; @@ -18099,7 +19741,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/found": { + "/v2/crater/repair": { parameters: { query?: never; header?: never; @@ -18108,6 +19750,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -18118,17 +19764,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description The empire to found. */ - empire_id: number; - /** @description Your client's unique API key, identifying it from all other clients. See ApiKeys for details. */ - api_key: string; - /** @description Deprecated here. Pass invite_code to the create method instead. */ - invite_code?: string; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Sets up an empire on its new home world. Once this method is called, the species can no longer be modified. The returned welcome_message_id identifies an inbox message that starts the tutorial, so the user can be prompted to read it right away. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -18138,13 +19780,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - session_id: string; - welcome_message_id: number; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -18166,7 +19808,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/get_invite_friend_url": { + "/v2/crater/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -18175,6 +19817,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -18182,9 +19828,18 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; responses: { - /** @description Returns a URL that can be pasted into a blog, forum, or whatever to invite friends. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -18194,7 +19849,28 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - referral_url: string; + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -18221,7 +19897,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/invite_friend": { + "/v2/crater/view": { parameters: { query?: never; header?: never; @@ -18230,6 +19906,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -18240,15 +19920,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description The email address of your friend, or a comma separated string of email addresses. */ - email: string; - /** @description An optional message the user can type to invite their friend. Defaults to "I'm having a great time with this new game called Lacuna Expanse. Come play with me." The empire name, friend code, and server URI are appended to whatever is sent. */ - custom_message?: string; + /** @description The id of the building you wish to retrieve. */ + building_id: number; }; }; }; responses: { - /** @description Sends an invitation code to a friend so that they can start in the same zone as your empire. Each not_sent entry pairs the address with the [code, message] reason it could not be invited. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -18258,11 +19936,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - sent?: string[]; - not_sent?: { - address: string; - reason: unknown[]; - }[]; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -18289,7 +19963,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/get_status": { + "/v2/culinaryinstitute/view": { parameters: { query?: never; header?: never; @@ -18298,6 +19972,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this module's properties. + * @description Retrieves the properties of this module. + */ post: { parameters: { query?: never; @@ -18305,9 +19983,16 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; responses: { - /** @description Returns information about the current state of the empire. You should probably never call this directly — it is a wasted call, since the same data comes back in the status block of every relevant request. Throws 1002. */ + /** @description Retrieves the properties of this module. */ 200: { headers: { [name: string]: unknown; @@ -18317,8 +20002,20 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - server: components["schemas"]["server_status"]; - empire: components["schemas"]["empire_status"]; + building: { + id: number; + name: string; + image: string; + level: number; + x: number; + y: number; + efficiency: number; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; }; }; }; @@ -18340,7 +20037,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/view_profile": { + "/v2/dairy/build": { parameters: { query?: never; header?: never; @@ -18349,6 +20046,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -18356,9 +20057,20 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; responses: { - /** @description Provides a list of the editable properties of the current empire's profile. See also the edit_profile and view_public_profile methods. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -18368,59 +20080,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - profile: { - description: string; - status_message: string; - /** @description Keyed by medal id. */ - medals: { - [key: string]: { - name: string; - image: string; - date: string; - /** @enum {integer} */ - public: 1 | 0; - times_earned: number; - }; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; - city: string; - country: string; - notes: string; - skype: string; - player_name: string; - /** @enum {integer} */ - skip_happiness_warnings: 1 | 0; - /** @enum {integer} */ - skip_resource_warnings: 1 | 0; - /** @enum {integer} */ - skip_pollution_warnings: 1 | 0; - /** @enum {integer} */ - skip_medal_messages: 1 | 0; - /** @enum {integer} */ - skip_facebook_wall_posts: 1 | 0; - /** @enum {integer} */ - skip_found_nothing: 1 | 0; - /** @enum {integer} */ - skip_excavator_resources: 1 | 0; - /** @enum {integer} */ - skip_excavator_glyph: 1 | 0; - /** @enum {integer} */ - skip_excavator_plan: 1 | 0; - /** @enum {integer} */ - skip_spy_recovery: 1 | 0; - /** @enum {integer} */ - skip_probe_detected: 1 | 0; - /** @enum {integer} */ - skip_attack_messages: 1 | 0; - /** @enum {integer} */ - skip_incoming_ships: 1 | 0; - email: string; - sitter_password: string; }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -18442,7 +20116,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/edit_profile": { + "/v2/dairy/upgrade": { parameters: { query?: never; header?: never; @@ -18451,6 +20125,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -18461,99 +20139,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description The properties to be edited. Set one or all of them — only those set will be updated. */ - profile: { - /** @description A description of the empire. Limited to 1024 characters and cannot contain < or >. */ - description?: string; - /** @description A message to indicate what you're doing, how you're feeling, or other status indicator. Limited to 100 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ - status_message?: string; - /** @description The ids of the medals the user wishes to display in the public profile. */ - public_medals?: number[]; - /** @description The city in which the player resides. Limited to 100 characters and cannot contain @, &, <, >, or ;. */ - city?: string; - /** @description The country in which the player resides. Limited to 100 characters and cannot contain @, &, <, >, or ;. */ - country?: string; - /** @description A text blob where the user can write down whatever they want to store in their account. Limited to 1024 characters and cannot contain @, &, <, >, or ;. */ - notes?: string; - /** @description The username this player uses on Skype. Limited to 100 characters and cannot contain @, &, <, >, or ;. */ - skype?: string; - /** @description The real name or online identity of this player. Limited to 100 characters and cannot contain @, &, <, >, or ;. */ - player_name?: string; - /** - * @description Defaults to 0. Set to 1 to stop receiving messages about unhappy citizens. WARNING: these messages are there for your own protection — turn them off at your own risk. - * @enum {integer} - */ - skip_happiness_warnings?: 1 | 0; - /** - * @description Defaults to 0. Set to 1 to stop receiving messages about a lack of resources to keep buildings running. WARNING: these messages are there for your own protection — turn them off at your own risk. - * @enum {integer} - */ - skip_resource_warnings?: 1 | 0; - /** - * @description Defaults to 0. Set to 1 to stop receiving messages about excess waste causing pollution. WARNING: these messages are there for your own protection — turn them off at your own risk. - * @enum {integer} - */ - skip_pollution_warnings?: 1 | 0; - /** - * @description Defaults to 0. Set to 1 to stop receiving messages about the medals they've earned. - * @enum {integer} - */ - skip_medal_messages?: 1 | 0; - /** - * @description Defaults to 0. Set to 1 to stop messages being posted to their Facebook wall. - * @enum {integer} - */ - skip_facebook_wall_posts?: 1 | 0; - /** - * @description Defaults to 0. Set to 1 to stop receiving messages when excavators find nothing. - * @enum {integer} - */ - skip_found_nothing?: 1 | 0; - /** - * @description Defaults to 0. Set to 1 to stop receiving messages when excavators find resources. - * @enum {integer} - */ - skip_excavator_resources?: 1 | 0; - /** - * @description Defaults to 0. Set to 1 to stop receiving messages when excavators find glyphs. - * @enum {integer} - */ - skip_excavator_glyph?: 1 | 0; - /** - * @description Defaults to 0. Set to 1 to stop receiving messages when excavators find plans. - * @enum {integer} - */ - skip_excavator_plan?: 1 | 0; - /** - * @description Defaults to 0. Set to 1 to stop receiving spy recovery messages ("I'm ready to work. What do you need from me?"). - * @enum {integer} - */ - skip_spy_recovery?: 1 | 0; - /** - * @description Defaults to 0. Set to 1 to stop receiving messages when a probe is detected. - * @enum {integer} - */ - skip_probe_detected?: 1 | 0; - /** - * @description Defaults to 0. Set to 1 to stop receiving messages about attacks. - * @enum {integer} - */ - skip_attack_messages?: 1 | 0; - /** - * @description Controls the display of incoming ships (own, allied, foreign) on the map display. Defaults to 0, which shows them. Set to 1 to hide them, which can improve browser responsiveness. - * @enum {integer} - */ - skip_incoming_ships?: 1 | 0; - /** @description An email address that can be used for system functions like password recovery. Must either resemble an email address or be empty. */ - email?: string; - /** @description A password that can be safely given to account sitters and alliance members. Must be between 6 and 30 characters. */ - sitter_password?: string; - }; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Edits properties of an empire. Returns the same payload as view_profile. Only the properties present in the request are updated. See also the view_profile and view_public_profile methods. Throws 1005 and 1009. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -18563,59 +20155,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - profile: { - description: string; - status_message: string; - /** @description Keyed by medal id. */ - medals: { - [key: string]: { - name: string; - image: string; - date: string; - /** @enum {integer} */ - public: 1 | 0; - times_earned: number; - }; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; - city: string; - country: string; - notes: string; - skype: string; - player_name: string; - /** @enum {integer} */ - skip_happiness_warnings: 1 | 0; - /** @enum {integer} */ - skip_resource_warnings: 1 | 0; - /** @enum {integer} */ - skip_pollution_warnings: 1 | 0; - /** @enum {integer} */ - skip_medal_messages: 1 | 0; - /** @enum {integer} */ - skip_facebook_wall_posts: 1 | 0; - /** @enum {integer} */ - skip_found_nothing: 1 | 0; - /** @enum {integer} */ - skip_excavator_resources: 1 | 0; - /** @enum {integer} */ - skip_excavator_glyph: 1 | 0; - /** @enum {integer} */ - skip_excavator_plan: 1 | 0; - /** @enum {integer} */ - skip_spy_recovery: 1 | 0; - /** @enum {integer} */ - skip_probe_detected: 1 | 0; - /** @enum {integer} */ - skip_attack_messages: 1 | 0; - /** @enum {integer} */ - skip_incoming_ships: 1 | 0; - email: string; - sitter_password: string; }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -18637,7 +20191,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/view_public_profile": { + "/v2/dairy/downgrade": { parameters: { query?: never; header?: never; @@ -18646,6 +20200,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -18656,13 +20214,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description The id of the empire for which you'd like to retrieve the public profile. */ - empire_id: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Provides a list of the data that's publicly known about this empire. Throws 1002. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -18672,80 +20230,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - profile: { - city: string; - description: string; - /** @description Keyed by medal id. */ - medals: { - [key: string]: { - name: string; - image: string; - date: string; - /** @enum {integer} */ - public: 1 | 0; - times_earned: number; - }; - }; - player_name: string; - id: number; - skype: string; - name: string; - species: string; - country: string; - date_founded: string; - known_colonies: { - type: string; - id: number; - star_name: string; - ore?: { - methane: number; - fluorite: number; - beryl: number; - goethite: number; - gold: number; - chalcopyrite: number; - anthracite: number; - bauxite: number; - galena: number; - monazite: number; - trona: number; - halite: number; - uraninite: number; - zircon: number; - chromite: number; - kerogen: number; - rutile: number; - magnetite: number; - sulfur: number; - gypsum: number; - }; - homeworld: number; - x: number; - size: number; - star_id: number; - name: string; - empire?: { - name: string; - is_isolationist: number; - id: number; - alignment: string; - }; - orbit: number; - zone: string; - y: number; - image: string; - notes: string; - water: number; - }[]; - status_message: string; - last_login: string; - colony_count: number; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -18767,7 +20258,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/send_password_reset_message": { + "/v2/dairy/demolish": { parameters: { query?: never; header?: never; @@ -18776,6 +20267,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -18786,17 +20281,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description The unique id of the empire to recover. Choose one of empire_id, empire_name, or email. */ - empire_id?: number; - /** @description The full name of the empire. Choose one of empire_id, empire_name, or email. */ - empire_name?: string; - /** @description The email address associated with an empire. Choose one of empire_id, empire_name, or email. */ - email?: string; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Starts a password recovery process by sending an email with a recovery key. Identify the empire by exactly one of empire_id, empire_name, or email. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -18806,8 +20297,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - /** @enum {integer} */ - sent: 1; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -18829,7 +20324,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/reset_password": { + "/v2/dairy/repair": { parameters: { query?: never; header?: never; @@ -18838,6 +20333,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -18848,19 +20347,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description A key that was emailed to the user via the send_password_reset_message method. */ - reset_key: number; - /** @description The password to log in to the empire. Must be between 6 and 30 characters. */ - password1: string; - /** @description Retyping the password again. This must match password1 to succeed. */ - password2: string; - /** @description Your client's unique API key, identifying it from all other clients. See ApiKeys for details. */ - api_key: string; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Change the empire password that has been forgotten. Returns the same response as `login` if successful. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -18870,12 +20363,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - session_id: string; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -18897,7 +20391,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/change_password": { + "/v2/dairy/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -18906,6 +20400,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -18916,15 +20414,15 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description The password to log in to the empire. Must be between 6 and 30 characters. */ - password1: string; - /** @description Retyping the password again. This must match password1 to succeed. */ - password2: string; + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Change the empire password. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -18934,16 +20432,38 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - }; - }; - }; - }; - /** @description RPC Error */ + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ 500: { headers: { [name: string]: unknown; @@ -18960,7 +20480,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/find": { + "/v2/dairy/view": { parameters: { query?: never; header?: never; @@ -18969,6 +20489,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -18979,13 +20503,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description The name you're searching for. Case insensitive, and partial names work fine. Must be at least 3 characters. */ - name: string; + /** @description The id of the building you wish to retrieve. */ + building_id: number; }; }; }; responses: { - /** @description Find an empire by name. Returns a hash reference containing empire ids and empire names. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -18995,10 +20519,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - empires: { - id: number; - name: string; - }[]; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -19025,7 +20546,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/set_status_message": { + "/v2/denton/build": { parameters: { query?: never; header?: never; @@ -19034,6 +20555,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -19044,13 +20569,17 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description A message to indicate what you're doing, how you're feeling, or other status indicator. Limited to 100 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ - message: string; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Sets the empire status message. Similar to what you might put on your Facebook wall, or in a tweet, but about your empire. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -19060,11 +20589,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -19086,7 +20625,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/view_boosts": { + "/v2/denton/upgrade": { parameters: { query?: never; header?: never; @@ -19095,6 +20634,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -19102,9 +20645,16 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; responses: { - /** @description Shows the dates at which boosts have expired or will expire. Boosts are subsidies applied to various resources using essentia. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -19114,21 +20664,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - boosts: { - spy_training: string; - ore: string; - water: string; - storage: string; - food: string; - happiness: string; - building: string; - energy: string; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -19150,7 +20700,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/boost_storage": { + "/v2/denton/downgrade": { parameters: { query?: never; header?: never; @@ -19159,6 +20709,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -19169,13 +20723,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description Optional. The number of 7 day boost periods to buy at once, at 5 essentia each. Defaults to 1. */ - weeks?: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Spends 5 essentia, and boosts storage (all 5 types) on all planets for 7 days. If a boost is already underway, calling again will add 7 more days. Throws 1011. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -19185,21 +20739,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - boosts: { - spy_training: string; - ore: string; - water: string; - storage: string; - food: string; - happiness: string; - building: string; - energy: string; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -19221,7 +20767,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/boost_food": { + "/v2/denton/demolish": { parameters: { query?: never; header?: never; @@ -19230,6 +20776,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -19240,13 +20790,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description Optional. The number of 7 day boost periods to buy at once, at 5 essentia each. Defaults to 1. */ - weeks?: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Spends 5 essentia, and boosts food production on all planets for 7 days. If a boost is already underway, calling again will add 7 more days. Throws 1011. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -19256,21 +20806,79 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - boosts: { - spy_training: string; - ore: string; - water: string; - storage: string; - food: string; - happiness: string; - building: string; - energy: string; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/denton/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -19292,7 +20900,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/boost_water": { + "/v2/denton/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -19301,6 +20909,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -19311,13 +20923,15 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description Optional. The number of 7 day boost periods to buy at once, at 5 essentia each. Defaults to 1. */ - weeks?: number; + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Spends 5 essentia, and boosts water production on all planets for 7 days. If a boost is already underway, calling again will add 7 more days. Throws 1011. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -19327,15 +20941,27 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - boosts: { - spy_training: string; - ore: string; - water: string; - storage: string; - food: string; - happiness: string; - building: string; - energy: string; + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; }; status: { server: components["schemas"]["server_status"]; @@ -19363,7 +20989,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/boost_energy": { + "/v2/denton/view": { parameters: { query?: never; header?: never; @@ -19372,6 +20998,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -19382,13 +21012,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description Optional. The number of 7 day boost periods to buy at once, at 5 essentia each. Defaults to 1. */ - weeks?: number; + /** @description The id of the building you wish to retrieve. */ + building_id: number; }; }; }; responses: { - /** @description Spends 5 essentia, and boosts energy production on all planets for 7 days. If a boost is already underway, calling again will add 7 more days. Throws 1011. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -19398,16 +21028,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - boosts: { - spy_training: string; - ore: string; - water: string; - storage: string; - food: string; - happiness: string; - building: string; - energy: string; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -19434,7 +21055,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/boost_ore": { + "/v2/dentonbrambles/build": { parameters: { query?: never; header?: never; @@ -19443,6 +21064,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -19453,13 +21078,17 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description Optional. The number of 7 day boost periods to buy at once, at 5 essentia each. Defaults to 1. */ - weeks?: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Spends 5 essentia, and boosts ore production on all planets for 7 days. If a boost is already underway, calling again will add 7 more days. Throws 1011. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -19469,21 +21098,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - boosts: { - spy_training: string; - ore: string; - water: string; - storage: string; - food: string; - happiness: string; - building: string; - energy: string; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -19505,7 +21134,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/boost_happiness": { + "/v2/dentonbrambles/upgrade": { parameters: { query?: never; header?: never; @@ -19514,6 +21143,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -19524,13 +21157,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description Optional. The number of 7 day boost periods to buy at once, at 5 essentia each. Defaults to 1. */ - weeks?: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Spends 5 essentia, and boosts happiness production on all planets for 7 days. If a boost is already underway, calling again will add 7 more days. Throws 1011. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -19540,21 +21173,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - boosts: { - spy_training: string; - ore: string; - water: string; - storage: string; - food: string; - happiness: string; - building: string; - energy: string; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -19576,7 +21209,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/boost_building": { + "/v2/dentonbrambles/downgrade": { parameters: { query?: never; header?: never; @@ -19585,6 +21218,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -19595,13 +21232,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description Optional. The number of 7 day boost periods to buy at once, at 5 essentia each. Defaults to 1. */ - weeks?: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Spends 5 essentia, and boosts build queues on all planets for 7 days. If a boost is already underway, calling again will add 7 more days. It will not boost builds already under way, only new builds added to a build queue. Throws 1011. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -19611,21 +21248,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - boosts: { - spy_training: string; - ore: string; - water: string; - storage: string; - food: string; - happiness: string; - building: string; - energy: string; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -19647,7 +21276,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/boost_spy_training": { + "/v2/dentonbrambles/demolish": { parameters: { query?: never; header?: never; @@ -19656,6 +21285,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -19666,13 +21299,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description Optional. The number of 7 day boost periods to buy at once, at 5 essentia each. Defaults to 1. */ - weeks?: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Spends 5 essentia, and boosts spy training speed on all planets by 50% for 7 days. If a boost is already underway, calling again will add 7 more days. Unlike the other boosts, this one also boosts spies already in specialist training. Throws 1011. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -19682,21 +21315,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - boosts: { - spy_training: string; - ore: string; - water: string; - storage: string; - food: string; - happiness: string; - building: string; - energy: string; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -19718,7 +21342,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/enable_self_destruct": { + "/v2/dentonbrambles/repair": { parameters: { query?: never; header?: never; @@ -19727,6 +21351,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -19734,9 +21362,16 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; responses: { - /** @description Enables a destruction countdown of 24 hours. Sometime after the timer runs out, the empire will vaporize. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -19746,11 +21381,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -19772,7 +21409,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/disable_self_destruct": { + "/v2/dentonbrambles/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -19781,6 +21418,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -19788,9 +21429,18 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; responses: { - /** @description Disables the self destruction countdown. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -19800,6 +21450,28 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -19826,7 +21498,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/redeem_essentia_code": { + "/v2/dentonbrambles/view": { parameters: { query?: never; header?: never; @@ -19835,6 +21507,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -19845,13 +21521,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description A 36 character string that was sent to the user via email. */ - code: string; + /** @description The id of the building you wish to retrieve. */ + building_id: number; }; }; }; responses: { - /** @description Redeems an essentia code and applies the essentia to the empire's balance. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -19861,7 +21537,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - amount: number; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -19888,7 +21564,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/update_species": { + "/v2/deployedbleeder/build": { parameters: { query?: never; header?: never; @@ -19897,6 +21573,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -19907,46 +21587,17 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description The id of the empire you wish to update a species for. */ - empire_id: number; - /** @description The species definition. Every field except name and description is an integer, and those integers must add up to exactly 45. */ - params: { - /** @description The name of the species. Limited to 30 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ - name: string; - /** @description The species description. Limited to 1024 characters and cannot contain < or >. */ - description: string; - /** @description The closest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be less than or equal to max_orbit. */ - min_orbit: number; - /** @description The furthest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be greater than or equal to min_orbit. */ - max_orbit: number; - /** @description 7 is best. Determines advantages in manufactured goods, such as ships. */ - manufacturing_affinity: number; - /** @description 7 is best. Determines advantages in spying. */ - deception_affinity: number; - /** @description 7 is best. Determines advantages in upgrading buildings. */ - research_affinity: number; - /** @description 7 is best. Determines advantages in the speed of building. */ - management_affinity: number; - /** @description 7 is best. Determines advantages in food production. */ - farming_affinity: number; - /** @description 7 is best. Determines advantages in mineral production. */ - mining_affinity: number; - /** @description 7 is best. Determines advantages in energy, propulsion, and other technologies. */ - science_affinity: number; - /** @description 7 is best. Determines advantages in waste and water management. */ - environmental_affinity: number; - /** @description 7 is best. Determines advantages in managing population happiness. */ - political_affinity: number; - /** @description 7 is best. Determines advantages in freight handling. */ - trade_affinity: number; - /** @description 7 is best. Determines advantages in colonization. */ - growth_affinity: number; - }; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Updates the empire's species and returns 1. Can only be called after create and before found; calling it outside that window throws an exception. Use redefine_species for an empire that has already been founded, and see get_species_templates for ready-made starting points. Throws 1000, 1002, 1005, 1007, 1008, 1009, and 1010 — the error data names the field that needs adjusting whenever the problem can be attributed to a single field. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -19955,8 +21606,23 @@ export interface paths { "application/json": { id?: number; jsonrpc?: string; - /** @enum {integer} */ - result?: 1; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; }; }; }; @@ -19977,7 +21643,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/redefine_species_limits": { + "/v2/deployedbleeder/upgrade": { parameters: { query?: never; header?: never; @@ -19986,6 +21652,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -19993,9 +21663,16 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; responses: { - /** @description Returns the extra limits placed upon an empire that wants to redefine its species, including the essentia cost, the settable orbit range, the minimum growth affinity, and whether a redefinition is currently allowed at all. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -20005,18 +21682,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - essentia_cost: number; - max_orbit: number; - min_orbit: number; - min_growth: number; - /** @enum {integer} */ - can: 1 | 0; - reason?: string; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -20038,7 +21718,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/redefine_species": { + "/v2/deployedbleeder/downgrade": { parameters: { query?: never; header?: never; @@ -20047,6 +21727,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -20057,44 +21741,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description The species definition, same as the params of update_species. Every field except name and description is an integer, and those integers must add up to exactly 45. */ - params: { - /** @description The name of the species. Limited to 30 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ - name: string; - /** @description The species description. Limited to 1024 characters and cannot contain < or >. */ - description: string; - /** @description The closest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be less than or equal to max_orbit. */ - min_orbit: number; - /** @description The furthest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be greater than or equal to min_orbit. */ - max_orbit: number; - /** @description 7 is best. Determines advantages in manufactured goods, such as ships. */ - manufacturing_affinity: number; - /** @description 7 is best. Determines advantages in spying. */ - deception_affinity: number; - /** @description 7 is best. Determines advantages in upgrading buildings. */ - research_affinity: number; - /** @description 7 is best. Determines advantages in the speed of building. */ - management_affinity: number; - /** @description 7 is best. Determines advantages in food production. */ - farming_affinity: number; - /** @description 7 is best. Determines advantages in mineral production. */ - mining_affinity: number; - /** @description 7 is best. Determines advantages in energy, propulsion, and other technologies. */ - science_affinity: number; - /** @description 7 is best. Determines advantages in waste and water management. */ - environmental_affinity: number; - /** @description 7 is best. Determines advantages in managing population happiness. */ - political_affinity: number; - /** @description 7 is best. Determines advantages in freight handling. */ - trade_affinity: number; - /** @description 7 is best. Determines advantages in colonization. */ - growth_affinity: number; - }; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Spends essentia to redefine the empire's species affinities, name, and description. Only usable after the empire has been founded — use update_species during empire creation instead. See also redefine_species_limits. WARNING: once this is done it cannot be redone for 1 month, so make sure the user is aware and prompt them appropriately before submitting. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -20104,11 +21757,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -20130,7 +21785,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/view_species_stats": { + "/v2/deployedbleeder/demolish": { parameters: { query?: never; header?: never; @@ -20139,6 +21794,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -20146,9 +21805,16 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; responses: { - /** @description Returns the stats associated with the empire's species as it was originally created. An empire can only view its own species stats through this method. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -20158,43 +21824,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - species: { - /** @description The name of the species. Limited to 30 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ - name: string; - /** @description The species description. Limited to 1024 characters and cannot contain < or >. */ - description: string; - /** @description The closest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be less than or equal to max_orbit. */ - min_orbit: number; - /** @description The furthest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be greater than or equal to min_orbit. */ - max_orbit: number; - /** @description 7 is best. Determines advantages in manufactured goods, such as ships. */ - manufacturing_affinity: number; - /** @description 7 is best. Determines advantages in spying. */ - deception_affinity: number; - /** @description 7 is best. Determines advantages in upgrading buildings. */ - research_affinity: number; - /** @description 7 is best. Determines advantages in the speed of building. */ - management_affinity: number; - /** @description 7 is best. Determines advantages in food production. */ - farming_affinity: number; - /** @description 7 is best. Determines advantages in mineral production. */ - mining_affinity: number; - /** @description 7 is best. Determines advantages in energy, propulsion, and other technologies. */ - science_affinity: number; - /** @description 7 is best. Determines advantages in waste and water management. */ - environmental_affinity: number; - /** @description 7 is best. Determines advantages in managing population happiness. */ - political_affinity: number; - /** @description 7 is best. Determines advantages in freight handling. */ - trade_affinity: number; - /** @description 7 is best. Determines advantages in colonization. */ - growth_affinity: number; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -20216,7 +21851,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/get_species_templates": { + "/v2/deployedbleeder/repair": { parameters: { query?: never; header?: never; @@ -20225,6 +21860,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -20232,88 +21871,16 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: never; - responses: { - /** @description Returns the list of species templates that can be used to help the user populate the form for update_species. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - /** @description The name of the species. Limited to 30 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ - name: string; - /** @description The species description. Limited to 1024 characters and cannot contain < or >. */ - description: string; - /** @description The closest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be less than or equal to max_orbit. */ - min_orbit: number; - /** @description The furthest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be greater than or equal to min_orbit. */ - max_orbit: number; - /** @description 7 is best. Determines advantages in manufactured goods, such as ships. */ - manufacturing_affinity: number; - /** @description 7 is best. Determines advantages in spying. */ - deception_affinity: number; - /** @description 7 is best. Determines advantages in upgrading buildings. */ - research_affinity: number; - /** @description 7 is best. Determines advantages in the speed of building. */ - management_affinity: number; - /** @description 7 is best. Determines advantages in food production. */ - farming_affinity: number; - /** @description 7 is best. Determines advantages in mineral production. */ - mining_affinity: number; - /** @description 7 is best. Determines advantages in energy, propulsion, and other technologies. */ - science_affinity: number; - /** @description 7 is best. Determines advantages in waste and water management. */ - environmental_affinity: number; - /** @description 7 is best. Determines advantages in managing population happiness. */ - political_affinity: number; - /** @description 7 is best. Determines advantages in freight handling. */ - trade_affinity: number; - /** @description 7 is best. Determines advantages in colonization. */ - growth_affinity: number; - }[]; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; }; }; }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/empire/view_authorized_sitters": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; responses: { - /** @description Lists the empires currently authorized to sit for this empire. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -20323,16 +21890,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - sitters: { - id: number; - name: string; - expiry: string; - }[]; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -20354,7 +21918,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/authorize_sitters": { + "/v2/deployedbleeder/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -20363,6 +21927,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -20373,27 +21941,15 @@ export interface paths { requestBody?: { content: { "application/json": { - /** - * @description If true, all allies are automatically selected. - * @enum {integer} - */ - allied?: 1 | 0; - /** @description The name of another alliance, all of whom are automatically selected. */ - alliance?: string; - /** @description The id of another alliance, all of whom are automatically selected. */ - alliance_id?: number; - /** @description The ids and/or names of specific empires being authorized. */ - empires?: string[]; - /** - * @description A quick way of selecting all currently-authorized empires in order to extend their authorization period. - * @enum {integer} - */ - revalidate_all?: 1 | 0; + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Authorizes other empires to babysit this account. Each authorization is created if needed and granted for the full server-defined period. Returns the same list as view_authorized_sitters, plus any ids that were rejected. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -20403,14 +21959,28 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - auths: { + building: { id: number; name: string; - }[]; - rejected_ids?: { - id: number; - reason: string; - }[]; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -20437,7 +22007,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/empire/deauthorize_sitters": { + "/v2/deployedbleeder/view": { parameters: { query?: never; header?: never; @@ -20446,6 +22016,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -20456,13 +22030,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description The ids (not names) of specific empires being removed. */ - empires: string[]; + /** @description The id of the building you wish to retrieve. */ + building_id: number; }; }; }; responses: { - /** @description Removes sitters from being permitted to sit this account. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -20472,6 +22046,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -20498,7 +22073,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/energyreserve/build": { + "/v2/development/build": { parameters: { query?: never; header?: never; @@ -20507,6 +22082,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -20517,8 +22096,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -20570,7 +22152,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/energyreserve/upgrade": { + "/v2/development/upgrade": { parameters: { query?: never; header?: never; @@ -20579,6 +22161,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -20589,6 +22175,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -20640,7 +22227,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/energyreserve/downgrade": { + "/v2/development/downgrade": { parameters: { query?: never; header?: never; @@ -20649,6 +22236,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -20659,6 +22250,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -20702,7 +22294,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/energyreserve/demolish": { + "/v2/development/demolish": { parameters: { query?: never; header?: never; @@ -20711,6 +22303,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -20721,6 +22317,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -20763,7 +22360,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/energyreserve/repair": { + "/v2/development/repair": { parameters: { query?: never; header?: never; @@ -20772,6 +22369,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -20782,6 +22383,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -20825,7 +22427,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/energyreserve/get_stats_for_level": { + "/v2/development/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -20834,6 +22436,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -20844,7 +22450,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -20908,7 +22516,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/energyreserve/view": { + "/v2/development/view": { parameters: { query?: never; header?: never; @@ -20917,6 +22525,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -20927,6 +22539,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -20948,6 +22561,19 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + build_queue: { + /** @description The unique id of the building. */ + building_id: number; + name: string; + to_level: number; + seconds_remaining: number; + x: number; + y: number; + /** @description The essentia cost to subsidize just this building. */ + subsidy_cost: number; + }[]; + /** @description The essentia cost to subsidize the whole build queue. */ + subsidy_cost: number; }; }; }; @@ -20969,7 +22595,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/energyreserve/dump": { + "/v2/development/subsidize_build_queue": { parameters: { query?: never; header?: never; @@ -20978,6 +22604,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Subsidize build queue. + * @description Instantly finishes all buildings in the build queue. + */ post: { parameters: { query?: never; @@ -20988,14 +22618,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - /** @description The amount of energy to dump. */ - amount: number; }; }; }; responses: { - /** @description Converts energy into waste. */ + /** @description Instantly finishes all buildings in the build queue. */ 200: { headers: { [name: string]: unknown; @@ -21010,6 +22639,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + essentia_spent: number; }; }; }; @@ -21031,7 +22661,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/entertainment/build": { + "/v2/development/subsidize_one_build": { parameters: { query?: never; header?: never; @@ -21040,6 +22670,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Subsidize one build. + * @description Subsidizes the immediate build of one job on the build queue. Later jobs (if any) are brought forward by the (remaining) time of the subsidized build. + */ post: { parameters: { query?: never; @@ -21050,14 +22684,15 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; + /** @description The ID of the building scheduled to be built/upgraded that you wish to subsidize. */ + scheduled_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Subsidizes the immediate build of one job on the build queue. Later jobs (if any) are brought forward by the (remaining) time of the subsidized build. */ 200: { headers: { [name: string]: unknown; @@ -21067,21 +22702,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; + essentia_spent: number; }; }; }; @@ -21103,7 +22729,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/entertainment/upgrade": { + "/v2/development/cancel_build": { parameters: { query?: never; header?: never; @@ -21112,6 +22738,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Cancel build. + * @description Cancels a build. All following builds in the build queue are brought forward. Resources or plans used when the build/upgrade was requested are not returned. Returns the same as the view method. + */ post: { parameters: { query?: never; @@ -21122,12 +22752,17 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The ID, or array of IDs, of the building(s) scheduled to be built/upgraded that you wish to cancel. One of scheduled_id or cancel_all is required. */ + scheduled_id?: number | number[]; + /** @description If true, cancels all builds currently scheduled. */ + cancel_all?: boolean; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Cancels a build. All following builds in the build queue are brought forward. Resources or plans used when the build/upgrade was requested are not returned. Returns the same as the view method. */ 200: { headers: { [name: string]: unknown; @@ -21137,21 +22772,25 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; + build_queue: { + /** @description The unique id of the building. */ + building_id: number; + name: string; + to_level: number; + seconds_remaining: number; + x: number; + y: number; + /** @description The essentia cost to subsidize just this building. */ + subsidy_cost: number; + }[]; + /** @description The essentia cost to subsidize the whole build queue. */ + subsidy_cost: number; }; }; }; @@ -21173,7 +22812,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/entertainment/downgrade": { + "/v2/distributioncenter/build": { parameters: { query?: never; header?: never; @@ -21182,6 +22821,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -21192,12 +22835,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -21207,7 +22855,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -21235,7 +22891,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/entertainment/demolish": { + "/v2/distributioncenter/upgrade": { parameters: { query?: never; header?: never; @@ -21244,6 +22900,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -21254,12 +22914,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -21269,6 +22930,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -21296,7 +22966,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/entertainment/repair": { + "/v2/distributioncenter/downgrade": { parameters: { query?: never; header?: never; @@ -21305,6 +22975,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -21315,6 +22989,140 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/distributioncenter/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/distributioncenter/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -21358,7 +23166,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/entertainment/get_stats_for_level": { + "/v2/distributioncenter/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -21367,6 +23175,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -21377,7 +23189,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -21441,7 +23255,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/entertainment/view": { + "/v2/distributioncenter/view": { parameters: { query?: never; header?: never; @@ -21450,6 +23264,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -21460,6 +23278,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -21481,7 +23300,21 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - ducks_quacked: number; + reserve: { + /** @enum {integer} */ + can: 1 | 0; + /** @description Time until reserved resources will automatically be released. */ + seconds_remaining: number; + /** @description Max length resources can be kept in reserve. */ + max_reserve_duration: number; + /** @description Max amount of resources that can be reserved. */ + max_reserve_size: number; + /** @description Resources currently in reserve. */ + resources: { + type: string; + quantity: number; + }[]; + }; }; }; }; @@ -21503,7 +23336,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/entertainment/get_lottery_voting_options": { + "/v2/distributioncenter/reserve": { parameters: { query?: never; header?: never; @@ -21512,6 +23345,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Reserve resources. + * @description Reserves resources so they are held until the timer expires or manually released. Returns the building view. Throws 1009, 1010, and 1011. + */ post: { parameters: { query?: never; @@ -21522,12 +23359,19 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description Resources to reserve so they don't get automatically spent. */ + resources: { + type: string; + /** @description How many to process. Defaults to 1. */ + quantity: number; + }[]; }; }; }; responses: { - /** @description Returns a list of sites the user can vote on. Voting once per site per day enters the empire into a daily lottery for 10 essentia; each vote is equal, but more votes increase the odds of winning. Each url is usable only once every 24 hours. */ + /** @description Reserves resources so they are held until the timer expires or manually released. Returns the building view. Throws 1009, 1010, and 1011. */ 200: { headers: { [name: string]: unknown; @@ -21537,15 +23381,27 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - options: { - name: string; - url: string; - }[]; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + reserve: { + /** @enum {integer} */ + can: 1 | 0; + /** @description Time until reserved resources will automatically be released. */ + seconds_remaining: number; + /** @description Max length resources can be kept in reserve. */ + max_reserve_duration: number; + /** @description Max amount of resources that can be reserved. */ + max_reserve_size: number; + /** @description Resources currently in reserve. */ + resources: { + type: string; + quantity: number; + }[]; + }; }; }; }; @@ -21567,7 +23423,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/entertainment/duck_quack": { + "/v2/distributioncenter/release_reserve": { parameters: { query?: never; header?: never; @@ -21576,6 +23432,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Release reserve. + * @description Returns the resources held in reserve back to the planet. + */ post: { parameters: { query?: never; @@ -21586,12 +23446,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Returns a fun string of quack text. Formatting (whitespace and carriage returns) must be preserved when displayed to the user. */ + /** @description Returns the resources held in reserve back to the planet. */ 200: { headers: { [name: string]: unknown; @@ -21601,7 +23462,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - quack: string; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -21628,7 +23488,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/espionage/build": { + "/v2/distributioncenter/get_stored_resources": { parameters: { query?: never; header?: never; @@ -21637,6 +23497,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get stored resources. + * @description Returns a list of the resources you have stored, to make it easier to identify what you want to store. + */ post: { parameters: { query?: never; @@ -21647,8 +23511,81 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Returns a list of the resources you have stored, to make it easier to identify what you want to store. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + cargo_space_used_each: number; + /** @description Keyed by resource type. */ + resources: { + [key: string]: number; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/embassy/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -21700,7 +23637,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/espionage/upgrade": { + "/v2/embassy/upgrade": { parameters: { query?: never; header?: never; @@ -21709,6 +23646,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -21719,6 +23660,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -21770,7 +23712,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/espionage/downgrade": { + "/v2/embassy/downgrade": { parameters: { query?: never; header?: never; @@ -21779,6 +23721,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -21789,6 +23735,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -21832,7 +23779,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/espionage/demolish": { + "/v2/embassy/demolish": { parameters: { query?: never; header?: never; @@ -21841,6 +23788,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -21851,6 +23802,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -21893,7 +23845,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/espionage/repair": { + "/v2/embassy/repair": { parameters: { query?: never; header?: never; @@ -21902,6 +23854,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -21912,6 +23868,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -21955,7 +23912,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/espionage/get_stats_for_level": { + "/v2/embassy/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -21964,6 +23921,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -21974,7 +23935,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -22038,7 +24001,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/espionage/view": { + "/v2/embassy/view": { parameters: { query?: never; header?: never; @@ -22047,6 +24010,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -22057,6 +24024,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -22078,6 +24046,20 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + /** @description Present only when this empire is in an alliance. */ + alliance_status?: { + id?: number; + name?: string; + members?: { + empire_id?: number; + name?: string; + }[]; + leader_id?: number; + forum_uri?: string; + description?: string; + announcements?: string; + date_created?: string; + }; }; }; }; @@ -22099,7 +24081,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/essentiavein/build": { + "/v2/embassy/create_alliance": { parameters: { query?: never; header?: never; @@ -22108,6 +24090,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Create alliance. + * @description Creates a new alliance with this empire as leader. + */ post: { parameters: { query?: never; @@ -22118,14 +24104,15 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; + /** @description A unique alliance name, 3-30 characters, no profanity or restricted characters. */ + name: string; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Creates a new alliance with this empire as leader. */ 200: { headers: { [name: string]: unknown; @@ -22135,21 +24122,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -22171,7 +24148,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/essentiavein/upgrade": { + "/v2/embassy/get_alliance_status": { parameters: { query?: never; header?: never; @@ -22180,6 +24157,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get alliance status. + * @description Returns this empire's alliance data. + */ post: { parameters: { query?: never; @@ -22190,12 +24171,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Returns this empire's alliance data. */ 200: { headers: { [name: string]: unknown; @@ -22205,21 +24187,22 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + id?: number; + name?: string; + members?: { + empire_id?: number; + name?: string; + }[]; + leader_id?: number; + forum_uri?: string; + description?: string; + announcements?: string; + date_created?: string; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -22241,7 +24224,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/essentiavein/downgrade": { + "/v2/embassy/dissolve_alliance": { parameters: { query?: never; header?: never; @@ -22250,6 +24233,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Dissolve alliance. + * @description Leader-only. Disbands the alliance and converts its space stations to asteroids. + */ post: { parameters: { query?: never; @@ -22260,12 +24247,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Leader-only. Disbands the alliance and converts its space stations to asteroids. */ 200: { headers: { [name: string]: unknown; @@ -22275,13 +24263,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -22303,7 +24289,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/essentiavein/demolish": { + "/v2/embassy/update_alliance": { parameters: { query?: never; header?: never; @@ -22312,6 +24298,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Update alliance. + * @description Leader-only. Updates alliance metadata. + */ post: { parameters: { query?: never; @@ -22322,12 +24312,19 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The alliance properties to update. Any or all of forum_uri, description, announcements. */ + params: { + forum_uri?: string; + description?: string; + announcements?: string; + }; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Leader-only. Updates alliance metadata. */ 200: { headers: { [name: string]: unknown; @@ -22342,7 +24339,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -22364,7 +24360,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/essentiavein/repair": { + "/v2/embassy/send_invite": { parameters: { query?: never; header?: never; @@ -22373,6 +24369,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Send invite. + * @description Leader-only. Invites an empire to join the alliance. + */ post: { parameters: { query?: never; @@ -22383,12 +24383,17 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description An optional personalised message included with the action. */ + message?: string; + /** @description The unique id of the empire to invite. */ + invitee_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Leader-only. Invites an empire to join the alliance. */ 200: { headers: { [name: string]: unknown; @@ -22398,13 +24403,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -22426,7 +24429,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/essentiavein/get_stats_for_level": { + "/v2/embassy/withdraw_invite": { parameters: { query?: never; header?: never; @@ -22435,6 +24438,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Withdraw invite. + * @description Leader-only. Withdraws a pending invite. + */ post: { parameters: { query?: never; @@ -22445,13 +24452,17 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; + /** @description An optional personalised message included with the action. */ + message?: string; + /** @description The unique id of the invitation. */ + invite_id: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Leader-only. Withdraws a pending invite. */ 200: { headers: { [name: string]: unknown; @@ -22461,28 +24472,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -22509,7 +24498,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/essentiavein/view": { + "/v2/embassy/get_pending_invites": { parameters: { query?: never; header?: never; @@ -22518,6 +24507,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get pending invites. + * @description Leader-only. Lists outstanding invites sent by the alliance. + */ post: { parameters: { query?: never; @@ -22528,12 +24521,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Leader-only. Lists outstanding invites sent by the alliance. */ 200: { headers: { [name: string]: unknown; @@ -22543,14 +24537,16 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + invites: { + id?: number; + name?: string; + empire_id?: number; + }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - /** @description How many groups of 30 days can be drained. E.g. 3 means 90-119 days remaining. */ - drain_capable?: number; }; }; }; @@ -22572,7 +24568,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/essentiavein/drain": { + "/v2/embassy/accept_invite": { parameters: { query?: never; header?: never; @@ -22581,6 +24577,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Accept invite. + * @description Accepts an invite to join an alliance. + */ post: { parameters: { query?: never; @@ -22591,14 +24591,17 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - /** @description Number of 30-day periods to drain in a single RPC. Instead of 4 essentia/day over 30 days, each period instantly provides 30 essentia. Defaults to 1. Periods less than 30 days can't be drained quickly. */ - times?: number; + /** @description An optional personalised message included with the action. */ + message?: string; + /** @description The unique id of the invitation. */ + invite_id: number; }; }; }; responses: { - /** @description Instantly drains one or more 30-day periods of essentia from the vein. */ + /** @description Accepts an invite to join an alliance. */ 200: { headers: { [name: string]: unknown; @@ -22634,7 +24637,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fission/build": { + "/v2/embassy/reject_invite": { parameters: { query?: never; header?: never; @@ -22643,6 +24646,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Reject invite. + * @description Declines an invite to join an alliance. + */ post: { parameters: { query?: never; @@ -22653,14 +24660,17 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; + /** @description An optional personalised message included with the action. */ + message?: string; + /** @description The unique id of the invitation. */ + invite_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Declines an invite to join an alliance. */ 200: { headers: { [name: string]: unknown; @@ -22670,21 +24680,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -22706,7 +24706,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fission/upgrade": { + "/v2/embassy/get_my_invites": { parameters: { query?: never; header?: never; @@ -22715,6 +24715,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get my invites. + * @description Lists invites this empire has received. + */ post: { parameters: { query?: never; @@ -22725,12 +24729,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Lists invites this empire has received. */ 200: { headers: { [name: string]: unknown; @@ -22740,21 +24745,83 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; + invites: { + id?: number; + name?: string; + alliance_id?: number; + }[]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/embassy/leave_alliance": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Leave alliance. + * @description Leaves the current alliance. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description An optional personalised message included with the action. */ + message?: string; + }; + }; + }; + responses: { + /** @description Leaves the current alliance. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -22776,7 +24843,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fission/downgrade": { + "/v2/embassy/expel_member": { parameters: { query?: never; header?: never; @@ -22785,6 +24852,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Expel member. + * @description Leader-only. Removes a member from the alliance. + */ post: { parameters: { query?: never; @@ -22795,12 +24866,17 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description An optional personalised message included with the action. */ + message?: string; + /** @description The unique id of the member to remove. */ + empire_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Leader-only. Removes a member from the alliance. */ 200: { headers: { [name: string]: unknown; @@ -22810,13 +24886,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -22838,7 +24912,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fission/demolish": { + "/v2/embassy/assign_alliance_leader": { parameters: { query?: never; header?: never; @@ -22847,6 +24921,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Assign alliance leader. + * @description Leader-only. Transfers alliance leadership to another current member. + */ post: { parameters: { query?: never; @@ -22857,12 +24935,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the empire to make leader. Must already be a member of the alliance. */ + new_leader_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Leader-only. Transfers alliance leadership to another current member. */ 200: { headers: { [name: string]: unknown; @@ -22877,7 +24958,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -22899,7 +24979,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fission/repair": { + "/v2/embassy/view_stash": { parameters: { query?: never; header?: never; @@ -22908,6 +24988,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View stash. + * @description Returns the alliance stash's contents. + */ post: { parameters: { query?: never; @@ -22918,12 +25002,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Returns the alliance stash's contents. */ 200: { headers: { [name: string]: unknown; @@ -22933,13 +25018,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + /** @description The alliance stash's contents, keyed by resource name. */ + stash: { + [key: string]: number; + }; + /** @description The calling planet's own storable resources, keyed by resource name. */ + stored: { + [key: string]: number; + }; + max_exchange_size: number; + exchanges_remaining_today: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -22961,7 +25054,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fission/get_stats_for_level": { + "/v2/embassy/donate_to_stash": { parameters: { query?: never; header?: never; @@ -22970,6 +25063,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Donate to stash. + * @description Donates resources to the alliance stash. + */ post: { parameters: { query?: never; @@ -22980,13 +25077,17 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; + /** @description Resource name to quantity, e.g. {"water": 4500, "bread": 5000}. Waste is not allowed. */ + donation: { + [key: string]: number; + }; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Donates resources to the alliance stash. */ 200: { headers: { [name: string]: unknown; @@ -22996,28 +25097,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -23044,7 +25123,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fission/view": { + "/v2/embassy/exchange_with_stash": { parameters: { query?: never; header?: never; @@ -23053,6 +25132,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Exchange with stash. + * @description Exchanges resources with the alliance stash. + */ post: { parameters: { query?: never; @@ -23063,12 +25146,21 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description Must equal request in total value. Waste is not allowed. */ + donation: { + [key: string]: number; + }; + /** @description Resource name to quantity to pull from the stash. Total value must equal the donation total. */ + request: { + [key: string]: number; + }; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Exchanges resources with the alliance stash. */ 200: { headers: { [name: string]: unknown; @@ -23078,7 +25170,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -23105,7 +25196,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fissure/build": { + "/v2/embassy/view_propositions": { parameters: { query?: never; header?: never; @@ -23114,6 +25205,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View propositions. + * @description Lists pending propositions the alliance is voting on. + */ post: { parameters: { query?: never; @@ -23124,14 +25219,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Lists pending propositions the alliance is voting on. */ 200: { headers: { [name: string]: unknown; @@ -23141,21 +25235,30 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; + propositions: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; }; - }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -23177,7 +25280,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fissure/upgrade": { + "/v2/embassy/cast_vote": { parameters: { query?: never; header?: never; @@ -23186,6 +25289,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Cast vote. + * @description Casts a vote on a proposition. Throws 1018 if already voted. + */ post: { parameters: { query?: never; @@ -23196,12 +25303,20 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The id of the proposition being voted on. See view_propositions. */ + proposition_id: number; + /** + * @description 1 for yes, 0 for no. Defaults to 0. + * @enum {integer} + */ + vote: 1 | 0; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Casts a vote on a proposition. Throws 1018 if already voted. */ 200: { headers: { [name: string]: unknown; @@ -23211,21 +25326,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -23247,7 +25352,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fissure/downgrade": { + "/v2/empire/is_name_available": { parameters: { query?: never; header?: never; @@ -23256,6 +25361,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Check whether an empire name is available. + * @description Returns 1 if the name is available, or throws an exception if it is not. Throws 1000. + */ post: { parameters: { query?: never; @@ -23266,12 +25375,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The name of the empire to search for. */ + name: string; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Returns a 1 if the name is available, or throws an exception if it is not. Throws 1000. */ 200: { headers: { [name: string]: unknown; @@ -23280,15 +25390,8 @@ export interface paths { "application/json": { id?: number; jsonrpc?: string; - result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; - }; + /** @enum {integer} */ + result?: 1 | 0; }; }; }; @@ -23309,7 +25412,60 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fissure/demolish": { + "/v2/empire/logout": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * End the current session. + * @description Ends a session. Returns 1. Throws 1006. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Ends a session. Returns 1. Throws 1006. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + /** @enum {integer} */ + result?: 1; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/empire/login": { parameters: { query?: never; header?: never; @@ -23318,6 +25474,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Log in to an empire and start a session. + * @description Confirms the password matches the empire and returns a session id alongside the empire and server status. A session survives up to 2 hours of inactivity, so there is no need to log in again while an existing session is still valid. Throws 1004 and 1005. + */ post: { parameters: { query?: never; @@ -23328,12 +25488,20 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The name of the empire. */ + empire_name: string; + /** + * Format: password + * @description The password to authenticate to the empire. + */ + password: string; + /** @description Your client's unique API key, identifying it from all other clients. See ApiKeys for details. */ + api_key: string; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Confirms the password matches the empire and returns a session id alongside the empire and server status. A session survives up to 2 hours of inactivity, so there is no need to log in again while an existing session is still valid. Throws 1004 and 1005. */ 200: { headers: { [name: string]: unknown; @@ -23343,12 +25511,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + session_id: string; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -23370,7 +25538,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fissure/repair": { + "/v2/empire/fetch_captcha": { parameters: { query?: never; header?: never; @@ -23379,6 +25547,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Fetch a captcha for empire creation. + * @description Retrieves a captcha that is required in order to call the create method. Display the resulting captcha in your creation form and then call create with the user's response. + */ post: { parameters: { query?: never; @@ -23386,15 +25558,9 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; + requestBody?: never; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Retrieves a captcha that is required in order to call the create method. Display the resulting captcha in your creation form and then call create with the user's response. */ 200: { headers: { [name: string]: unknown; @@ -23404,13 +25570,8 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; + guid: string; + url: string; }; }; }; @@ -23432,7 +25593,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fissure/get_stats_for_level": { + "/v2/empire/create": { parameters: { query?: never; header?: never; @@ -23441,6 +25602,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Create a new empire. + * @description Creates a new empire and returns its empire_id. The empire is not playable yet — either call update_species and then found, or skip the species step and call found directly. Throws 1000, 1001, 1002, and 1014. On a 1014 the error data carries fresh captcha information that must be used for the next attempt, since a captcha cannot be used more than once. + */ post: { parameters: { query?: never; @@ -23451,13 +25616,25 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - level: number; + /** @description The name of the empire to create. */ + name: string; + /** @description The password to log in to the empire. Must be between 6 and 30 characters. */ + password?: string; + /** @description Retyping the password again. This must match password to succeed. Required whenever password is supplied. */ + password1?: string; + /** @description Must match the guid field returned by the fetch_captcha method. */ + captcha_guid: string; + /** @description The text typed in by the user as the solution of the captcha. */ + captcha_solution: string; + /** @description The user's email address. Not required, but used for system vital functions like password recovery. */ + email?: string; + /** @description A 36 character code that was sent to the user by a friend. Usable only once, it ensures that their friend gets a home planet in relatively close proximity to their own. */ + invite_code?: string; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Creates a new empire and returns its empire_id. The empire is not playable yet — either call update_species and then found, or skip the species step and call found directly. Throws 1000, 1001, 1002, and 1014. On a 1014 the error data carries fresh captcha information that must be used for the next attempt, since a captcha cannot be used more than once. */ 200: { headers: { [name: string]: unknown; @@ -23466,35 +25643,8 @@ export interface paths { "application/json": { id?: number; jsonrpc?: string; - result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - }; + /** @description The new empire id. */ + result?: number; }; }; }; @@ -23515,7 +25665,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fissure/view": { + "/v2/empire/found": { parameters: { query?: never; header?: never; @@ -23524,6 +25674,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Found an empire on its home world. + * @description Sets up an empire on its new home world. Once this method is called, the species can no longer be modified. The returned welcome_message_id identifies an inbox message that starts the tutorial, so the user can be prompted to read it right away. + */ post: { parameters: { query?: never; @@ -23534,12 +25688,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The empire to found. */ + empire_id: number; + /** @description Your client's unique API key, identifying it from all other clients. See ApiKeys for details. */ + api_key: string; + /** @description Deprecated here. Pass invite_code to the create method instead. */ + invite_code?: string; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Sets up an empire on its new home world. Once this method is called, the species can no longer be modified. The returned welcome_message_id identifies an inbox message that starts the tutorial, so the user can be prompted to read it right away. */ 200: { headers: { [name: string]: unknown; @@ -23549,7 +25708,8 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + session_id: string; + welcome_message_id: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -23576,7 +25736,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/foodreserve/build": { + "/v2/empire/get_invite_friend_url": { parameters: { query?: never; header?: never; @@ -23585,6 +25745,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get a referral URL for inviting friends. + * @description Returns a URL that can be pasted into a blog, forum, or whatever to invite friends. + */ post: { parameters: { query?: never; @@ -23592,17 +25756,9 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - body_id: number; - x: number; - y: number; - }; - }; - }; + requestBody?: never; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Returns a URL that can be pasted into a blog, forum, or whatever to invite friends. */ 200: { headers: { [name: string]: unknown; @@ -23612,21 +25768,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + referral_url: string; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -23648,7 +25795,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/foodreserve/upgrade": { + "/v2/empire/invite_friend": { parameters: { query?: never; header?: never; @@ -23657,6 +25804,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Email a friend an invitation code. + * @description Sends an invitation code to a friend so that they can start in the same zone as your empire. + */ post: { parameters: { query?: never; @@ -23667,12 +25818,15 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The email address of your friend, or a comma separated string of email addresses. */ + email: string; + /** @description An optional message the user can type to invite their friend. Defaults to "I'm having a great time with this new game called Lacuna Expanse. Come play with me." The empire name, friend code, and server URI are appended to whatever is sent. */ + custom_message?: string; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Sends an invitation code to a friend so that they can start in the same zone as your empire. Each not_sent entry pairs the address with the [code, message] reason it could not be invited. */ 200: { headers: { [name: string]: unknown; @@ -23682,21 +25836,16 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + sent?: string[]; + not_sent?: { + address: string; + reason: unknown[]; + }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -23718,7 +25867,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/foodreserve/downgrade": { + "/v2/empire/get_status": { parameters: { query?: never; header?: never; @@ -23727,6 +25876,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get the current state of the empire. + * @description Returns information about the current state of the empire. You should probably never call this directly — it is a wasted call, since the same data comes back in the status block of every relevant request. Throws 1002. + */ post: { parameters: { query?: never; @@ -23734,15 +25887,9 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; + requestBody?: never; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Returns information about the current state of the empire. You should probably never call this directly — it is a wasted call, since the same data comes back in the status block of every relevant request. Throws 1002. */ 200: { headers: { [name: string]: unknown; @@ -23752,13 +25899,8 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; + server: components["schemas"]["server_status"]; + empire: components["schemas"]["empire_status"]; }; }; }; @@ -23780,7 +25922,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/foodreserve/demolish": { + "/v2/empire/view_profile": { parameters: { query?: never; header?: never; @@ -23789,6 +25931,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View the editable empire profile. + * @description Provides a list of the editable properties of the current empire's profile. See also the edit_profile and view_public_profile methods. + */ post: { parameters: { query?: never; @@ -23796,15 +25942,9 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; + requestBody?: never; responses: { - /** @description Instantly destroys a building. */ + /** @description Provides a list of the editable properties of the current empire's profile. See also the edit_profile and view_public_profile methods. */ 200: { headers: { [name: string]: unknown; @@ -23814,12 +25954,57 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + profile: { + description: string; + status_message: string; + /** @description Keyed by medal id. */ + medals: { + [key: string]: { + name: string; + image: string; + date: string; + /** @enum {integer} */ + public: 1 | 0; + times_earned: number; + }; + }; + city: string; + country: string; + notes: string; + skype: string; + player_name: string; + /** @enum {integer} */ + skip_happiness_warnings: 1 | 0; + /** @enum {integer} */ + skip_resource_warnings: 1 | 0; + /** @enum {integer} */ + skip_pollution_warnings: 1 | 0; + /** @enum {integer} */ + skip_medal_messages: 1 | 0; + /** @enum {integer} */ + skip_found_nothing: 1 | 0; + /** @enum {integer} */ + skip_excavator_resources: 1 | 0; + /** @enum {integer} */ + skip_excavator_glyph: 1 | 0; + /** @enum {integer} */ + skip_excavator_plan: 1 | 0; + /** @enum {integer} */ + skip_spy_recovery: 1 | 0; + /** @enum {integer} */ + skip_probe_detected: 1 | 0; + /** @enum {integer} */ + skip_attack_messages: 1 | 0; + /** @enum {integer} */ + skip_incoming_ships: 1 | 0; + email: string; + sitter_password: string; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -23841,7 +26026,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/foodreserve/repair": { + "/v2/empire/edit_profile": { parameters: { query?: never; header?: never; @@ -23850,6 +26035,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Edit the empire profile. + * @description Edits properties of an empire. Returns the same payload as view_profile. Only the properties present in the request are updated. Throws 1005 and 1009. + */ post: { parameters: { query?: never; @@ -23860,12 +26049,94 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The properties to be edited. Set one or all of them — only those set will be updated. */ + profile: { + /** @description A description of the empire. Limited to 1024 characters and cannot contain < or >. */ + description?: string; + /** @description A message to indicate what you're doing, how you're feeling, or other status indicator. Limited to 100 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ + status_message?: string; + /** @description The ids of the medals the user wishes to display in the public profile. */ + public_medals?: number[]; + /** @description The city in which the player resides. Limited to 100 characters and cannot contain @, &, <, >, or ;. */ + city?: string; + /** @description The country in which the player resides. Limited to 100 characters and cannot contain @, &, <, >, or ;. */ + country?: string; + /** @description A text blob where the user can write down whatever they want to store in their account. Limited to 1024 characters and cannot contain @, &, <, >, or ;. */ + notes?: string; + /** @description The username this player uses on Skype. Limited to 100 characters and cannot contain @, &, <, >, or ;. */ + skype?: string; + /** @description The real name or online identity of this player. Limited to 100 characters and cannot contain @, &, <, >, or ;. */ + player_name?: string; + /** + * @description Defaults to 0. Set to 1 to stop receiving messages about unhappy citizens. WARNING: these messages are there for your own protection — turn them off at your own risk. + * @enum {integer} + */ + skip_happiness_warnings?: 1 | 0; + /** + * @description Defaults to 0. Set to 1 to stop receiving messages about a lack of resources to keep buildings running. WARNING: these messages are there for your own protection — turn them off at your own risk. + * @enum {integer} + */ + skip_resource_warnings?: 1 | 0; + /** + * @description Defaults to 0. Set to 1 to stop receiving messages about excess waste causing pollution. WARNING: these messages are there for your own protection — turn them off at your own risk. + * @enum {integer} + */ + skip_pollution_warnings?: 1 | 0; + /** + * @description Defaults to 0. Set to 1 to stop receiving messages about the medals they've earned. + * @enum {integer} + */ + skip_medal_messages?: 1 | 0; + /** + * @description Defaults to 0. Set to 1 to stop receiving messages when excavators find nothing. + * @enum {integer} + */ + skip_found_nothing?: 1 | 0; + /** + * @description Defaults to 0. Set to 1 to stop receiving messages when excavators find resources. + * @enum {integer} + */ + skip_excavator_resources?: 1 | 0; + /** + * @description Defaults to 0. Set to 1 to stop receiving messages when excavators find glyphs. + * @enum {integer} + */ + skip_excavator_glyph?: 1 | 0; + /** + * @description Defaults to 0. Set to 1 to stop receiving messages when excavators find plans. + * @enum {integer} + */ + skip_excavator_plan?: 1 | 0; + /** + * @description Defaults to 0. Set to 1 to stop receiving spy recovery messages ("I'm ready to work. What do you need from me?"). + * @enum {integer} + */ + skip_spy_recovery?: 1 | 0; + /** + * @description Defaults to 0. Set to 1 to stop receiving messages when a probe is detected. + * @enum {integer} + */ + skip_probe_detected?: 1 | 0; + /** + * @description Defaults to 0. Set to 1 to stop receiving messages about attacks. + * @enum {integer} + */ + skip_attack_messages?: 1 | 0; + /** + * @description Controls the display of incoming ships (own, allied, foreign) on the map display. Defaults to 0, which shows them. Set to 1 to hide them, which can improve browser responsiveness. + * @enum {integer} + */ + skip_incoming_ships?: 1 | 0; + /** @description An email address that can be used for system functions like password recovery. Must either resemble an email address or be empty. */ + email?: string; + /** @description A password that can be safely given to account sitters and alliance members. Must be between 6 and 30 characters. */ + sitter_password?: string; + }; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Edits properties of an empire. Returns the same payload as view_profile. Only the properties present in the request are updated. See also the view_profile and view_public_profile methods. Throws 1005 and 1009. */ 200: { headers: { [name: string]: unknown; @@ -23875,13 +26146,57 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + profile: { + description: string; + status_message: string; + /** @description Keyed by medal id. */ + medals: { + [key: string]: { + name: string; + image: string; + date: string; + /** @enum {integer} */ + public: 1 | 0; + times_earned: number; + }; + }; + city: string; + country: string; + notes: string; + skype: string; + player_name: string; + /** @enum {integer} */ + skip_happiness_warnings: 1 | 0; + /** @enum {integer} */ + skip_resource_warnings: 1 | 0; + /** @enum {integer} */ + skip_pollution_warnings: 1 | 0; + /** @enum {integer} */ + skip_medal_messages: 1 | 0; + /** @enum {integer} */ + skip_found_nothing: 1 | 0; + /** @enum {integer} */ + skip_excavator_resources: 1 | 0; + /** @enum {integer} */ + skip_excavator_glyph: 1 | 0; + /** @enum {integer} */ + skip_excavator_plan: 1 | 0; + /** @enum {integer} */ + skip_spy_recovery: 1 | 0; + /** @enum {integer} */ + skip_probe_detected: 1 | 0; + /** @enum {integer} */ + skip_attack_messages: 1 | 0; + /** @enum {integer} */ + skip_incoming_ships: 1 | 0; + email: string; + sitter_password: string; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -23903,7 +26218,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/foodreserve/get_stats_for_level": { + "/v2/empire/view_public_profile": { parameters: { query?: never; header?: never; @@ -23912,6 +26227,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View another empire's public profile. + * @description Provides a list of the data that is publicly known about an empire. Throws 1002. + */ post: { parameters: { query?: never; @@ -23922,13 +26241,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - level: number; + /** @description The id of the empire for which you'd like to retrieve the public profile. */ + empire_id: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Provides a list of the data that's publicly known about this empire. Throws 1002. */ 200: { headers: { [name: string]: unknown; @@ -23938,27 +26257,74 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { + profile: { + city: string; + description: string; + /** @description Keyed by medal id. */ + medals: { + [key: string]: { + name: string; + image: string; + date: string; + /** @enum {integer} */ + public: 1 | 0; + times_earned: number; + }; + }; + player_name: string; id: number; + skype: string; name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; + species: string; + country: string; + date_founded: string; + known_colonies: { + type: string; + id: number; + star_name: string; + ore?: { + methane: number; + fluorite: number; + beryl: number; + goethite: number; + gold: number; + chalcopyrite: number; + anthracite: number; + bauxite: number; + galena: number; + monazite: number; + trona: number; + halite: number; + uraninite: number; + zircon: number; + chromite: number; + kerogen: number; + rutile: number; + magnetite: number; + sulfur: number; + gypsum: number; + }; + homeworld: number; + x: number; + size: number; + star_id: number; + name: string; + empire?: { + name: string; + is_isolationist: number; + id: number; + alignment: string; + }; + orbit: number; + zone: string; + y: number; image: string; - }; + notes: string; + water: number; + }[]; + status_message: string; + last_login: string; + colony_count: number; }; status: { server: components["schemas"]["server_status"]; @@ -23986,7 +26352,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/foodreserve/view": { + "/v2/empire/send_password_reset_message": { parameters: { query?: never; header?: never; @@ -23995,6 +26361,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Start a password recovery. + * @description Starts a password recovery process by sending an email with a recovery key. Identify the empire by exactly one of empire_id, empire_name, or email. + */ post: { parameters: { query?: never; @@ -24005,12 +26375,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The unique id of the empire to recover. Choose one of empire_id, empire_name, or email. */ + empire_id?: number; + /** @description The full name of the empire. Choose one of empire_id, empire_name, or email. */ + empire_name?: string; + /** @description The email address associated with an empire. Choose one of empire_id, empire_name, or email. */ + email?: string; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Starts a password recovery process by sending an email with a recovery key. Identify the empire by exactly one of empire_id, empire_name, or email. */ 200: { headers: { [name: string]: unknown; @@ -24020,16 +26395,8 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - /** @description Keyed by food type, e.g. apple, bread, algae. */ - food_stored?: { - [key: string]: number; - }; + /** @enum {integer} */ + sent: 1; }; }; }; @@ -24051,7 +26418,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/foodreserve/dump": { + "/v2/empire/reset_password": { parameters: { query?: never; header?: never; @@ -24060,6 +26427,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Reset a forgotten password. + * @description Changes an empire password that has been forgotten, using the key emailed by send_password_reset_message. Returns the same response as login if successful. + */ post: { parameters: { query?: never; @@ -24070,15 +26441,19 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - /** @description Food type to convert into waste, e.g. apple, corn, burger. */ - type: string; - amount: number; + /** @description A key that was emailed to the user via the send_password_reset_message method. */ + reset_key: number; + /** @description The password to log in to the empire. Must be between 6 and 30 characters. */ + password1: string; + /** @description Retyping the password again. This must match password1 to succeed. */ + password2: string; + /** @description Your client's unique API key, identifying it from all other clients. See ApiKeys for details. */ + api_key: string; }; }; }; responses: { - /** @description Converts food into waste. */ + /** @description Change the empire password that has been forgotten. Returns the same response as `login` if successful. */ 200: { headers: { [name: string]: unknown; @@ -24088,6 +26463,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + session_id: string; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -24114,7 +26490,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fusion/build": { + "/v2/empire/change_password": { parameters: { query?: never; header?: never; @@ -24123,6 +26499,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Change the empire password. + * @description Changes the empire password. + */ post: { parameters: { query?: never; @@ -24133,14 +26513,15 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The password to log in to the empire. Must be between 6 and 30 characters. */ + password1: string; + /** @description Retyping the password again. This must match password1 to succeed. */ + password2: string; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Change the empire password. */ 200: { headers: { [name: string]: unknown; @@ -24150,21 +26531,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -24186,7 +26557,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fusion/upgrade": { + "/v2/empire/find": { parameters: { query?: never; header?: never; @@ -24195,6 +26566,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Find empires by name. + * @description Finds empires by name. Returns a hash reference containing empire ids and empire names. + */ post: { parameters: { query?: never; @@ -24205,12 +26580,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The name you're searching for. Case insensitive, and partial names work fine. Must be at least 3 characters. */ + name: string; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Find an empire by name. Returns a hash reference containing empire ids and empire names. */ 200: { headers: { [name: string]: unknown; @@ -24220,21 +26596,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { + empires: { id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + name: string; + }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -24256,7 +26626,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fusion/downgrade": { + "/v2/empire/set_status_message": { parameters: { query?: never; header?: never; @@ -24265,6 +26635,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Set the empire status message. + * @description Sets the empire status message, similar to what you might put on your social media updates, but about your empire. + */ post: { parameters: { query?: never; @@ -24275,12 +26649,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description A message to indicate what you're doing, how you're feeling, or other status indicator. Limited to 100 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ + message: string; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Sets the empire status message. Similar to what you might put on your social media updates, but about your empire. */ 200: { headers: { [name: string]: unknown; @@ -24290,13 +26665,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -24318,7 +26691,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fusion/demolish": { + "/v2/empire/view_boosts": { parameters: { query?: never; header?: never; @@ -24327,6 +26700,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View boost expiry dates. + * @description Shows the dates at which boosts have expired or will expire. Boosts are subsidies applied to various resources using essentia. + */ post: { parameters: { query?: never; @@ -24334,15 +26711,9 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; + requestBody?: never; responses: { - /** @description Instantly destroys a building. */ + /** @description Shows the dates at which boosts have expired or will expire. Boosts are subsidies applied to various resources using essentia. */ 200: { headers: { [name: string]: unknown; @@ -24352,12 +26723,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + boosts: { + spy_training: string; + ore: string; + water: string; + storage: string; + food: string; + happiness: string; + building: string; + energy: string; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -24379,7 +26759,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fusion/repair": { + "/v2/empire/boost_storage": { parameters: { query?: never; header?: never; @@ -24388,6 +26768,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Boost storage on all planets for a week. + * @description Spends 5 essentia and boosts storage (all 5 types) on all planets for 7 days. If a boost is already underway, calling again adds 7 more days. Throws 1011. + */ post: { parameters: { query?: never; @@ -24398,12 +26782,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description Optional. The number of 7 day boost periods to buy at once, at 5 essentia each. Defaults to 1. */ + weeks?: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Spends 5 essentia, and boosts storage (all 5 types) on all planets for 7 days. If a boost is already underway, calling again will add 7 more days. Throws 1011. */ 200: { headers: { [name: string]: unknown; @@ -24413,13 +26798,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + boosts: { + spy_training: string; + ore: string; + water: string; + storage: string; + food: string; + happiness: string; + building: string; + energy: string; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -24441,7 +26834,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fusion/get_stats_for_level": { + "/v2/empire/boost_food": { parameters: { query?: never; header?: never; @@ -24450,6 +26843,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Boost food production on all planets for a week. + * @description Spends 5 essentia and boosts food production on all planets for 7 days. If a boost is already underway, calling again adds 7 more days. Throws 1011. + */ post: { parameters: { query?: never; @@ -24460,13 +26857,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - level: number; + /** @description Optional. The number of 7 day boost periods to buy at once, at 5 essentia each. Defaults to 1. */ + weeks?: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Spends 5 essentia, and boosts food production on all planets for 7 days. If a boost is already underway, calling again will add 7 more days. Throws 1011. */ 200: { headers: { [name: string]: unknown; @@ -24476,27 +26873,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; + boosts: { + spy_training: string; + ore: string; + water: string; + storage: string; + food: string; + happiness: string; + building: string; + energy: string; }; status: { server: components["schemas"]["server_status"]; @@ -24524,7 +26909,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/fusion/view": { + "/v2/empire/boost_water": { parameters: { query?: never; header?: never; @@ -24533,6 +26918,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Boost water production on all planets for a week. + * @description Spends 5 essentia and boosts water production on all planets for 7 days. If a boost is already underway, calling again adds 7 more days. Throws 1011. + */ post: { parameters: { query?: never; @@ -24543,12 +26932,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description Optional. The number of 7 day boost periods to buy at once, at 5 essentia each. Defaults to 1. */ + weeks?: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Spends 5 essentia, and boosts water production on all planets for 7 days. If a boost is already underway, calling again will add 7 more days. Throws 1011. */ 200: { headers: { [name: string]: unknown; @@ -24558,7 +26948,16 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + boosts: { + spy_training: string; + ore: string; + water: string; + storage: string; + food: string; + happiness: string; + building: string; + energy: string; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -24585,7 +26984,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gasgiantlab/build": { + "/v2/empire/boost_energy": { parameters: { query?: never; header?: never; @@ -24594,6 +26993,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Boost energy production on all planets for a week. + * @description Spends 5 essentia and boosts energy production on all planets for 7 days. If a boost is already underway, calling again adds 7 more days. Throws 1011. + */ post: { parameters: { query?: never; @@ -24604,14 +27007,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description Optional. The number of 7 day boost periods to buy at once, at 5 essentia each. Defaults to 1. */ + weeks?: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Spends 5 essentia, and boosts energy production on all planets for 7 days. If a boost is already underway, calling again will add 7 more days. Throws 1011. */ 200: { headers: { [name: string]: unknown; @@ -24621,21 +27023,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; + boosts: { + spy_training: string; + ore: string; + water: string; + storage: string; + food: string; + happiness: string; + building: string; + energy: string; }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -24657,7 +27059,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gasgiantlab/upgrade": { + "/v2/empire/boost_ore": { parameters: { query?: never; header?: never; @@ -24666,6 +27068,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Boost ore production on all planets for a week. + * @description Spends 5 essentia and boosts ore production on all planets for 7 days. If a boost is already underway, calling again adds 7 more days. Throws 1011. + */ post: { parameters: { query?: never; @@ -24676,12 +27082,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description Optional. The number of 7 day boost periods to buy at once, at 5 essentia each. Defaults to 1. */ + weeks?: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Spends 5 essentia, and boosts ore production on all planets for 7 days. If a boost is already underway, calling again will add 7 more days. Throws 1011. */ 200: { headers: { [name: string]: unknown; @@ -24691,21 +27098,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; + boosts: { + spy_training: string; + ore: string; + water: string; + storage: string; + food: string; + happiness: string; + building: string; + energy: string; }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -24727,7 +27134,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gasgiantlab/downgrade": { + "/v2/empire/boost_happiness": { parameters: { query?: never; header?: never; @@ -24736,6 +27143,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Boost happiness production on all planets for a week. + * @description Spends 5 essentia and boosts happiness production on all planets for 7 days. If a boost is already underway, calling again adds 7 more days. Throws 1011. + */ post: { parameters: { query?: never; @@ -24746,12 +27157,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description Optional. The number of 7 day boost periods to buy at once, at 5 essentia each. Defaults to 1. */ + weeks?: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Spends 5 essentia, and boosts happiness production on all planets for 7 days. If a boost is already underway, calling again will add 7 more days. Throws 1011. */ 200: { headers: { [name: string]: unknown; @@ -24761,74 +27173,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; + boosts: { + spy_training: string; + ore: string; + water: string; + storage: string; + food: string; + happiness: string; + building: string; + energy: string; }; - buildings: components["schemas"]["buildings_list"]; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/gasgiantlab/demolish": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; - responses: { - /** @description Instantly destroys a building. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -24850,7 +27209,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gasgiantlab/repair": { + "/v2/empire/boost_building": { parameters: { query?: never; header?: never; @@ -24859,6 +27218,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Boost build queues on all planets for a week. + * @description Spends 5 essentia and boosts build queues on all planets for 7 days. If a boost is already underway, calling again adds 7 more days. It does not speed up builds already under way, only new builds added to a queue. Throws 1011. + */ post: { parameters: { query?: never; @@ -24869,12 +27232,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description Optional. The number of 7 day boost periods to buy at once, at 5 essentia each. Defaults to 1. */ + weeks?: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Spends 5 essentia, and boosts build queues on all planets for 7 days. If a boost is already underway, calling again will add 7 more days. It will not boost builds already under way, only new builds added to a build queue. Throws 1011. */ 200: { headers: { [name: string]: unknown; @@ -24884,13 +27248,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + boosts: { + spy_training: string; + ore: string; + water: string; + storage: string; + food: string; + happiness: string; + building: string; + energy: string; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -24912,7 +27284,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gasgiantlab/get_stats_for_level": { + "/v2/empire/boost_spy_training": { parameters: { query?: never; header?: never; @@ -24921,6 +27293,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Boost spy training on all planets for a week. + * @description Spends 5 essentia and boosts spy training speed on all planets by 50% for 7 days. If a boost is already underway, calling again adds 7 more days. Unlike the other boosts, this one also speeds up spies already in specialist training. Throws 1011. + */ post: { parameters: { query?: never; @@ -24931,13 +27307,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - level: number; + /** @description Optional. The number of 7 day boost periods to buy at once, at 5 essentia each. Defaults to 1. */ + weeks?: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Spends 5 essentia, and boosts spy training speed on all planets by 50% for 7 days. If a boost is already underway, calling again will add 7 more days. Unlike the other boosts, this one also boosts spies already in specialist training. Throws 1011. */ 200: { headers: { [name: string]: unknown; @@ -24947,27 +27323,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; + boosts: { + spy_training: string; + ore: string; + water: string; + storage: string; + food: string; + happiness: string; + building: string; + energy: string; }; status: { server: components["schemas"]["server_status"]; @@ -24995,7 +27359,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gasgiantlab/view": { + "/v2/empire/enable_self_destruct": { parameters: { query?: never; header?: never; @@ -25004,6 +27368,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Start the self destruct countdown. + * @description Enables a destruction countdown of 24 hours. Sometime after the timer runs out, the empire will vaporize. + */ post: { parameters: { query?: never; @@ -25011,15 +27379,9 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; + requestBody?: never; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Enables a destruction countdown of 24 hours. Sometime after the timer runs out, the empire will vaporize. */ 200: { headers: { [name: string]: unknown; @@ -25029,7 +27391,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -25056,7 +27417,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gasgiantplatform/build": { + "/v2/empire/disable_self_destruct": { parameters: { query?: never; header?: never; @@ -25065,6 +27426,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Cancel the self destruct countdown. + * @description Disables the self destruction countdown. + */ post: { parameters: { query?: never; @@ -25072,17 +27437,9 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - body_id: number; - x: number; - y: number; - }; - }; - }; + requestBody?: never; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Disables the self destruction countdown. */ 200: { headers: { [name: string]: unknown; @@ -25092,21 +27449,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -25128,7 +27475,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gasgiantplatform/upgrade": { + "/v2/empire/redeem_essentia_code": { parameters: { query?: never; header?: never; @@ -25137,6 +27484,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Redeem an essentia code. + * @description Redeems an essentia code and applies the essentia to the empire's balance. + */ post: { parameters: { query?: never; @@ -25147,12 +27498,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description A 36 character string that was sent to the user via email. */ + code: string; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Redeems an essentia code and applies the essentia to the empire's balance. */ 200: { headers: { [name: string]: unknown; @@ -25162,21 +27514,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + amount: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -25198,7 +27541,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gasgiantplatform/downgrade": { + "/v2/empire/update_species": { parameters: { query?: never; header?: never; @@ -25207,6 +27550,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Update the species before founding. + * @description Updates the empire's species and returns 1. Can only be called after create and before found; calling it outside that window throws an exception. Use redefine_species once the empire is founded. Throws 1000, 1002, 1005, 1007, 1008, 1009, and 1010; the error data carries the offending field name when the problem can be attributed to a single field. + */ post: { parameters: { query?: never; @@ -25217,12 +27564,46 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the empire you wish to update a species for. */ + empire_id: number; + /** @description The species definition. Every field except name and description is an integer, and those integers must add up to exactly 45. */ + params: { + /** @description The name of the species. Limited to 30 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ + name: string; + /** @description The species description. Limited to 1024 characters and cannot contain < or >. */ + description: string; + /** @description The closest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be less than or equal to max_orbit. */ + min_orbit: number; + /** @description The furthest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be greater than or equal to min_orbit. */ + max_orbit: number; + /** @description 7 is best. Determines advantages in manufactured goods, such as ships. */ + manufacturing_affinity: number; + /** @description 7 is best. Determines advantages in spying. */ + deception_affinity: number; + /** @description 7 is best. Determines advantages in upgrading buildings. */ + research_affinity: number; + /** @description 7 is best. Determines advantages in the speed of building. */ + management_affinity: number; + /** @description 7 is best. Determines advantages in food production. */ + farming_affinity: number; + /** @description 7 is best. Determines advantages in mineral production. */ + mining_affinity: number; + /** @description 7 is best. Determines advantages in energy, propulsion, and other technologies. */ + science_affinity: number; + /** @description 7 is best. Determines advantages in waste and water management. */ + environmental_affinity: number; + /** @description 7 is best. Determines advantages in managing population happiness. */ + political_affinity: number; + /** @description 7 is best. Determines advantages in freight handling. */ + trade_affinity: number; + /** @description 7 is best. Determines advantages in colonization. */ + growth_affinity: number; + }; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Updates the empire's species and returns 1. Can only be called after create and before found; calling it outside that window throws an exception. Use redefine_species for an empire that has already been founded, and see get_species_templates for ready-made starting points. Throws 1000, 1002, 1005, 1007, 1008, 1009, and 1010 — the error data names the field that needs adjusting whenever the problem can be attributed to a single field. */ 200: { headers: { [name: string]: unknown; @@ -25231,15 +27612,8 @@ export interface paths { "application/json": { id?: number; jsonrpc?: string; - result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; - }; + /** @enum {integer} */ + result?: 1; }; }; }; @@ -25260,7 +27634,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gasgiantplatform/demolish": { + "/v2/empire/redefine_species_limits": { parameters: { query?: never; header?: never; @@ -25269,6 +27643,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View the limits on redefining a species. + * @description Returns the extra limits placed on an empire that wants to redefine its species, including the essentia cost, the settable orbit range, the minimum growth affinity, and whether a redefinition is currently allowed. + */ post: { parameters: { query?: never; @@ -25276,15 +27654,9 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; + requestBody?: never; responses: { - /** @description Instantly destroys a building. */ + /** @description Returns the extra limits placed upon an empire that wants to redefine its species, including the essentia cost, the settable orbit range, the minimum growth affinity, and whether a redefinition is currently allowed at all. */ 200: { headers: { [name: string]: unknown; @@ -25294,12 +27666,18 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + essentia_cost: number; + max_orbit: number; + min_orbit: number; + min_growth: number; + /** @enum {integer} */ + can: 1 | 0; + reason?: string; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -25321,7 +27699,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gasgiantplatform/repair": { + "/v2/empire/redefine_species": { parameters: { query?: never; header?: never; @@ -25330,6 +27708,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Redefine the species after founding. + * @description Spends essentia to redefine the empire's species affinities, name, and description. Only usable after the empire is founded; use update_species during creation. Once done it cannot be redone for one month, so prompt the user before submitting. + */ post: { parameters: { query?: never; @@ -25340,12 +27722,44 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The species definition, same as the params of update_species. Every field except name and description is an integer, and those integers must add up to exactly 45. */ + params: { + /** @description The name of the species. Limited to 30 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ + name: string; + /** @description The species description. Limited to 1024 characters and cannot contain < or >. */ + description: string; + /** @description The closest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be less than or equal to max_orbit. */ + min_orbit: number; + /** @description The furthest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be greater than or equal to min_orbit. */ + max_orbit: number; + /** @description 7 is best. Determines advantages in manufactured goods, such as ships. */ + manufacturing_affinity: number; + /** @description 7 is best. Determines advantages in spying. */ + deception_affinity: number; + /** @description 7 is best. Determines advantages in upgrading buildings. */ + research_affinity: number; + /** @description 7 is best. Determines advantages in the speed of building. */ + management_affinity: number; + /** @description 7 is best. Determines advantages in food production. */ + farming_affinity: number; + /** @description 7 is best. Determines advantages in mineral production. */ + mining_affinity: number; + /** @description 7 is best. Determines advantages in energy, propulsion, and other technologies. */ + science_affinity: number; + /** @description 7 is best. Determines advantages in waste and water management. */ + environmental_affinity: number; + /** @description 7 is best. Determines advantages in managing population happiness. */ + political_affinity: number; + /** @description 7 is best. Determines advantages in freight handling. */ + trade_affinity: number; + /** @description 7 is best. Determines advantages in colonization. */ + growth_affinity: number; + }; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Spends essentia to redefine the empire's species affinities, name, and description. Only usable after the empire has been founded — use update_species during empire creation instead. See also redefine_species_limits. WARNING: once this is done it cannot be redone for 1 month, so make sure the user is aware and prompt them appropriately before submitting. */ 200: { headers: { [name: string]: unknown; @@ -25355,13 +27769,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -25383,7 +27795,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gasgiantplatform/get_stats_for_level": { + "/v2/empire/view_species_stats": { parameters: { query?: never; header?: never; @@ -25392,6 +27804,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View your species stats. + * @description Returns the stats associated with the empire's species as it was originally created. An empire can only view its own species stats through this method. + */ post: { parameters: { query?: never; @@ -25399,16 +27815,9 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - building_id: number; - level: number; - }; - }; - }; + requestBody?: never; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Returns the stats associated with the empire's species as it was originally created. An empire can only view its own species stats through this method. */ 200: { headers: { [name: string]: unknown; @@ -25418,27 +27827,37 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; + species: { + /** @description The name of the species. Limited to 30 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; + /** @description The species description. Limited to 1024 characters and cannot contain < or >. */ + description: string; + /** @description The closest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be less than or equal to max_orbit. */ + min_orbit: number; + /** @description The furthest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be greater than or equal to min_orbit. */ + max_orbit: number; + /** @description 7 is best. Determines advantages in manufactured goods, such as ships. */ + manufacturing_affinity: number; + /** @description 7 is best. Determines advantages in spying. */ + deception_affinity: number; + /** @description 7 is best. Determines advantages in upgrading buildings. */ + research_affinity: number; + /** @description 7 is best. Determines advantages in the speed of building. */ + management_affinity: number; + /** @description 7 is best. Determines advantages in food production. */ + farming_affinity: number; + /** @description 7 is best. Determines advantages in mineral production. */ + mining_affinity: number; + /** @description 7 is best. Determines advantages in energy, propulsion, and other technologies. */ + science_affinity: number; + /** @description 7 is best. Determines advantages in waste and water management. */ + environmental_affinity: number; + /** @description 7 is best. Determines advantages in managing population happiness. */ + political_affinity: number; + /** @description 7 is best. Determines advantages in freight handling. */ + trade_affinity: number; + /** @description 7 is best. Determines advantages in colonization. */ + growth_affinity: number; }; status: { server: components["schemas"]["server_status"]; @@ -25466,7 +27885,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gasgiantplatform/view": { + "/v2/empire/get_species_templates": { parameters: { query?: never; header?: never; @@ -25475,6 +27894,10 @@ export interface paths { }; get?: never; put?: never; + /** + * List species templates. + * @description Returns the list of species templates that can be used to help the user populate the form for update_species. + */ post: { parameters: { query?: never; @@ -25482,15 +27905,9 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; + requestBody?: never; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Returns the list of species templates that can be used to help the user populate the form for update_species. */ 200: { headers: { [name: string]: unknown; @@ -25500,13 +27917,37 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - }; + /** @description The name of the species. Limited to 30 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ + name: string; + /** @description The species description. Limited to 1024 characters and cannot contain < or >. */ + description: string; + /** @description The closest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be less than or equal to max_orbit. */ + min_orbit: number; + /** @description The furthest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be greater than or equal to min_orbit. */ + max_orbit: number; + /** @description 7 is best. Determines advantages in manufactured goods, such as ships. */ + manufacturing_affinity: number; + /** @description 7 is best. Determines advantages in spying. */ + deception_affinity: number; + /** @description 7 is best. Determines advantages in upgrading buildings. */ + research_affinity: number; + /** @description 7 is best. Determines advantages in the speed of building. */ + management_affinity: number; + /** @description 7 is best. Determines advantages in food production. */ + farming_affinity: number; + /** @description 7 is best. Determines advantages in mineral production. */ + mining_affinity: number; + /** @description 7 is best. Determines advantages in energy, propulsion, and other technologies. */ + science_affinity: number; + /** @description 7 is best. Determines advantages in waste and water management. */ + environmental_affinity: number; + /** @description 7 is best. Determines advantages in managing population happiness. */ + political_affinity: number; + /** @description 7 is best. Determines advantages in freight handling. */ + trade_affinity: number; + /** @description 7 is best. Determines advantages in colonization. */ + growth_affinity: number; + }[]; }; }; }; @@ -25527,7 +27968,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geneticslab/build": { + "/v2/empire/view_authorized_sitters": { parameters: { query?: never; header?: never; @@ -25536,6 +27977,10 @@ export interface paths { }; get?: never; put?: never; + /** + * List authorized sitters. + * @description Returns the empires currently authorized to sit for this account. + */ post: { parameters: { query?: never; @@ -25543,17 +27988,9 @@ export interface paths { path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - body_id: number; - x: number; - y: number; - }; - }; - }; + requestBody?: never; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Lists the empires currently authorized to sit for this empire. */ 200: { headers: { [name: string]: unknown; @@ -25563,21 +28000,16 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { + sitters: { id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + name: string; + expiry: string; + }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -25599,7 +28031,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geneticslab/upgrade": { + "/v2/empire/authorize_sitters": { parameters: { query?: never; header?: never; @@ -25608,6 +28040,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Authorize sitters for this account. + * @description Authorizes other empires to babysit this account. Each authorization is created if needed and granted for the full server-defined period. Returns the authorized sitters plus any rejected ids. + */ post: { parameters: { query?: never; @@ -25618,12 +28054,27 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** + * @description If true, all allies are automatically selected. + * @enum {integer} + */ + allied?: 1 | 0; + /** @description The name of another alliance, all of whom are automatically selected. */ + alliance?: string; + /** @description The id of another alliance, all of whom are automatically selected. */ + alliance_id?: number; + /** @description The ids and/or names of specific empires being authorized. */ + empires?: string[]; + /** + * @description A quick way of selecting all currently-authorized empires in order to extend their authorization period. + * @enum {integer} + */ + revalidate_all?: 1 | 0; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Authorizes other empires to babysit this account. Each authorization is created if needed and granted for the full server-defined period. Returns the same list as view_authorized_sitters, plus any ids that were rejected. */ 200: { headers: { [name: string]: unknown; @@ -25633,21 +28084,19 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { + auths: { id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + name: string; + }[]; + rejected_ids?: { + id: number; + reason: string; + }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -25669,7 +28118,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geneticslab/downgrade": { + "/v2/empire/deauthorize_sitters": { parameters: { query?: never; header?: never; @@ -25678,6 +28127,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Remove authorized sitters. + * @description Removes sitters from being permitted to sit this account. + */ post: { parameters: { query?: never; @@ -25688,12 +28141,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The ids (not names) of specific empires being removed. */ + empires: string[]; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Removes sitters from being permitted to sit this account. */ 200: { headers: { [name: string]: unknown; @@ -25703,13 +28157,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -25731,7 +28183,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geneticslab/demolish": { + "/v2/energyreserve/build": { parameters: { query?: never; header?: never; @@ -25740,6 +28192,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -25750,12 +28206,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -25765,6 +28226,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -25792,7 +28262,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geneticslab/repair": { + "/v2/energyreserve/upgrade": { parameters: { query?: never; header?: never; @@ -25801,6 +28271,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -25811,12 +28285,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -25826,7 +28301,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -25854,7 +28337,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geneticslab/get_stats_for_level": { + "/v2/energyreserve/downgrade": { parameters: { query?: never; header?: never; @@ -25863,6 +28346,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -25873,13 +28360,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -25889,33 +28376,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -25937,7 +28404,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geneticslab/view": { + "/v2/energyreserve/demolish": { parameters: { query?: never; header?: never; @@ -25946,6 +28413,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -25956,12 +28427,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -25971,12 +28443,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -25998,7 +28470,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geneticslab/prepare_experiment": { + "/v2/energyreserve/repair": { parameters: { query?: never; header?: never; @@ -26007,6 +28479,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -26017,12 +28493,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Returns everything needed to set up a genetic graft experiment. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -26032,59 +28509,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - grafts: { - /** @description The prisoner spy available to be experimented on. */ - spy: { - id: number; - name: string; - }; - species: { - /** @description The name of the species. Limited to 30 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ - name: string; - /** @description The species description. Limited to 1024 characters and cannot contain < or >. */ - description: string; - /** @description The closest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be less than or equal to max_orbit. */ - min_orbit: number; - /** @description The furthest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be greater than or equal to min_orbit. */ - max_orbit: number; - /** @description 7 is best. Determines advantages in manufactured goods, such as ships. */ - manufacturing_affinity: number; - /** @description 7 is best. Determines advantages in spying. */ - deception_affinity: number; - /** @description 7 is best. Determines advantages in upgrading buildings. */ - research_affinity: number; - /** @description 7 is best. Determines advantages in the speed of building. */ - management_affinity: number; - /** @description 7 is best. Determines advantages in food production. */ - farming_affinity: number; - /** @description 7 is best. Determines advantages in mineral production. */ - mining_affinity: number; - /** @description 7 is best. Determines advantages in energy, propulsion, and other technologies. */ - science_affinity: number; - /** @description 7 is best. Determines advantages in waste and water management. */ - environmental_affinity: number; - /** @description 7 is best. Determines advantages in managing population happiness. */ - political_affinity: number; - /** @description 7 is best. Determines advantages in freight handling. */ - trade_affinity: number; - /** @description 7 is best. Determines advantages in colonization. */ - growth_affinity: number; - }; - /** @description Names of the species attributes this prisoner's traits can be grafted onto. */ - graftable_affinities: string[]; - }[]; - /** @description Percent chance the prisoner survives the experiment. */ - survival_odds: number; - /** @description Percent chance the graft succeeds. */ - graft_odds: number; - essentia_cost: number; - /** @enum {integer} */ - can_experiment: 1 | 0; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -26106,7 +28537,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geneticslab/run_experiment": { + "/v2/energyreserve/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -26115,6 +28546,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -26125,15 +28560,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; - spy_id: number; - /** @description One of the prisoner's graftable_affinities to attempt to graft onto the species. */ - affinity: string; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Experiments on a prisoner, attempting to graft one of their genetic traits onto the empire species. Returns the same shape as prepare_experiment plus an experiment result. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -26143,72 +28578,33 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - grafts: { - /** @description The prisoner spy available to be experimented on. */ - spy: { - id: number; - name: string; - }; - species: { - /** @description The name of the species. Limited to 30 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ - name: string; - /** @description The species description. Limited to 1024 characters and cannot contain < or >. */ - description: string; - /** @description The closest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be less than or equal to max_orbit. */ - min_orbit: number; - /** @description The furthest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be greater than or equal to min_orbit. */ - max_orbit: number; - /** @description 7 is best. Determines advantages in manufactured goods, such as ships. */ - manufacturing_affinity: number; - /** @description 7 is best. Determines advantages in spying. */ - deception_affinity: number; - /** @description 7 is best. Determines advantages in upgrading buildings. */ - research_affinity: number; - /** @description 7 is best. Determines advantages in the speed of building. */ - management_affinity: number; - /** @description 7 is best. Determines advantages in food production. */ - farming_affinity: number; - /** @description 7 is best. Determines advantages in mineral production. */ - mining_affinity: number; - /** @description 7 is best. Determines advantages in energy, propulsion, and other technologies. */ - science_affinity: number; - /** @description 7 is best. Determines advantages in waste and water management. */ - environmental_affinity: number; - /** @description 7 is best. Determines advantages in managing population happiness. */ - political_affinity: number; - /** @description 7 is best. Determines advantages in freight handling. */ - trade_affinity: number; - /** @description 7 is best. Determines advantages in colonization. */ - growth_affinity: number; - }; - /** @description Names of the species attributes this prisoner's traits can be grafted onto. */ - graftable_affinities: string[]; - }[]; - /** @description Percent chance the prisoner survives the experiment. */ - survival_odds: number; - /** @description Percent chance the graft succeeds. */ - graft_odds: number; - essentia_cost: number; - /** @enum {integer} */ - can_experiment: 1 | 0; - experiment: { - /** - * @description Whether the graft succeeded. - * @enum {integer} - */ - graft: 1 | 0; - /** - * @description Whether the prisoner survived. - * @enum {integer} - */ - survive: 1 | 0; - message: string; - }; }; }; }; @@ -26230,7 +28626,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geneticslab/rename_species": { + "/v2/energyreserve/view": { parameters: { query?: never; header?: never; @@ -26239,6 +28635,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -26249,18 +28649,81 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; - params: { - /** @description The empire's new species name. Limited to 30 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ - name: string; - /** @description The species' description. Limited to 1024 characters, cannot contain < or >. */ - description?: string; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; }; }; }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/energyreserve/dump": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Dump energy as waste. + * @description Converts energy into waste. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description The amount of energy to dump. */ + amount: number; + }; + }; }; responses: { - /** @description Updates the empire's species name and description. Can throw error codes 1000 (name not available) and 1005 (contains invalid characters), with the offending field in the error's data. */ + /** @description Converts energy into waste. */ 200: { headers: { [name: string]: unknown; @@ -26270,7 +28733,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - success: string; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; }; }; }; @@ -26292,7 +28759,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geo/build": { + "/v2/entertainment/build": { parameters: { query?: never; header?: never; @@ -26301,6 +28768,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -26311,8 +28782,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -26364,7 +28838,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geo/upgrade": { + "/v2/entertainment/upgrade": { parameters: { query?: never; header?: never; @@ -26373,6 +28847,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -26383,6 +28861,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -26434,7 +28913,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geo/downgrade": { + "/v2/entertainment/downgrade": { parameters: { query?: never; header?: never; @@ -26443,6 +28922,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -26453,6 +28936,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -26496,7 +28980,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geo/demolish": { + "/v2/entertainment/demolish": { parameters: { query?: never; header?: never; @@ -26505,6 +28989,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -26515,6 +29003,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -26557,7 +29046,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geo/repair": { + "/v2/entertainment/repair": { parameters: { query?: never; header?: never; @@ -26566,6 +29055,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -26576,6 +29069,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -26619,7 +29113,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geo/get_stats_for_level": { + "/v2/entertainment/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -26628,6 +29122,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -26638,7 +29136,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -26702,7 +29202,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geo/view": { + "/v2/entertainment/view": { parameters: { query?: never; header?: never; @@ -26711,6 +29211,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -26721,6 +29225,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -26742,6 +29247,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + ducks_quacked: number; }; }; }; @@ -26763,7 +29269,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geothermalvent/build": { + "/v2/entertainment/get_lottery_voting_options": { parameters: { query?: never; header?: never; @@ -26772,6 +29278,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get lottery voting options. + * @description Returns a list of sites the user can vote on. Voting once per site per day enters the empire into a daily lottery for 10 essentia; each vote is equal, but more votes increase the odds of winning. Each url is usable only once every 24 hours. + */ post: { parameters: { query?: never; @@ -26782,14 +29292,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Returns a list of sites the user can vote on. Voting once per site per day enters the empire into a daily lottery for 10 essentia; each vote is equal, but more votes increase the odds of winning. Each url is usable only once every 24 hours. */ 200: { headers: { [name: string]: unknown; @@ -26799,21 +29308,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + options: { + name: string; + url: string; + }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -26835,7 +29338,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geothermalvent/upgrade": { + "/v2/entertainment/duck_quack": { parameters: { query?: never; header?: never; @@ -26844,6 +29347,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Duck quack. + * @description Returns a fun string of quack text. Formatting (whitespace and carriage returns) must be preserved when displayed to the user. + */ post: { parameters: { query?: never; @@ -26854,6 +29361,152 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Returns a fun string of quack text. Formatting (whitespace and carriage returns) must be preserved when displayed to the user. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + quack: string; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/espionage/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/espionage/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -26905,7 +29558,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geothermalvent/downgrade": { + "/v2/espionage/downgrade": { parameters: { query?: never; header?: never; @@ -26914,6 +29567,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -26924,6 +29581,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -26967,7 +29625,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geothermalvent/demolish": { + "/v2/espionage/demolish": { parameters: { query?: never; header?: never; @@ -26976,6 +29634,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -26986,6 +29648,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -27028,7 +29691,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geothermalvent/repair": { + "/v2/espionage/repair": { parameters: { query?: never; header?: never; @@ -27037,6 +29700,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -27047,6 +29714,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -27090,7 +29758,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geothermalvent/get_stats_for_level": { + "/v2/espionage/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -27099,6 +29767,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -27109,7 +29781,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -27173,7 +29847,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/geothermalvent/view": { + "/v2/espionage/view": { parameters: { query?: never; header?: never; @@ -27182,6 +29856,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -27192,6 +29870,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -27234,7 +29913,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gratchsgauntlet/build": { + "/v2/essentiavein/build": { parameters: { query?: never; header?: never; @@ -27243,6 +29922,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -27253,8 +29936,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -27306,7 +29992,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gratchsgauntlet/upgrade": { + "/v2/essentiavein/upgrade": { parameters: { query?: never; header?: never; @@ -27315,6 +30001,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -27325,6 +30015,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -27376,7 +30067,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gratchsgauntlet/downgrade": { + "/v2/essentiavein/downgrade": { parameters: { query?: never; header?: never; @@ -27385,6 +30076,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -27395,6 +30090,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -27438,7 +30134,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gratchsgauntlet/demolish": { + "/v2/essentiavein/demolish": { parameters: { query?: never; header?: never; @@ -27447,6 +30143,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -27457,6 +30157,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -27499,7 +30200,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gratchsgauntlet/repair": { + "/v2/essentiavein/repair": { parameters: { query?: never; header?: never; @@ -27508,6 +30209,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -27518,6 +30223,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -27561,7 +30267,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gratchsgauntlet/get_stats_for_level": { + "/v2/essentiavein/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -27570,6 +30276,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -27580,7 +30290,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -27644,7 +30356,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gratchsgauntlet/view": { + "/v2/essentiavein/view": { parameters: { query?: never; header?: never; @@ -27653,6 +30365,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -27663,6 +30379,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -27684,6 +30401,8 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + /** @description How many groups of 30 days can be drained. E.g. 3 means 90-119 days remaining. */ + drain_capable?: number; }; }; }; @@ -27705,7 +30424,74 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/greatballofjunk/build": { + "/v2/essentiavein/drain": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Drain essentia from the vein. + * @description Instantly drains one or more 30-day periods of essentia from the vein. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description Number of 30-day periods to drain in a single RPC. Instead of 4 essentia/day over 30 days, each period instantly provides 30 essentia. Defaults to 1. Periods less than 30 days can't be drained quickly. */ + times?: number; + }; + }; + }; + responses: { + /** @description Instantly drains one or more 30-day periods of essentia from the vein. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/fission/build": { parameters: { query?: never; header?: never; @@ -27714,6 +30500,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -27724,8 +30514,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -27777,7 +30570,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/greatballofjunk/upgrade": { + "/v2/fission/upgrade": { parameters: { query?: never; header?: never; @@ -27786,6 +30579,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -27796,6 +30593,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -27847,7 +30645,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/greatballofjunk/downgrade": { + "/v2/fission/downgrade": { parameters: { query?: never; header?: never; @@ -27856,6 +30654,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -27866,6 +30668,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -27909,7 +30712,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/greatballofjunk/demolish": { + "/v2/fission/demolish": { parameters: { query?: never; header?: never; @@ -27918,6 +30721,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -27928,6 +30735,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -27970,7 +30778,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/greatballofjunk/repair": { + "/v2/fission/repair": { parameters: { query?: never; header?: never; @@ -27979,6 +30787,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -27989,6 +30801,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -28032,7 +30845,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/greatballofjunk/get_stats_for_level": { + "/v2/fission/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -28041,6 +30854,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -28051,7 +30868,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -28115,7 +30934,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/greatballofjunk/view": { + "/v2/fission/view": { parameters: { query?: never; header?: never; @@ -28124,6 +30943,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -28134,6 +30957,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -28176,7 +31000,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/grove/build": { + "/v2/fissure/build": { parameters: { query?: never; header?: never; @@ -28185,6 +31009,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -28195,8 +31023,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -28248,7 +31079,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/grove/upgrade": { + "/v2/fissure/upgrade": { parameters: { query?: never; header?: never; @@ -28257,6 +31088,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -28267,6 +31102,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -28318,7 +31154,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/grove/downgrade": { + "/v2/fissure/downgrade": { parameters: { query?: never; header?: never; @@ -28327,6 +31163,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -28337,6 +31177,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -28380,7 +31221,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/grove/demolish": { + "/v2/fissure/demolish": { parameters: { query?: never; header?: never; @@ -28389,6 +31230,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -28399,6 +31244,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -28441,7 +31287,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/grove/repair": { + "/v2/fissure/repair": { parameters: { query?: never; header?: never; @@ -28450,6 +31296,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -28460,6 +31310,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -28503,7 +31354,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/grove/get_stats_for_level": { + "/v2/fissure/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -28512,6 +31363,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -28522,7 +31377,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -28586,7 +31443,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/grove/view": { + "/v2/fissure/view": { parameters: { query?: never; header?: never; @@ -28595,6 +31452,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -28605,6 +31466,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -28647,7 +31509,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/hallsofvrbansk/build": { + "/v2/foodreserve/build": { parameters: { query?: never; header?: never; @@ -28656,6 +31518,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -28666,8 +31532,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -28719,7 +31588,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/hallsofvrbansk/upgrade": { + "/v2/foodreserve/upgrade": { parameters: { query?: never; header?: never; @@ -28728,6 +31597,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -28738,6 +31611,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -28789,7 +31663,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/hallsofvrbansk/downgrade": { + "/v2/foodreserve/downgrade": { parameters: { query?: never; header?: never; @@ -28798,6 +31672,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -28808,6 +31686,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -28851,7 +31730,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/hallsofvrbansk/demolish": { + "/v2/foodreserve/demolish": { parameters: { query?: never; header?: never; @@ -28860,6 +31739,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -28870,6 +31753,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -28912,7 +31796,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/hallsofvrbansk/repair": { + "/v2/foodreserve/repair": { parameters: { query?: never; header?: never; @@ -28921,6 +31805,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -28931,6 +31819,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -28974,7 +31863,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/hallsofvrbansk/get_stats_for_level": { + "/v2/foodreserve/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -28983,6 +31872,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -28993,7 +31886,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -29057,7 +31952,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/hallsofvrbansk/view": { + "/v2/foodreserve/view": { parameters: { query?: never; header?: never; @@ -29066,6 +31961,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -29076,6 +31975,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -29097,6 +31997,10 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + /** @description Keyed by food type, e.g. apple, bread, algae. */ + food_stored?: { + [key: string]: number; + }; }; }; }; @@ -29118,7 +32022,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/hydrocarbon/build": { + "/v2/foodreserve/dump": { parameters: { query?: never; header?: never; @@ -29127,6 +32031,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Dump food as waste. + * @description Converts food into waste. + */ post: { parameters: { query?: never; @@ -29137,8 +32045,80 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description Food type to convert into waste, e.g. apple, corn, burger. */ + type: string; + /** @description The amount to convert into waste. */ + amount: number; + }; + }; + }; + responses: { + /** @description Converts food into waste. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/fusion/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -29190,7 +32170,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/hydrocarbon/upgrade": { + "/v2/fusion/upgrade": { parameters: { query?: never; header?: never; @@ -29199,6 +32179,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -29209,6 +32193,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -29260,7 +32245,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/hydrocarbon/downgrade": { + "/v2/fusion/downgrade": { parameters: { query?: never; header?: never; @@ -29269,6 +32254,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -29279,6 +32268,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -29322,7 +32312,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/hydrocarbon/demolish": { + "/v2/fusion/demolish": { parameters: { query?: never; header?: never; @@ -29331,6 +32321,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -29341,6 +32335,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -29383,7 +32378,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/hydrocarbon/repair": { + "/v2/fusion/repair": { parameters: { query?: never; header?: never; @@ -29392,6 +32387,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -29402,6 +32401,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -29445,7 +32445,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/hydrocarbon/get_stats_for_level": { + "/v2/fusion/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -29454,6 +32454,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -29464,7 +32468,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -29528,7 +32534,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/hydrocarbon/view": { + "/v2/fusion/view": { parameters: { query?: never; header?: never; @@ -29537,6 +32543,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -29547,6 +32557,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -29589,7 +32600,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/ibs/view": { + "/v2/gasgiantlab/build": { parameters: { query?: never; header?: never; @@ -29598,6 +32609,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -29608,12 +32623,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Retrieves the properties of this module. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -29625,18 +32645,19 @@ export interface paths { result?: { building: { id: number; - name: string; - image: string; level: number; - x: number; - y: number; - efficiency: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -29658,7 +32679,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/inbox/view_inbox": { + "/v2/gasgiantlab/upgrade": { parameters: { query?: never; header?: never; @@ -29667,6 +32688,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -29677,16 +32702,13 @@ export interface paths { requestBody?: { content: { "application/json": { - options?: { - page_number?: number; - tags?: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; - empire?: string; - }; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Displays a list of the messages in the empire's inbox, 25 per page, newest to oldest. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -29696,27 +32718,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - messages: { + building: { id: number; - subject: string; - date: string; - from: string; - from_id: number; - to: string; - to_id: number; - /** @enum {integer} */ - has_read: 1 | 0; - /** @enum {integer} */ - has_replied: 1 | 0; - body_preview: string; - tags: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; - }[]; - message_count: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -29738,7 +32754,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/inbox/view_archived": { + "/v2/gasgiantlab/downgrade": { parameters: { query?: never; header?: never; @@ -29747,6 +32763,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -29757,16 +32777,13 @@ export interface paths { requestBody?: { content: { "application/json": { - options?: { - page_number?: number; - tags?: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; - empire?: string; - }; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Same as view_inbox, but shows archived messages. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -29776,27 +32793,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - messages: { - id: number; - subject: string; - date: string; - from: string; - from_id: number; - to: string; - to_id: number; - /** @enum {integer} */ - has_read: 1 | 0; - /** @enum {integer} */ - has_replied: 1 | 0; - body_preview: string; - tags: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; - }[]; - message_count: number; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -29818,7 +32821,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/inbox/view_trashed": { + "/v2/gasgiantlab/demolish": { parameters: { query?: never; header?: never; @@ -29827,6 +32830,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -29837,16 +32844,79 @@ export interface paths { requestBody?: { content: { "application/json": { - options?: { - page_number?: number; - tags?: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; - empire?: string; + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; }; }; }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gasgiantlab/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; }; responses: { - /** @description Same as view_inbox, but shows trashed messages. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -29856,27 +32926,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - messages: { - id: number; - subject: string; - date: string; - from: string; - from_id: number; - to: string; - to_id: number; - /** @enum {integer} */ - has_read: 1 | 0; - /** @enum {integer} */ - has_replied: 1 | 0; - body_preview: string; - tags: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; - }[]; - message_count: number; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -29898,7 +32954,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/inbox/view_sent": { + "/v2/gasgiantlab/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -29907,6 +32963,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -29917,16 +32977,15 @@ export interface paths { requestBody?: { content: { "application/json": { - options?: { - page_number?: number; - tags?: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; - empire?: string; - }; + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Same as view_inbox, but shows sent messages. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -29936,22 +32995,28 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - messages: { + building: { id: number; - subject: string; - date: string; - from: string; - from_id: number; - to: string; - to_id: number; - /** @enum {integer} */ - has_read: 1 | 0; - /** @enum {integer} */ - has_replied: 1 | 0; - body_preview: string; - tags: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; - }[]; - message_count: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -29978,7 +33043,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/inbox/view_unread": { + "/v2/gasgiantlab/view": { parameters: { query?: never; header?: never; @@ -29987,6 +33052,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -29997,16 +33066,13 @@ export interface paths { requestBody?: { content: { "application/json": { - options?: { - page_number?: number; - tags?: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; - empire?: string; - }; + /** @description The id of the building you wish to retrieve. */ + building_id: number; }; }; }; responses: { - /** @description Same as view_inbox, but shows only unread messages. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -30016,22 +33082,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - messages: { - id: number; - subject: string; - date: string; - from: string; - from_id: number; - to: string; - to_id: number; - /** @enum {integer} */ - has_read: 1 | 0; - /** @enum {integer} */ - has_replied: 1 | 0; - body_preview: string; - tags: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; - }[]; - message_count: number; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -30058,7 +33109,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/inbox/read_message": { + "/v2/gasgiantplatform/build": { parameters: { query?: never; header?: never; @@ -30067,6 +33118,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -30077,12 +33132,17 @@ export interface paths { requestBody?: { content: { "application/json": { - message_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Retrieves a message and marks it read if it was not already. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -30092,45 +33152,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - message: { + building: { id: number; - from: string; - from_id: number; - to: string; - to_id: number; - subject: string; - body: string; - date: string; - /** @enum {integer} */ - has_read: 1 | 0; - /** @enum {integer} */ - has_replied: 1 | 0; - /** @enum {integer} */ - has_archived: 1 | 0; - /** @enum {integer} */ - has_trashed: 1 | 0; - in_reply_to: number; - recipients: number[]; - tags: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; - attachments?: { - image?: { - url: string; - title: string; - link?: string; - }; - link?: { - url: string; - label: string; - }; - table?: string[][]; - map?: { - surface: string; - buildings: { - x: number; - y: number; - image: string; - }[]; - }; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; }; status: { @@ -30138,6 +33166,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -30159,7 +33188,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/inbox/archive_messages": { + "/v2/gasgiantplatform/upgrade": { parameters: { query?: never; header?: never; @@ -30168,6 +33197,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -30178,12 +33211,13 @@ export interface paths { requestBody?: { content: { "application/json": { - message_ids: number[]; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Archives a list of messages (marked as read in the process). Sent messages cannot be archived. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -30193,13 +33227,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - success: number[]; - failure: number[]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -30221,7 +33263,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/inbox/trash_messages": { + "/v2/gasgiantplatform/downgrade": { parameters: { query?: never; header?: never; @@ -30230,6 +33272,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -30240,12 +33286,13 @@ export interface paths { requestBody?: { content: { "application/json": { - message_ids: number[]; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Trashes a list of messages (marked as read in the process). Only messages sent to you can be trashed. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -30255,12 +33302,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - success: number[]; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -30282,7 +33330,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/inbox/trash_messages_where": { + "/v2/gasgiantplatform/demolish": { parameters: { query?: never; header?: never; @@ -30291,6 +33339,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -30301,18 +33353,13 @@ export interface paths { requestBody?: { content: { "application/json": { - spec: { - tags?: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; - /** @description Use % as a wildcard, e.g. "Pass:%". */ - subject?: string | string[]; - from?: string[]; - }[]; - return_ids?: boolean; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Trashes all messages matching every key of at least one spec entry (marked as read in the process). */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -30322,14 +33369,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - /** @description Only present when return_ids is true. */ - deleted?: number[]; - deleted_count: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -30351,7 +33396,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/inbox/send_message": { + "/v2/gasgiantplatform/repair": { parameters: { query?: never; header?: never; @@ -30360,6 +33405,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -30370,20 +33419,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description Comma separated empire names. "@ally" is a shortcut for all members of your alliance. */ - recipients: string; - subject: string; - body: string; - options?: { - in_reply_to?: number; - /** @description A message id whose attachments should be sent along with this message. */ - forward?: number; - }; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Sends a message to other players. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -30393,11 +33435,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -30419,7 +33463,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/intelligence/build": { + "/v2/gasgiantplatform/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -30428,6 +33472,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -30438,14 +33486,15 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -30457,11 +33506,24 @@ export interface paths { result?: { building: { id: number; + name: string; + image: string; level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; }; }; status: { @@ -30469,7 +33531,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -30491,7 +33552,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/intelligence/upgrade": { + "/v2/gasgiantplatform/view": { parameters: { query?: never; header?: never; @@ -30500,6 +33561,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -30510,12 +33575,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -30525,21 +33591,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -30561,7 +33618,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/intelligence/downgrade": { + "/v2/geneticslab/build": { parameters: { query?: never; header?: never; @@ -30570,6 +33627,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -30580,12 +33641,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -30595,7 +33661,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -30623,7 +33697,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/intelligence/demolish": { + "/v2/geneticslab/upgrade": { parameters: { query?: never; header?: never; @@ -30632,6 +33706,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -30642,12 +33720,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -30657,6 +33736,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -30684,7 +33772,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/intelligence/repair": { + "/v2/geneticslab/downgrade": { parameters: { query?: never; header?: never; @@ -30693,6 +33781,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -30703,12 +33795,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -30746,7 +33839,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/intelligence/get_stats_for_level": { + "/v2/geneticslab/demolish": { parameters: { query?: never; header?: never; @@ -30755,6 +33848,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -30765,13 +33862,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -30781,33 +33878,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -30829,7 +33905,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/intelligence/view": { + "/v2/geneticslab/repair": { parameters: { query?: never; header?: never; @@ -30838,6 +33914,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -30848,12 +33928,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -30869,12 +33950,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - spies?: { - maximum?: number; - current?: number; - in_training?: number; - training_costs?: components["schemas"]["building_cost"]; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -30896,7 +33972,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/intelligence/train_spy": { + "/v2/geneticslab/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -30905,6 +33981,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -30915,14 +33995,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; - /** @description Defaults to 1. */ - quantity?: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Queues spies for training. Throws 1013, 1009. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -30932,11 +34013,27 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - trained: number; - not_trained: number; - reason_not_trained?: { - code?: number; - message?: string; + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; }; status: { server: components["schemas"]["server_status"]; @@ -30964,7 +34061,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/intelligence/view_spies": { + "/v2/geneticslab/view": { parameters: { query?: never; header?: never; @@ -30973,6 +34070,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -30983,14 +34084,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; - /** @description Defaults to 1. 30 per page. */ - page_number?: number; }; }; }; responses: { - /** @description Retrieves a paginated spy roster. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -31000,47 +34100,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - spies: { - id: number; - name: string; - /** @enum {string} */ - assignment: "Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection"; - possible_assignments?: { - /** @enum {string} */ - task?: "Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection"; - recovery?: number; - skill?: string; - }[]; - level: number; - politics: number; - mayhem: number; - theft: number; - intel: number; - offense_rating?: number; - defense_rating?: number; - assigned_to?: { - body_id?: number; - name?: string; - x?: number; - y?: number; - }; - based_from?: { - body_id?: number; - name?: string; - x?: number; - y?: number; - }; - /** @enum {integer} */ - is_available: 1 | 0; - available_on?: string; - started_assignment?: string; - seconds_remaining?: number; - mission_count?: { - offensive?: number; - defensive?: number; - }; - }[]; - spy_count: number; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -31067,7 +34127,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/intelligence/view_all_spies": { + "/v2/geneticslab/prepare_experiment": { parameters: { query?: never; header?: never; @@ -31076,6 +34136,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Prepare experiment. + * @description Returns everything needed to set up a genetic graft experiment. + */ post: { parameters: { query?: never; @@ -31086,12 +34150,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the complete (non-paginated) spy roster. */ + /** @description Returns everything needed to set up a genetic graft experiment. */ 200: { headers: { [name: string]: unknown; @@ -31101,52 +34166,59 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - spies: { - id: number; - name: string; - /** @enum {string} */ - assignment: "Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection"; - possible_assignments?: { - /** @enum {string} */ - task?: "Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection"; - recovery?: number; - skill?: string; - }[]; - level: number; - politics: number; - mayhem: number; - theft: number; - intel: number; - offense_rating?: number; - defense_rating?: number; - assigned_to?: { - body_id?: number; - name?: string; - x?: number; - y?: number; - }; - based_from?: { - body_id?: number; - name?: string; - x?: number; - y?: number; - }; - /** @enum {integer} */ - is_available: 1 | 0; - available_on?: string; - started_assignment?: string; - seconds_remaining?: number; - mission_count?: { - offensive?: number; - defensive?: number; - }; - }[]; - spy_count: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + grafts: { + /** @description The prisoner spy available to be experimented on. */ + spy: { + id: number; + name: string; + }; + species: { + /** @description The name of the species. Limited to 30 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ + name: string; + /** @description The species description. Limited to 1024 characters and cannot contain < or >. */ + description: string; + /** @description The closest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be less than or equal to max_orbit. */ + min_orbit: number; + /** @description The furthest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be greater than or equal to min_orbit. */ + max_orbit: number; + /** @description 7 is best. Determines advantages in manufactured goods, such as ships. */ + manufacturing_affinity: number; + /** @description 7 is best. Determines advantages in spying. */ + deception_affinity: number; + /** @description 7 is best. Determines advantages in upgrading buildings. */ + research_affinity: number; + /** @description 7 is best. Determines advantages in the speed of building. */ + management_affinity: number; + /** @description 7 is best. Determines advantages in food production. */ + farming_affinity: number; + /** @description 7 is best. Determines advantages in mineral production. */ + mining_affinity: number; + /** @description 7 is best. Determines advantages in energy, propulsion, and other technologies. */ + science_affinity: number; + /** @description 7 is best. Determines advantages in waste and water management. */ + environmental_affinity: number; + /** @description 7 is best. Determines advantages in managing population happiness. */ + political_affinity: number; + /** @description 7 is best. Determines advantages in freight handling. */ + trade_affinity: number; + /** @description 7 is best. Determines advantages in colonization. */ + growth_affinity: number; + }; + /** @description Names of the species attributes this prisoner's traits can be grafted onto. */ + graftable_affinities: string[]; + }[]; + /** @description Percent chance the prisoner survives the experiment. */ + survival_odds: number; + /** @description Percent chance the graft succeeds. */ + graft_odds: number; + essentia_cost: number; + /** @enum {integer} */ + can_experiment: 1 | 0; }; }; }; @@ -31168,7 +34240,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/intelligence/subsidize_training": { + "/v2/geneticslab/run_experiment": { parameters: { query?: never; header?: never; @@ -31177,6 +34249,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Run experiment. + * @description Experiments on a prisoner, attempting to graft one of their genetic traits onto the empire species. Returns the same shape as prepare_experiment plus an experiment result. + */ post: { parameters: { query?: never; @@ -31187,12 +34263,17 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the spy. */ + spy_id: number; + /** @description One of the prisoner's graftable_affinities to attempt to graft onto the species. */ + affinity: string; }; }; }; responses: { - /** @description Completes all in-training spies immediately for 1 essentia per spy. Returns the building view. Throws 1011. */ + /** @description Experiments on a prisoner, attempting to graft one of their genetic traits onto the empire species. Returns the same shape as prepare_experiment plus an experiment result. */ 200: { headers: { [name: string]: unknown; @@ -31202,12 +34283,72 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + grafts: { + /** @description The prisoner spy available to be experimented on. */ + spy: { + id: number; + name: string; + }; + species: { + /** @description The name of the species. Limited to 30 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ + name: string; + /** @description The species description. Limited to 1024 characters and cannot contain < or >. */ + description: string; + /** @description The closest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be less than or equal to max_orbit. */ + min_orbit: number; + /** @description The furthest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be greater than or equal to min_orbit. */ + max_orbit: number; + /** @description 7 is best. Determines advantages in manufactured goods, such as ships. */ + manufacturing_affinity: number; + /** @description 7 is best. Determines advantages in spying. */ + deception_affinity: number; + /** @description 7 is best. Determines advantages in upgrading buildings. */ + research_affinity: number; + /** @description 7 is best. Determines advantages in the speed of building. */ + management_affinity: number; + /** @description 7 is best. Determines advantages in food production. */ + farming_affinity: number; + /** @description 7 is best. Determines advantages in mineral production. */ + mining_affinity: number; + /** @description 7 is best. Determines advantages in energy, propulsion, and other technologies. */ + science_affinity: number; + /** @description 7 is best. Determines advantages in waste and water management. */ + environmental_affinity: number; + /** @description 7 is best. Determines advantages in managing population happiness. */ + political_affinity: number; + /** @description 7 is best. Determines advantages in freight handling. */ + trade_affinity: number; + /** @description 7 is best. Determines advantages in colonization. */ + growth_affinity: number; + }; + /** @description Names of the species attributes this prisoner's traits can be grafted onto. */ + graftable_affinities: string[]; + }[]; + /** @description Percent chance the prisoner survives the experiment. */ + survival_odds: number; + /** @description Percent chance the graft succeeds. */ + graft_odds: number; + essentia_cost: number; + /** @enum {integer} */ + can_experiment: 1 | 0; + experiment: { + /** + * @description Whether the graft succeeded. + * @enum {integer} + */ + graft: 1 | 0; + /** + * @description Whether the prisoner survived. + * @enum {integer} + */ + survive: 1 | 0; + message: string; + }; }; }; }; @@ -31229,7 +34370,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/intelligence/burn_spy": { + "/v2/geneticslab/rename_species": { parameters: { query?: never; header?: never; @@ -31238,6 +34379,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Rename species. + * @description Updates the empire's species name and description. Can throw error codes 1000 (name not available) and 1005 (contains invalid characters), with the offending field in the error's data. + */ post: { parameters: { query?: never; @@ -31248,13 +34393,20 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - spy_id: number; + /** @description The species name and description to set. */ + params: { + /** @description The empire's new species name. Limited to 30 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ + name: string; + /** @description The species' description. Limited to 1024 characters, cannot contain < or >. */ + description?: string; + }; }; }; }; responses: { - /** @description Eliminates a spy from payroll. Throws 1002, 1010. */ + /** @description Updates the empire's species name and description. Can throw error codes 1000 (name not available) and 1005 (contains invalid characters), with the offending field in the error's data. */ 200: { headers: { [name: string]: unknown; @@ -31264,11 +34416,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; + success: string; }; }; }; @@ -31290,7 +34438,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/intelligence/name_spy": { + "/v2/geo/build": { parameters: { query?: never; header?: never; @@ -31299,6 +34447,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -31309,15 +34461,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - spy_id: number; - /** @description Cannot contain @, <, #, &, ; or profanity. */ - name: string; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Sets a spy's name. Throws 1002, 1005, 1013. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -31327,11 +34481,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -31353,7 +34517,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/intelligence/name_spies": { + "/v2/geo/upgrade": { parameters: { query?: never; header?: never; @@ -31362,6 +34526,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -31372,16 +34540,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - prefix?: string; - suffix?: string; - /** @description When true, only renames spies still named "Agent Null". */ - rename_null_only?: boolean; }; }; }; responses: { - /** @description Batch-names spies using the pattern "prefix ## suffix". */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -31391,53 +34556,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - spies: { + building: { id: number; - name: string; - /** @enum {string} */ - assignment: "Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection"; - possible_assignments?: { - /** @enum {string} */ - task?: "Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection"; - recovery?: number; - skill?: string; - }[]; level: number; - politics: number; - mayhem: number; - theft: number; - intel: number; - offense_rating?: number; - defense_rating?: number; - assigned_to?: { - body_id?: number; - name?: string; - x?: number; - y?: number; - }; - based_from?: { - body_id?: number; - name?: string; - x?: number; - y?: number; - }; - /** @enum {integer} */ - is_available: 1 | 0; - available_on?: string; - started_assignment?: string; - seconds_remaining?: number; - mission_count?: { - offensive?: number; - defensive?: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; - }[]; - spy_count: number; - renamed: number; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -31459,7 +34592,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/intelligence/assign_spy": { + "/v2/geo/downgrade": { parameters: { query?: never; header?: never; @@ -31468,6 +34601,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -31478,19 +34615,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - spy_id: number; - assignment: ("Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection") | { - /** @enum {string} */ - assignment: "Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection"; - /** @description For Security Sweep: suppress the email sent when no spies are found. */ - noempty?: boolean; - }; }; }; }; responses: { - /** @description Assigns a spy to a new task. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -31500,57 +34631,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - mission: { - /** @enum {string} */ - result?: "Accepted" | "Success" | "Bounce" | "Failure"; - message_id?: number; - reason?: string; - }; - spy: { - id: number; - name: string; - /** @enum {string} */ - assignment: "Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection"; - possible_assignments?: { - /** @enum {string} */ - task?: "Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection"; - recovery?: number; - skill?: string; - }[]; - level: number; - politics: number; - mayhem: number; - theft: number; - intel: number; - offense_rating?: number; - defense_rating?: number; - assigned_to?: { - body_id?: number; - name?: string; - x?: number; - y?: number; - }; - based_from?: { - body_id?: number; - name?: string; - x?: number; - y?: number; - }; - /** @enum {integer} */ - is_available: 1 | 0; - available_on?: string; - started_assignment?: string; - seconds_remaining?: number; - mission_count?: { - offensive?: number; - defensive?: number; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -31572,7 +34659,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/inteltraining/build": { + "/v2/geo/demolish": { parameters: { query?: never; header?: never; @@ -31581,6 +34668,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -31591,14 +34682,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -31608,15 +34698,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -31644,7 +34725,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/inteltraining/upgrade": { + "/v2/geo/repair": { parameters: { query?: never; header?: never; @@ -31653,6 +34734,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -31663,12 +34748,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -31678,15 +34764,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -31714,7 +34792,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/inteltraining/downgrade": { + "/v2/geo/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -31723,6 +34801,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -31733,12 +34815,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -31748,13 +34833,33 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -31776,7 +34881,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/inteltraining/demolish": { + "/v2/geo/view": { parameters: { query?: never; header?: never; @@ -31785,6 +34890,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -31795,12 +34904,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -31810,12 +34920,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -31837,7 +34947,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/inteltraining/repair": { + "/v2/geothermalvent/build": { parameters: { query?: never; header?: never; @@ -31846,6 +34956,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -31856,12 +34970,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -31871,7 +34990,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -31899,7 +35026,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/inteltraining/get_stats_for_level": { + "/v2/geothermalvent/upgrade": { parameters: { query?: never; header?: never; @@ -31908,6 +35035,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -31918,13 +35049,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -31936,24 +35067,11 @@ export interface paths { result?: { building: { id: number; - name: string; - image: string; level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; }; status: { @@ -31961,6 +35079,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -31982,7 +35101,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/inteltraining/view": { + "/v2/geothermalvent/downgrade": { parameters: { query?: never; header?: never; @@ -31991,6 +35110,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -32001,12 +35124,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -32022,12 +35146,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - /** @description Summary of spy training capacity for this facility. */ - spies?: { - max_points: number; - points_per: number; - in_training: number; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -32049,7 +35168,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/interdimensionalrift/build": { + "/v2/geothermalvent/demolish": { parameters: { query?: never; header?: never; @@ -32058,6 +35177,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -32068,14 +35191,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -32085,15 +35207,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -32121,7 +35234,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/interdimensionalrift/upgrade": { + "/v2/geothermalvent/repair": { parameters: { query?: never; header?: never; @@ -32130,6 +35243,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -32140,12 +35257,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -32155,15 +35273,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -32191,192 +35301,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/interdimensionalrift/downgrade": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; - responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/interdimensionalrift/demolish": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; - responses: { - /** @description Instantly destroys a building. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/interdimensionalrift/repair": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; - responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/interdimensionalrift/get_stats_for_level": { + "/v2/geothermalvent/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -32385,6 +35310,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -32395,7 +35324,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -32459,7 +35390,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/interdimensionalrift/view": { + "/v2/geothermalvent/view": { parameters: { query?: never; header?: never; @@ -32468,6 +35399,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -32478,6 +35413,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -32520,7 +35456,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/junkhengesculpture/build": { + "/v2/gratchsgauntlet/build": { parameters: { query?: never; header?: never; @@ -32529,6 +35465,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -32539,8 +35479,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -32592,7 +35535,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/junkhengesculpture/upgrade": { + "/v2/gratchsgauntlet/upgrade": { parameters: { query?: never; header?: never; @@ -32601,6 +35544,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -32611,6 +35558,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -32662,7 +35610,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/junkhengesculpture/downgrade": { + "/v2/gratchsgauntlet/downgrade": { parameters: { query?: never; header?: never; @@ -32671,6 +35619,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -32681,6 +35633,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -32724,7 +35677,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/junkhengesculpture/demolish": { + "/v2/gratchsgauntlet/demolish": { parameters: { query?: never; header?: never; @@ -32733,6 +35686,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -32743,6 +35700,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -32785,7 +35743,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/junkhengesculpture/repair": { + "/v2/gratchsgauntlet/repair": { parameters: { query?: never; header?: never; @@ -32794,6 +35752,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -32804,6 +35766,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -32847,7 +35810,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/junkhengesculpture/get_stats_for_level": { + "/v2/gratchsgauntlet/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -32856,6 +35819,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -32866,7 +35833,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -32930,7 +35899,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/junkhengesculpture/view": { + "/v2/gratchsgauntlet/view": { parameters: { query?: never; header?: never; @@ -32939,6 +35908,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -32949,6 +35922,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -32991,7 +35965,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/kalavianruins/build": { + "/v2/greatballofjunk/build": { parameters: { query?: never; header?: never; @@ -33000,6 +35974,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -33010,8 +35988,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -33063,7 +36044,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/kalavianruins/upgrade": { + "/v2/greatballofjunk/upgrade": { parameters: { query?: never; header?: never; @@ -33072,6 +36053,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -33082,6 +36067,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -33133,7 +36119,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/kalavianruins/downgrade": { + "/v2/greatballofjunk/downgrade": { parameters: { query?: never; header?: never; @@ -33142,6 +36128,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -33152,6 +36142,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -33195,7 +36186,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/kalavianruins/demolish": { + "/v2/greatballofjunk/demolish": { parameters: { query?: never; header?: never; @@ -33204,6 +36195,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -33214,6 +36209,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -33256,7 +36252,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/kalavianruins/repair": { + "/v2/greatballofjunk/repair": { parameters: { query?: never; header?: never; @@ -33265,6 +36261,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -33275,6 +36275,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -33318,7 +36319,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/kalavianruins/get_stats_for_level": { + "/v2/greatballofjunk/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -33327,6 +36328,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -33337,7 +36342,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -33401,7 +36408,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/kalavianruins/view": { + "/v2/greatballofjunk/view": { parameters: { query?: never; header?: never; @@ -33410,6 +36417,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -33420,6 +36431,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -33462,7 +36474,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/kasternskeep/build": { + "/v2/grove/build": { parameters: { query?: never; header?: never; @@ -33471,6 +36483,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -33481,8 +36497,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -33534,7 +36553,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/kasternskeep/upgrade": { + "/v2/grove/upgrade": { parameters: { query?: never; header?: never; @@ -33543,6 +36562,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -33553,6 +36576,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -33604,7 +36628,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/kasternskeep/downgrade": { + "/v2/grove/downgrade": { parameters: { query?: never; header?: never; @@ -33613,6 +36637,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -33623,6 +36651,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -33666,7 +36695,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/kasternskeep/demolish": { + "/v2/grove/demolish": { parameters: { query?: never; header?: never; @@ -33675,6 +36704,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -33685,6 +36718,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -33727,7 +36761,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/kasternskeep/repair": { + "/v2/grove/repair": { parameters: { query?: never; header?: never; @@ -33736,6 +36770,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -33746,6 +36784,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -33789,7 +36828,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/kasternskeep/get_stats_for_level": { + "/v2/grove/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -33798,6 +36837,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -33808,7 +36851,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -33872,7 +36917,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/kasternskeep/view": { + "/v2/grove/view": { parameters: { query?: never; header?: never; @@ -33881,6 +36926,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -33891,6 +36940,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -33933,7 +36983,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lagoon/build": { + "/v2/hallsofvrbansk/build": { parameters: { query?: never; header?: never; @@ -33942,6 +36992,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -33952,8 +37006,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -34005,7 +37062,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lagoon/upgrade": { + "/v2/hallsofvrbansk/upgrade": { parameters: { query?: never; header?: never; @@ -34014,6 +37071,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -34024,6 +37085,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -34075,7 +37137,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lagoon/downgrade": { + "/v2/hallsofvrbansk/downgrade": { parameters: { query?: never; header?: never; @@ -34084,6 +37146,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -34094,6 +37160,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -34137,7 +37204,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lagoon/demolish": { + "/v2/hallsofvrbansk/demolish": { parameters: { query?: never; header?: never; @@ -34146,6 +37213,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -34156,6 +37227,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -34198,7 +37270,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lagoon/repair": { + "/v2/hallsofvrbansk/repair": { parameters: { query?: never; header?: never; @@ -34207,6 +37279,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -34217,6 +37293,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -34260,7 +37337,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lagoon/get_stats_for_level": { + "/v2/hallsofvrbansk/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -34269,6 +37346,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -34279,7 +37360,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -34343,7 +37426,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lagoon/view": { + "/v2/hallsofvrbansk/view": { parameters: { query?: never; header?: never; @@ -34352,6 +37435,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -34362,6 +37449,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -34404,7 +37492,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lake/build": { + "/v2/hydrocarbon/build": { parameters: { query?: never; header?: never; @@ -34413,6 +37501,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -34423,8 +37515,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -34476,7 +37571,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lake/upgrade": { + "/v2/hydrocarbon/upgrade": { parameters: { query?: never; header?: never; @@ -34485,6 +37580,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -34495,6 +37594,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -34546,7 +37646,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lake/downgrade": { + "/v2/hydrocarbon/downgrade": { parameters: { query?: never; header?: never; @@ -34555,6 +37655,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -34565,6 +37669,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -34608,7 +37713,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lake/demolish": { + "/v2/hydrocarbon/demolish": { parameters: { query?: never; header?: never; @@ -34617,6 +37722,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -34627,6 +37736,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -34669,7 +37779,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lake/repair": { + "/v2/hydrocarbon/repair": { parameters: { query?: never; header?: never; @@ -34678,6 +37788,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -34688,6 +37802,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -34731,7 +37846,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lake/get_stats_for_level": { + "/v2/hydrocarbon/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -34740,6 +37855,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -34750,7 +37869,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -34814,7 +37935,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lake/view": { + "/v2/hydrocarbon/view": { parameters: { query?: never; header?: never; @@ -34823,6 +37944,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -34833,6 +37958,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -34875,7 +38001,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lapis/build": { + "/v2/ibs/view": { parameters: { query?: never; header?: never; @@ -34884,6 +38010,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this module's properties. + * @description Retrieves the properties of this module. + */ post: { parameters: { query?: never; @@ -34894,14 +38024,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Retrieves the properties of this module. */ 200: { headers: { [name: string]: unknown; @@ -34913,19 +38042,18 @@ export interface paths { result?: { building: { id: number; + name: string; + image: string; level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; + x: number; + y: number; + efficiency: number; }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -34947,7 +38075,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lapis/upgrade": { + "/v2/inbox/view_inbox": { parameters: { query?: never; header?: never; @@ -34956,6 +38084,10 @@ export interface paths { }; get?: never; put?: never; + /** + * List inbox messages. + * @description Displays a list of the messages in the empire's inbox, 25 per page, sorted newest to oldest. Throws 1002 and 1006. + */ post: { parameters: { query?: never; @@ -34966,12 +38098,20 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description Optional extra options. */ + options?: { + /** @description Which page of messages to view. 25 per page. Defaults to 1. */ + page_number?: number; + /** @description Only messages carrying at least one of these tags are returned. */ + tags?: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; + /** @description The name or id of a baby empire whose inbox to view. */ + empire?: string; + }; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Displays a list of the messages in the empire's inbox, 25 per page, newest to oldest. */ 200: { headers: { [name: string]: unknown; @@ -34981,21 +38121,27 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { + messages: { id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + subject: string; + date: string; + from: string; + from_id: number; + to: string; + to_id: number; + /** @enum {integer} */ + has_read: 1 | 0; + /** @enum {integer} */ + has_replied: 1 | 0; + body_preview: string; + tags: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; + }[]; + message_count: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -35017,7 +38163,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lapis/downgrade": { + "/v2/inbox/view_archived": { parameters: { query?: never; header?: never; @@ -35026,6 +38172,10 @@ export interface paths { }; get?: never; put?: never; + /** + * List archived messages. + * @description Exactly the same as view_inbox, except it shows archived messages instead. + */ post: { parameters: { query?: never; @@ -35036,12 +38186,20 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description Optional extra options. */ + options?: { + /** @description Which page of messages to view. 25 per page. Defaults to 1. */ + page_number?: number; + /** @description Only messages carrying at least one of these tags are returned. */ + tags?: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; + /** @description The name or id of a baby empire whose inbox to view. */ + empire?: string; + }; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Same as view_inbox, but shows archived messages. */ 200: { headers: { [name: string]: unknown; @@ -35051,13 +38209,27 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + messages: { + id: number; + subject: string; + date: string; + from: string; + from_id: number; + to: string; + to_id: number; + /** @enum {integer} */ + has_read: 1 | 0; + /** @enum {integer} */ + has_replied: 1 | 0; + body_preview: string; + tags: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; + }[]; + message_count: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -35079,7 +38251,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lapis/demolish": { + "/v2/inbox/view_trashed": { parameters: { query?: never; header?: never; @@ -35088,6 +38260,10 @@ export interface paths { }; get?: never; put?: never; + /** + * List trashed messages. + * @description Exactly the same as view_inbox, except it shows trashed messages instead. + */ post: { parameters: { query?: never; @@ -35098,12 +38274,20 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description Optional extra options. */ + options?: { + /** @description Which page of messages to view. 25 per page. Defaults to 1. */ + page_number?: number; + /** @description Only messages carrying at least one of these tags are returned. */ + tags?: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; + /** @description The name or id of a baby empire whose inbox to view. */ + empire?: string; + }; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Same as view_inbox, but shows trashed messages. */ 200: { headers: { [name: string]: unknown; @@ -35113,12 +38297,27 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + messages: { + id: number; + subject: string; + date: string; + from: string; + from_id: number; + to: string; + to_id: number; + /** @enum {integer} */ + has_read: 1 | 0; + /** @enum {integer} */ + has_replied: 1 | 0; + body_preview: string; + tags: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; + }[]; + message_count: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -35140,7 +38339,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lapis/repair": { + "/v2/inbox/view_sent": { parameters: { query?: never; header?: never; @@ -35149,6 +38348,10 @@ export interface paths { }; get?: never; put?: never; + /** + * List sent messages. + * @description Exactly the same as view_inbox, except it shows sent messages instead. + */ post: { parameters: { query?: never; @@ -35159,12 +38362,20 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description Optional extra options. */ + options?: { + /** @description Which page of messages to view. 25 per page. Defaults to 1. */ + page_number?: number; + /** @description Only messages carrying at least one of these tags are returned. */ + tags?: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; + /** @description The name or id of a baby empire whose inbox to view. */ + empire?: string; + }; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Same as view_inbox, but shows sent messages. */ 200: { headers: { [name: string]: unknown; @@ -35174,13 +38385,27 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + messages: { + id: number; + subject: string; + date: string; + from: string; + from_id: number; + to: string; + to_id: number; + /** @enum {integer} */ + has_read: 1 | 0; + /** @enum {integer} */ + has_replied: 1 | 0; + body_preview: string; + tags: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; + }[]; + message_count: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -35202,7 +38427,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lapis/get_stats_for_level": { + "/v2/inbox/view_unread": { parameters: { query?: never; header?: never; @@ -35211,6 +38436,10 @@ export interface paths { }; get?: never; put?: never; + /** + * List unread messages. + * @description Exactly the same as view_inbox, except it shows only the unread messages in the inbox. + */ post: { parameters: { query?: never; @@ -35221,13 +38450,20 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - level: number; + /** @description Optional extra options. */ + options?: { + /** @description Which page of messages to view. 25 per page. Defaults to 1. */ + page_number?: number; + /** @description Only messages carrying at least one of these tags are returned. */ + tags?: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; + /** @description The name or id of a baby empire whose inbox to view. */ + empire?: string; + }; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Same as view_inbox, but shows only unread messages. */ 200: { headers: { [name: string]: unknown; @@ -35237,28 +38473,22 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { + messages: { id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; + subject: string; + date: string; + from: string; + from_id: number; + to: string; + to_id: number; + /** @enum {integer} */ + has_read: 1 | 0; + /** @enum {integer} */ + has_replied: 1 | 0; + body_preview: string; + tags: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; + }[]; + message_count: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -35285,7 +38515,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lapis/view": { + "/v2/inbox/read_message": { parameters: { query?: never; header?: never; @@ -35294,6 +38524,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Read a message. + * @description Retrieves a message and marks it read if it was not already. Throws 1002, 1006, and 1010. + */ post: { parameters: { query?: never; @@ -35304,12 +38538,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description A message id returned by view_inbox or one of the other view_ methods. */ + message_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Retrieves a message and marks it read if it was not already. */ 200: { headers: { [name: string]: unknown; @@ -35319,7 +38554,49 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + message: { + id: number; + from: string; + from_id: number; + to: string; + to_id: number; + subject: string; + body: string; + date: string; + /** @enum {integer} */ + has_read: 1 | 0; + /** @enum {integer} */ + has_replied: 1 | 0; + /** @enum {integer} */ + has_archived: 1 | 0; + /** @enum {integer} */ + has_trashed: 1 | 0; + in_reply_to: number; + /** @description The complete list of empires who received the message. `to`/`to_id` above is just the empire that owns this particular copy of the message. */ + recipients: number[]; + tags: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; + /** @description At most one of each attachment type per message. */ + attachments?: { + image?: { + url: string; + title: string; + link?: string; + }; + link?: { + url: string; + label: string; + }; + table?: string[][]; + map?: { + surface: string; + buildings: { + x: number; + y: number; + image: string; + }[]; + }; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -35346,7 +38623,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lapisforest/build": { + "/v2/inbox/archive_messages": { parameters: { query?: never; header?: never; @@ -35355,6 +38632,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Archive messages. + * @description Archives a list of messages, marking them read in the process. Sent messages cannot be archived; a message that is already archived or otherwise un-archivable is returned in failure. + */ post: { parameters: { query?: never; @@ -35365,14 +38646,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The message ids to archive. */ + message_ids: number[]; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Archives a list of messages (marked as read in the process). Sent messages cannot be archived. */ 200: { headers: { [name: string]: unknown; @@ -35382,21 +38662,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + success: number[]; + failure: number[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -35418,7 +38690,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lapisforest/upgrade": { + "/v2/inbox/trash_messages": { parameters: { query?: never; header?: never; @@ -35427,6 +38699,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Trash messages. + * @description Trashes a list of messages, marking them read in the process. Only messages sent to you can be trashed. + */ post: { parameters: { query?: never; @@ -35437,12 +38713,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The message ids to trash. */ + message_ids: number[]; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Trashes a list of messages (marked as read in the process). Only messages sent to you can be trashed. */ 200: { headers: { [name: string]: unknown; @@ -35452,21 +38729,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + success: number[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -35488,7 +38756,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lapisforest/downgrade": { + "/v2/inbox/trash_messages_where": { parameters: { query?: never; header?: never; @@ -35497,6 +38765,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Trash messages matching a spec. + * @description Trashes every message that matches all keys of at least one spec entry, marking them read in the process. It is an error to supply an empty spec. + */ post: { parameters: { query?: never; @@ -35507,12 +38779,22 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description A list of match specifications. A message must match every key of an entry to be trashed; entries are OR-ed together. Use a subject of "%" to match all non-archived messages. */ + spec: { + /** @description A message carrying any of these tags is eligible. Defaults to all tags. */ + tags?: ("Tutorial" | "Correspondence" | "Medal" | "Intelligence" | "Alert" | "Attack" | "Colonization" | "Complaint" | "Excavator" | "Mission" | "Parliament" | "Probe" | "Spies" | "Trade")[]; + /** @description A subject to match. Use % as a wildcard, e.g. "Pass:%". An array is treated as a set of exact subjects, OR-ed together. Defaults to any subject. */ + subject?: string | string[]; + /** @description Full empire names. A message from any of these is eligible. */ + from?: string[]; + }[]; + /** @description When true, the trashed message ids are gathered and returned in `deleted`. Off by default, since gathering them adds server work and response size; `deleted_count` is returned either way. */ + return_ids?: boolean; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Trashes all messages matching every key of at least one spec entry (marked as read in the process). */ 200: { headers: { [name: string]: unknown; @@ -35522,13 +38804,14 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + /** @description Only present when return_ids is true. */ + deleted?: number[]; + deleted_count: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -35550,7 +38833,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lapisforest/demolish": { + "/v2/inbox/send_message": { parameters: { query?: never; header?: never; @@ -35559,6 +38842,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Send a message to other players. + * @description Sends a message to other players. Throws 1002, 1005, and 1006. + */ post: { parameters: { query?: never; @@ -35569,12 +38856,24 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description Comma separated empire names. "@ally" is a shortcut for all members of your alliance. */ + recipients: string; + /** @description A subject for the message. Fewer than 100 characters and cannot contain &, @, ;, <, or >. */ + subject: string; + /** @description The body of the message. Fewer than 200,000 characters and cannot contain < or >. */ + body: string; + /** @description Optional extra options. */ + options?: { + /** @description The id of the message this one is in reply to, if any. */ + in_reply_to?: number; + /** @description A message id whose attachments should be sent along with this message. The original text is not forwarded; include it in the body yourself if you want it. */ + forward?: number; + }; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Sends a message to other players. */ 200: { headers: { [name: string]: unknown; @@ -35589,7 +38888,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -35611,7 +38909,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lapisforest/repair": { + "/v2/intelligence/build": { parameters: { query?: never; header?: never; @@ -35620,6 +38918,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -35630,12 +38932,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -35645,7 +38952,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -35673,7 +38988,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lapisforest/get_stats_for_level": { + "/v2/intelligence/upgrade": { parameters: { query?: never; header?: never; @@ -35682,6 +38997,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -35692,13 +39011,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -35710,24 +39029,11 @@ export interface paths { result?: { building: { id: number; - name: string; - image: string; level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; }; status: { @@ -35735,6 +39041,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -35756,7 +39063,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lapisforest/view": { + "/v2/intelligence/downgrade": { parameters: { query?: never; header?: never; @@ -35765,6 +39072,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -35775,12 +39086,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -35796,6 +39108,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -35817,7 +39130,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/libraryofjith/build": { + "/v2/intelligence/demolish": { parameters: { query?: never; header?: never; @@ -35826,6 +39139,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -35836,14 +39153,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -35853,15 +39169,73 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/intelligence/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -35889,7 +39263,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/libraryofjith/upgrade": { + "/v2/intelligence/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -35898,6 +39272,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -35908,12 +39286,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -35925,11 +39306,24 @@ export interface paths { result?: { building: { id: number; + name: string; + image: string; level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; }; }; status: { @@ -35937,7 +39331,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -35959,7 +39352,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/libraryofjith/downgrade": { + "/v2/intelligence/view": { parameters: { query?: never; header?: never; @@ -35968,6 +39361,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -35978,12 +39375,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -35999,7 +39397,12 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; + spies?: { + maximum?: number; + current?: number; + in_training?: number; + training_costs?: components["schemas"]["building_cost"]; + }; }; }; }; @@ -36021,7 +39424,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/libraryofjith/demolish": { + "/v2/intelligence/train_spy": { parameters: { query?: never; header?: never; @@ -36030,6 +39433,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Train spy. + * @description Queues spies for training. Throws 1013, 1009. + */ post: { parameters: { query?: never; @@ -36040,12 +39447,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description Defaults to 1. */ + quantity?: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Queues spies for training. Throws 1013, 1009. */ 200: { headers: { [name: string]: unknown; @@ -36055,12 +39465,17 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + trained: number; + not_trained: number; + reason_not_trained?: { + code?: number; + message?: string; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -36082,7 +39497,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/libraryofjith/repair": { + "/v2/intelligence/view_spies": { parameters: { query?: never; header?: never; @@ -36091,6 +39506,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View spies. + * @description Retrieves a paginated spy roster. + */ post: { parameters: { query?: never; @@ -36101,12 +39520,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description Defaults to 1. 30 per page. */ + page_number?: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Retrieves a paginated spy roster. */ 200: { headers: { [name: string]: unknown; @@ -36116,13 +39538,52 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + spies: { + id: number; + name: string; + /** @enum {string} */ + assignment: "Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection"; + possible_assignments?: { + /** @enum {string} */ + task?: "Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection"; + recovery?: number; + skill?: string; + }[]; + level: number; + politics: number; + mayhem: number; + theft: number; + intel: number; + offense_rating?: number; + defense_rating?: number; + assigned_to?: { + body_id?: number; + name?: string; + x?: number; + y?: number; + }; + based_from?: { + body_id?: number; + name?: string; + x?: number; + y?: number; + }; + /** @enum {integer} */ + is_available: 1 | 0; + available_on?: string; + started_assignment?: string; + seconds_remaining?: number; + mission_count?: { + offensive?: number; + defensive?: number; + }; + }[]; + spy_count: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -36144,7 +39605,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/libraryofjith/get_stats_for_level": { + "/v2/intelligence/view_all_spies": { parameters: { query?: never; header?: never; @@ -36153,6 +39614,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View all spies. + * @description Retrieves the complete (non-paginated) spy roster. + */ post: { parameters: { query?: never; @@ -36163,13 +39628,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Retrieves the complete (non-paginated) spy roster. */ 200: { headers: { [name: string]: unknown; @@ -36179,28 +39644,47 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { + spies: { id: number; name: string; - image: string; + /** @enum {string} */ + assignment: "Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection"; + possible_assignments?: { + /** @enum {string} */ + task?: "Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection"; + recovery?: number; + skill?: string; + }[]; level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; + politics: number; + mayhem: number; + theft: number; + intel: number; + offense_rating?: number; + defense_rating?: number; + assigned_to?: { + body_id?: number; + name?: string; + x?: number; + y?: number; }; - }; + based_from?: { + body_id?: number; + name?: string; + x?: number; + y?: number; + }; + /** @enum {integer} */ + is_available: 1 | 0; + available_on?: string; + started_assignment?: string; + seconds_remaining?: number; + mission_count?: { + offensive?: number; + defensive?: number; + }; + }[]; + spy_count: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -36227,7 +39711,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/libraryofjith/view": { + "/v2/intelligence/subsidize_training": { parameters: { query?: never; header?: never; @@ -36236,6 +39720,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Subsidize training. + * @description Completes all in-training spies immediately for 1 essentia per spy. Returns the building view. Throws 1011. + */ post: { parameters: { query?: never; @@ -36246,12 +39734,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Completes all in-training spies immediately for 1 essentia per spy. Returns the building view. Throws 1011. */ 200: { headers: { [name: string]: unknown; @@ -36288,7 +39777,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/libraryofjith/research_species": { + "/v2/intelligence/burn_spy": { parameters: { query?: never; header?: never; @@ -36297,6 +39786,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Burn spy. + * @description Eliminates a spy from payroll. Throws 1002, 1010. + */ post: { parameters: { query?: never; @@ -36307,14 +39800,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - /** @description The unique id of an empire you'd like to know more about. */ - empire_id: number; + /** @description The unique id of the spy. */ + spy_id: number; }; }; }; responses: { - /** @description Returns species stats for any species in the game. */ + /** @description Eliminates a spy from payroll. Throws 1002, 1010. */ 200: { headers: { [name: string]: unknown; @@ -36324,38 +39818,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - species: { - /** @description The name of the species. Limited to 30 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ - name: string; - /** @description The species description. Limited to 1024 characters and cannot contain < or >. */ - description: string; - /** @description The closest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be less than or equal to max_orbit. */ - min_orbit: number; - /** @description The furthest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be greater than or equal to min_orbit. */ - max_orbit: number; - /** @description 7 is best. Determines advantages in manufactured goods, such as ships. */ - manufacturing_affinity: number; - /** @description 7 is best. Determines advantages in spying. */ - deception_affinity: number; - /** @description 7 is best. Determines advantages in upgrading buildings. */ - research_affinity: number; - /** @description 7 is best. Determines advantages in the speed of building. */ - management_affinity: number; - /** @description 7 is best. Determines advantages in food production. */ - farming_affinity: number; - /** @description 7 is best. Determines advantages in mineral production. */ - mining_affinity: number; - /** @description 7 is best. Determines advantages in energy, propulsion, and other technologies. */ - science_affinity: number; - /** @description 7 is best. Determines advantages in waste and water management. */ - environmental_affinity: number; - /** @description 7 is best. Determines advantages in managing population happiness. */ - political_affinity: number; - /** @description 7 is best. Determines advantages in freight handling. */ - trade_affinity: number; - /** @description 7 is best. Determines advantages in colonization. */ - growth_affinity: number; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -36382,7 +39844,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lostcityoftyleon/build": { + "/v2/intelligence/name_spy": { parameters: { query?: never; header?: never; @@ -36391,6 +39853,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Name spy. + * @description Sets a spy's name. Throws 1002, 1005, 1013. + */ post: { parameters: { query?: never; @@ -36401,14 +39867,17 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; + /** @description The unique id of the spy. */ + spy_id: number; + /** @description Cannot contain @, <, #, &, ; or profanity. */ + name: string; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Sets a spy's name. Throws 1002, 1005, 1013. */ 200: { headers: { [name: string]: unknown; @@ -36418,21 +39887,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -36454,7 +39913,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lostcityoftyleon/upgrade": { + "/v2/intelligence/name_spies": { parameters: { query?: never; header?: never; @@ -36463,6 +39922,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Name spies. + * @description Batch-names spies using the pattern "prefix ## suffix". + */ post: { parameters: { query?: never; @@ -36473,12 +39936,19 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description Optional name prefix. New names look like "prefix ## suffix". */ + prefix?: string; + /** @description Optional name suffix. */ + suffix?: string; + /** @description When true, only renames spies still named "Agent Null". */ + rename_null_only?: boolean; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Batch-names spies using the pattern "prefix ## suffix". */ 200: { headers: { [name: string]: unknown; @@ -36488,21 +39958,53 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { + spies: { id: number; + name: string; + /** @enum {string} */ + assignment: "Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection"; + possible_assignments?: { + /** @enum {string} */ + task?: "Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection"; + recovery?: number; + skill?: string; + }[]; level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; + politics: number; + mayhem: number; + theft: number; + intel: number; + offense_rating?: number; + defense_rating?: number; + assigned_to?: { + body_id?: number; + name?: string; + x?: number; + y?: number; }; - }; + based_from?: { + body_id?: number; + name?: string; + x?: number; + y?: number; + }; + /** @enum {integer} */ + is_available: 1 | 0; + available_on?: string; + started_assignment?: string; + seconds_remaining?: number; + mission_count?: { + offensive?: number; + defensive?: number; + }; + }[]; + spy_count: number; + renamed: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -36524,7 +40026,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lostcityoftyleon/downgrade": { + "/v2/intelligence/assign_spy": { parameters: { query?: never; header?: never; @@ -36533,6 +40035,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Assign spy. + * @description Assigns a spy to a new task. + */ post: { parameters: { query?: never; @@ -36543,12 +40049,21 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the spy. */ + spy_id: number; + assignment: ("Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection") | { + /** @enum {string} */ + assignment: "Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection"; + /** @description For Security Sweep: suppress the email sent when no spies are found. */ + noempty?: boolean; + }; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Assigns a spy to a new task. */ 200: { headers: { [name: string]: unknown; @@ -36558,13 +40073,57 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + mission: { + /** @enum {string} */ + result?: "Accepted" | "Success" | "Bounce" | "Failure"; + message_id?: number; + reason?: string; + }; + spy: { + id: number; + name: string; + /** @enum {string} */ + assignment: "Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection"; + possible_assignments?: { + /** @enum {string} */ + task?: "Idle" | "Bugout" | "Counter Espionage" | "Security Sweep" | "Intel Training" | "Mayhem Training" | "Politics Training" | "Theft Training" | "Political Propaganda" | "Gather Resource Intelligence" | "Gather Empire Intelligence" | "Gather Operative Intelligence" | "Hack Network 19" | "Sabotage Probes" | "Rescue Comrades" | "Sabotage Resources" | "Appropriate Resources" | "Assassinate Operatives" | "Sabotage Infrastructure" | "Sabotage Defenses" | "Sabotage BHG" | "Incite Mutiny" | "Abduct Operatives" | "Appropriate Technology" | "Incite Rebellion" | "Incite Insurrection"; + recovery?: number; + skill?: string; + }[]; + level: number; + politics: number; + mayhem: number; + theft: number; + intel: number; + offense_rating?: number; + defense_rating?: number; + assigned_to?: { + body_id?: number; + name?: string; + x?: number; + y?: number; + }; + based_from?: { + body_id?: number; + name?: string; + x?: number; + y?: number; + }; + /** @enum {integer} */ + is_available: 1 | 0; + available_on?: string; + started_assignment?: string; + seconds_remaining?: number; + mission_count?: { + offensive?: number; + defensive?: number; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -36586,7 +40145,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lostcityoftyleon/demolish": { + "/v2/inteltraining/build": { parameters: { query?: never; header?: never; @@ -36595,6 +40154,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -36605,12 +40168,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -36620,6 +40188,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -36647,7 +40224,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lostcityoftyleon/repair": { + "/v2/inteltraining/upgrade": { parameters: { query?: never; header?: never; @@ -36656,6 +40233,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -36666,12 +40247,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -36681,7 +40263,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -36709,7 +40299,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lostcityoftyleon/get_stats_for_level": { + "/v2/inteltraining/downgrade": { parameters: { query?: never; header?: never; @@ -36718,6 +40308,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -36728,13 +40322,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -36744,33 +40338,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -36792,7 +40366,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/lostcityoftyleon/view": { + "/v2/inteltraining/demolish": { parameters: { query?: never; header?: never; @@ -36801,6 +40375,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -36811,12 +40389,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -36826,12 +40405,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -36853,7 +40432,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/luxuryhousing/build": { + "/v2/inteltraining/repair": { parameters: { query?: never; header?: never; @@ -36862,6 +40441,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -36872,14 +40455,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -36889,15 +40471,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -36925,7 +40499,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/luxuryhousing/upgrade": { + "/v2/inteltraining/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -36934,6 +40508,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -36944,12 +40522,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -36961,11 +40542,24 @@ export interface paths { result?: { building: { id: number; + name: string; + image: string; level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; }; }; status: { @@ -36973,7 +40567,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -36995,7 +40588,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/luxuryhousing/downgrade": { + "/v2/inteltraining/view": { parameters: { query?: never; header?: never; @@ -37004,6 +40597,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -37014,12 +40611,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -37035,68 +40633,15 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/luxuryhousing/demolish": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; - responses: { - /** @description Instantly destroys a building. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; + /** @description Summary of spy training capacity for this facility. */ + spies?: { + /** @description The maximum training points a spy can hold. */ + max_points: number; + /** @description Training points added per training cycle. */ + points_per: number; + /** @description The number of spies currently training here. */ + in_training: number; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -37118,7 +40663,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/luxuryhousing/repair": { + "/v2/interdimensionalrift/build": { parameters: { query?: never; header?: never; @@ -37127,6 +40672,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -37137,12 +40686,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -37152,7 +40706,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -37180,7 +40742,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/luxuryhousing/get_stats_for_level": { + "/v2/interdimensionalrift/upgrade": { parameters: { query?: never; header?: never; @@ -37189,6 +40751,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -37199,13 +40765,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -37217,24 +40783,11 @@ export interface paths { result?: { building: { id: number; - name: string; - image: string; level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; }; status: { @@ -37242,6 +40795,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -37263,7 +40817,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/luxuryhousing/view": { + "/v2/interdimensionalrift/downgrade": { parameters: { query?: never; header?: never; @@ -37272,6 +40826,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -37282,12 +40840,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -37303,6 +40862,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -37324,7 +40884,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/malcud/build": { + "/v2/interdimensionalrift/demolish": { parameters: { query?: never; header?: never; @@ -37333,6 +40893,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -37343,14 +40907,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -37360,15 +40923,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -37396,7 +40950,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/malcud/upgrade": { + "/v2/interdimensionalrift/repair": { parameters: { query?: never; header?: never; @@ -37405,6 +40959,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -37415,12 +40973,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -37430,15 +40989,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -37466,7 +41017,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/malcud/downgrade": { + "/v2/interdimensionalrift/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -37475,6 +41026,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -37485,12 +41040,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -37500,13 +41058,33 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -37528,68 +41106,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/malcud/demolish": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; - responses: { - /** @description Instantly destroys a building. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/malcud/repair": { + "/v2/interdimensionalrift/view": { parameters: { query?: never; header?: never; @@ -37598,6 +41115,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -37608,12 +41129,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -37629,7 +41151,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -37651,7 +41172,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/malcud/get_stats_for_level": { + "/v2/junkhengesculpture/build": { parameters: { query?: never; header?: never; @@ -37660,6 +41181,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -37670,13 +41195,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - level: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -37688,24 +41217,11 @@ export interface paths { result?: { building: { id: number; - name: string; - image: string; level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; }; status: { @@ -37713,6 +41229,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -37734,7 +41251,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/malcud/view": { + "/v2/junkhengesculpture/upgrade": { parameters: { query?: never; header?: never; @@ -37743,6 +41260,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -37753,75 +41274,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/malcudfield/build": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - body_id: number; - x: number; - y: number; - }; - }; - }; - responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -37867,7 +41326,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/malcudfield/upgrade": { + "/v2/junkhengesculpture/downgrade": { parameters: { query?: never; header?: never; @@ -37876,6 +41335,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -37886,12 +41349,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -37901,15 +41365,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -37937,7 +41393,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/malcudfield/downgrade": { + "/v2/junkhengesculpture/demolish": { parameters: { query?: never; header?: never; @@ -37946,6 +41402,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -37956,12 +41416,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -37971,7 +41432,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -37999,7 +41459,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/malcudfield/demolish": { + "/v2/junkhengesculpture/repair": { parameters: { query?: never; header?: never; @@ -38008,6 +41468,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -38018,12 +41482,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -38033,6 +41498,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -38060,7 +41526,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/malcudfield/repair": { + "/v2/junkhengesculpture/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -38069,6 +41535,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -38079,12 +41549,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -38094,13 +41567,33 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -38122,7 +41615,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/malcudfield/get_stats_for_level": { + "/v2/junkhengesculpture/view": { parameters: { query?: never; header?: never; @@ -38131,6 +41624,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -38141,13 +41638,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -38157,28 +41654,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -38205,7 +41681,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/malcudfield/view": { + "/v2/kalavianruins/build": { parameters: { query?: never; header?: never; @@ -38214,6 +41690,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -38224,12 +41704,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -38239,12 +41724,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -38266,7 +41760,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/map/get_star_map": { + "/v2/kalavianruins/upgrade": { parameters: { query?: never; header?: never; @@ -38275,6 +41769,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -38285,15 +41783,13 @@ export interface paths { requestBody?: { content: { "application/json": { - left: number; - top: number; - right: number; - bottom: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description The preferred, 'lite' way to draw the starmap — returns just enough data to render it, and does not include most owned-planet detail (ore, water, etc). Maximum requestable area is 1001 units (e.g. 50x20 or 1001x1). */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -38303,47 +41799,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - stars: { - name: string; - color: string; - x: number; - y: number; + building: { id: number; - zone: string; - /** @description May be null when the star is outside any station jurisdiction. */ - influence: number; - station?: { - id: number; - x: number; - y: number; - name: string; - alliance: { - name: string; - id: number; - image: string; - }; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; - bodies: { - name: string; - id: number; - orbit: number; - x: number; - y: number; - type: string; - image: string; - size: number; - empire?: { - id: number; - name: string; - /** @enum {string} */ - alignment: "ally" | "self" | "hostile"; - /** @enum {integer} */ - is_isolationist: 1 | 0; - }; - /** @enum {integer} */ - body_has_fissure?: 1 | 0; - }[]; - }[]; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -38365,7 +41835,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/map/get_stars": { + "/v2/kalavianruins/downgrade": { parameters: { query?: never; header?: never; @@ -38374,6 +41844,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -38384,15 +41858,13 @@ export interface paths { requestBody?: { content: { "application/json": { - x1: number; - y1: number; - x2: number; - y2: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Retrieves a chunk of the map. Coordinates without a star are omitted from the results. Maximum requestable area is 900 spaces (e.g. 30x30). Throws 1003 if the area is too large. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -38402,27 +41874,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - stars: { - name: string; - color: string; - x: number; - y: number; - zone: string; - influence?: number; - id: number; - station?: { - id: number; - x: number; - y: number; - name: string; - }; - bodies?: components["schemas"]["body_status"][]; - }[]; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -38444,7 +41902,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/map/check_star_for_incoming_probe": { + "/v2/kalavianruins/demolish": { parameters: { query?: never; header?: never; @@ -38453,6 +41911,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -38463,12 +41925,13 @@ export interface paths { requestBody?: { content: { "application/json": { - star_id: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description If the star has a status of "unprobed", call this to check whether a probe from this empire is inbound. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -38483,7 +41946,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - incoming_probe?: string; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -38505,7 +41968,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/map/get_star": { + "/v2/kalavianruins/repair": { parameters: { query?: never; header?: never; @@ -38514,6 +41977,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -38524,12 +41991,13 @@ export interface paths { requestBody?: { content: { "application/json": { - star_id: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Retrieves info on a single star. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -38539,27 +42007,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - star: { - name: string; - color: string; - x: number; - y: number; - zone: string; - influence?: number; - id: number; - station?: { - id: number; - x: number; - y: number; - name: string; - }; - bodies?: components["schemas"]["body_status"][]; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -38581,7 +42035,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/map/get_star_by_name": { + "/v2/kalavianruins/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -38590,6 +42044,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -38600,12 +42058,15 @@ export interface paths { requestBody?: { content: { "application/json": { - name: string; + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Retrieves info on a single star by its exact (case insensitive) name. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -38615,21 +42076,27 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - star: { - name: string; - color: string; - x: number; - y: number; - zone: string; - influence?: number; + building: { id: number; - station?: { - id: number; - x: number; - y: number; - name: string; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; }; - bodies?: components["schemas"]["body_status"][]; }; status: { server: components["schemas"]["server_status"]; @@ -38657,7 +42124,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/map/get_star_by_xy": { + "/v2/kalavianruins/view": { parameters: { query?: never; header?: never; @@ -38666,6 +42133,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -38676,13 +42147,13 @@ export interface paths { requestBody?: { content: { "application/json": { - x: number; - y: number; + /** @description The id of the building you wish to retrieve. */ + building_id: number; }; }; }; responses: { - /** @description Retrieves info on a single star by coordinates. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -38692,22 +42163,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - star: { - name: string; - color: string; - x: number; - y: number; - zone: string; - influence?: number; - id: number; - station?: { - id: number; - x: number; - y: number; - name: string; - }; - bodies?: components["schemas"]["body_status"][]; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -38734,7 +42190,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/map/search_stars": { + "/v2/kasternskeep/build": { parameters: { query?: never; header?: never; @@ -38743,6 +42199,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -38753,12 +42213,17 @@ export interface paths { requestBody?: { content: { "application/json": { - name: string; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Searches for stars by partial, case insensitive name (minimum 3 characters). No body data is returned. Returns up to 25 results. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -38768,17 +42233,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - stars: { - name: string; - color: string; - x: number; - y: number; - }[]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -38800,7 +42269,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/map/probe_summary_fissures": { + "/v2/kasternskeep/upgrade": { parameters: { query?: never; header?: never; @@ -38809,6 +42278,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -38819,13 +42292,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description A zone string, e.g. "-1|0", "5|-5", or "0|0". If omitted, all zones are searched. */ - zone?: string; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description A summary of every body with a fissure known to your (or your alliance's) probes in the given zone. Returns an empty object if no fissures are known. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -38835,29 +42308,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - /** @description Keyed by body id. */ - fissures?: { - [key: string]: { - name: string; - id: number; - orbit: number; - x: number; - y: number; - type: string; - image: string; - size: number; - empire?: { - id: number; - name: string; - /** @enum {string} */ - alignment: "ally" | "self" | "hostile"; - /** @enum {integer} */ - is_isolationist: 1 | 0; - }; - /** @enum {integer} */ - body_has_fissure?: 1 | 0; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -38879,7 +42344,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/map/view_laws": { + "/v2/kasternskeep/downgrade": { parameters: { query?: never; header?: never; @@ -38888,6 +42353,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -38898,12 +42367,13 @@ export interface paths { requestBody?: { content: { "application/json": { - star_id: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Returns the laws enacted by the space station controlling this star. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -38913,17 +42383,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - laws: { - id: number; - name: string; - description: string; - date_enacted: string; - }[]; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -38945,7 +42411,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/massadshenge/build": { + "/v2/kasternskeep/demolish": { parameters: { query?: never; header?: never; @@ -38954,6 +42420,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -38964,14 +42434,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -38981,15 +42450,73 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/kasternskeep/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -39017,7 +42544,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/massadshenge/upgrade": { + "/v2/kasternskeep/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -39026,6 +42553,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -39036,12 +42567,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -39053,11 +42587,24 @@ export interface paths { result?: { building: { id: number; + name: string; + image: string; level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; }; }; status: { @@ -39065,7 +42612,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -39087,7 +42633,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/massadshenge/downgrade": { + "/v2/kasternskeep/view": { parameters: { query?: never; header?: never; @@ -39096,6 +42642,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -39106,12 +42656,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -39127,6 +42678,84 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/lagoon/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; buildings: components["schemas"]["buildings_list"]; }; }; @@ -39149,7 +42778,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/massadshenge/demolish": { + "/v2/lagoon/upgrade": { parameters: { query?: never; header?: never; @@ -39158,6 +42787,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -39168,12 +42801,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -39183,6 +42817,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -39210,7 +42853,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/massadshenge/repair": { + "/v2/lagoon/downgrade": { parameters: { query?: never; header?: never; @@ -39219,6 +42862,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -39229,12 +42876,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -39272,7 +42920,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/massadshenge/get_stats_for_level": { + "/v2/lagoon/demolish": { parameters: { query?: never; header?: never; @@ -39281,6 +42929,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -39291,13 +42943,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -39307,33 +42959,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -39355,7 +42986,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/massadshenge/view": { + "/v2/lagoon/repair": { parameters: { query?: never; header?: never; @@ -39364,6 +42995,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -39374,12 +43009,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -39395,6 +43031,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -39416,7 +43053,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mayhemtraining/build": { + "/v2/lagoon/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -39425,6 +43062,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -39435,14 +43076,15 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -39454,11 +43096,24 @@ export interface paths { result?: { building: { id: number; + name: string; + image: string; level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; }; }; status: { @@ -39466,7 +43121,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -39488,7 +43142,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mayhemtraining/upgrade": { + "/v2/lagoon/view": { parameters: { query?: never; header?: never; @@ -39497,6 +43151,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -39507,6 +43165,152 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/lake/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/lake/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -39558,7 +43362,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mayhemtraining/downgrade": { + "/v2/lake/downgrade": { parameters: { query?: never; header?: never; @@ -39567,6 +43371,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -39577,6 +43385,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -39620,7 +43429,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mayhemtraining/demolish": { + "/v2/lake/demolish": { parameters: { query?: never; header?: never; @@ -39629,6 +43438,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -39639,6 +43452,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -39681,7 +43495,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mayhemtraining/repair": { + "/v2/lake/repair": { parameters: { query?: never; header?: never; @@ -39690,6 +43504,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -39700,6 +43518,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -39743,7 +43562,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mayhemtraining/get_stats_for_level": { + "/v2/lake/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -39752,6 +43571,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -39762,7 +43585,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -39826,7 +43651,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mayhemtraining/view": { + "/v2/lake/view": { parameters: { query?: never; header?: never; @@ -39835,6 +43660,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -39845,6 +43674,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -39866,11 +43696,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - spies?: { - max_points: number; - points_per: number; - in_training: number; - }; }; }; }; @@ -39892,7 +43717,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mercenariesguild/build": { + "/v2/lapis/build": { parameters: { query?: never; header?: never; @@ -39901,6 +43726,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -39911,8 +43740,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -39964,7 +43796,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mercenariesguild/upgrade": { + "/v2/lapis/upgrade": { parameters: { query?: never; header?: never; @@ -39973,6 +43805,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -39983,6 +43819,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -40034,7 +43871,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mercenariesguild/downgrade": { + "/v2/lapis/downgrade": { parameters: { query?: never; header?: never; @@ -40043,6 +43880,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -40053,6 +43894,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -40096,7 +43938,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mercenariesguild/demolish": { + "/v2/lapis/demolish": { parameters: { query?: never; header?: never; @@ -40105,6 +43947,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -40115,6 +43961,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -40157,7 +44004,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mercenariesguild/repair": { + "/v2/lapis/repair": { parameters: { query?: never; header?: never; @@ -40166,6 +44013,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -40176,6 +44027,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -40219,7 +44071,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mercenariesguild/get_stats_for_level": { + "/v2/lapis/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -40228,6 +44080,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -40238,7 +44094,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -40302,7 +44160,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mercenariesguild/view": { + "/v2/lapis/view": { parameters: { query?: never; header?: never; @@ -40311,6 +44169,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -40321,6 +44183,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -40363,7 +44226,86 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mercenariesguild/add_to_market": { + "/v2/lapisforest/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/lapisforest/upgrade": { parameters: { query?: never; header?: never; @@ -40372,6 +44314,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -40382,18 +44328,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - /** @description See get_spies for a list of your spies. */ - spy_id: number; - /** @description Amount of essentia being asked for. */ - ask: number; - /** @description Optional. See get_trade_ships for details. */ - ship_id?: number; }; }; }; responses: { - /** @description Queues a trade of a spy for others to see. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -40403,12 +44344,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - trade_id: number; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -40430,7 +44380,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mercenariesguild/get_spies": { + "/v2/lapisforest/downgrade": { parameters: { query?: never; header?: never; @@ -40439,6 +44389,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -40449,12 +44403,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Returns a list of spies that may be traded. Used with add_to_market. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -40464,16 +44419,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - spies: { - id: number; - name: string; - level: number; - }[]; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -40495,7 +44447,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mercenariesguild/withdraw_from_market": { + "/v2/lapisforest/demolish": { parameters: { query?: never; header?: never; @@ -40504,6 +44456,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -40514,13 +44470,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - trade_id: number; }; }; }; responses: { - /** @description Removes a trade that you have offered and collects the items up for trade. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -40535,6 +44491,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -40556,7 +44513,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mercenariesguild/accept_from_market": { + "/v2/lapisforest/repair": { parameters: { query?: never; header?: never; @@ -40565,6 +44522,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -40575,13 +44536,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - trade_id: number; }; }; }; responses: { - /** @description Accepts a trade offer from the list of available trades. See view_market. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -40591,11 +44552,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -40617,7 +44580,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mercenariesguild/view_market": { + "/v2/lapisforest/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -40626,6 +44589,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -40636,14 +44603,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; - /** @description Optional. Defaults to 1. 25 trades per page. */ - page_number?: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Displays a list of trades available at the present time. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -40653,24 +44621,28 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - trades: { - date_offered: string; + building: { id: number; - /** @description Amount of essentia being asked for. */ - ask: number; - offer: string[]; - /** @description Only present on view_market. Use with get_trade_ships to determine travel time. */ - body?: { - id: number; - }; - /** @description Only present on view_market. */ - empire?: { - id: number; - name: string; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; }; - }[]; - trade_count: number; - page_number: number; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -40697,7 +44669,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mercenariesguild/view_my_market": { + "/v2/lapisforest/view": { parameters: { query?: never; header?: never; @@ -40706,6 +44678,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -40716,14 +44692,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; - /** @description Optional. Defaults to 1. 25 trades per page. */ - page_number?: number; }; }; }; responses: { - /** @description Displays a list of trades the current user has posted. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -40733,24 +44708,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - trades: { - date_offered: string; - id: number; - /** @description Amount of essentia being asked for. */ - ask: number; - offer: string[]; - /** @description Only present on view_market. Use with get_trade_ships to determine travel time. */ - body?: { - id: number; - }; - /** @description Only present on view_market. */ - empire?: { - id: number; - name: string; - }; - }[]; - trade_count: number; - page_number: number; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -40777,7 +44735,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mercenariesguild/get_trade_ships": { + "/v2/lcota/build": { parameters: { query?: never; header?: never; @@ -40786,6 +44744,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -40796,14 +44758,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - /** @description Optional. If included, the estimated travel time to this body is calculated. */ - target_body_id?: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Returns a list of the ships that could be used to do a trade. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -40813,79 +44778,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - ships: { + building: { id: number; - type: string; - name: string; - /** @description In seconds, one way. Only present when target_body_id is provided. */ - estimated_travel_time?: number; - }[]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; }; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/mercenariesguild/report_abuse": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - trade_id: number; - }; - }; - }; - responses: { - /** @description Reports a trade that is suspected of abusing the trade system. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -40907,7 +44814,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/metaljunkarches/build": { + "/v2/lcota/upgrade": { parameters: { query?: never; header?: never; @@ -40916,6 +44823,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -40926,14 +44837,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -40979,7 +44889,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/metaljunkarches/upgrade": { + "/v2/lcota/downgrade": { parameters: { query?: never; header?: never; @@ -40988,6 +44898,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -40998,12 +44912,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -41013,15 +44928,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -41049,7 +44956,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/metaljunkarches/downgrade": { + "/v2/lcota/demolish": { parameters: { query?: never; header?: never; @@ -41058,6 +44965,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -41068,12 +44979,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -41083,7 +44995,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -41111,7 +45022,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/metaljunkarches/demolish": { + "/v2/lcota/repair": { parameters: { query?: never; header?: never; @@ -41120,6 +45031,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -41130,12 +45045,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -41145,6 +45061,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -41172,7 +45089,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/metaljunkarches/repair": { + "/v2/lcota/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -41181,6 +45098,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -41191,12 +45112,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -41206,13 +45130,33 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -41234,7 +45178,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/metaljunkarches/get_stats_for_level": { + "/v2/lcota/view": { parameters: { query?: never; header?: never; @@ -41243,6 +45187,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -41253,13 +45201,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -41269,28 +45217,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -41317,68 +45244,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/metaljunkarches/view": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; - responses: { - /** @description Retrieves the properties of the building. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/mine/build": { + "/v2/lcotb/build": { parameters: { query?: never; header?: never; @@ -41387,6 +45253,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -41397,8 +45267,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -41450,7 +45323,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mine/upgrade": { + "/v2/lcotb/upgrade": { parameters: { query?: never; header?: never; @@ -41459,6 +45332,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -41469,6 +45346,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -41520,7 +45398,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mine/downgrade": { + "/v2/lcotb/downgrade": { parameters: { query?: never; header?: never; @@ -41529,6 +45407,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -41539,6 +45421,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -41582,7 +45465,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mine/demolish": { + "/v2/lcotb/demolish": { parameters: { query?: never; header?: never; @@ -41591,6 +45474,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -41601,6 +45488,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -41643,7 +45531,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mine/repair": { + "/v2/lcotb/repair": { parameters: { query?: never; header?: never; @@ -41652,6 +45540,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -41662,6 +45554,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -41705,7 +45598,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mine/get_stats_for_level": { + "/v2/lcotb/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -41714,6 +45607,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -41724,7 +45621,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -41788,7 +45687,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/mine/view": { + "/v2/lcotb/view": { parameters: { query?: never; header?: never; @@ -41797,6 +45696,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -41807,6 +45710,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -41849,7 +45753,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/miningministry/build": { + "/v2/lcotc/build": { parameters: { query?: never; header?: never; @@ -41858,6 +45762,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -41868,8 +45776,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -41921,7 +45832,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/miningministry/upgrade": { + "/v2/lcotc/upgrade": { parameters: { query?: never; header?: never; @@ -41930,6 +45841,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -41940,6 +45855,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -41991,7 +45907,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/miningministry/downgrade": { + "/v2/lcotc/downgrade": { parameters: { query?: never; header?: never; @@ -42000,6 +45916,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -42010,6 +45930,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -42053,7 +45974,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/miningministry/demolish": { + "/v2/lcotc/demolish": { parameters: { query?: never; header?: never; @@ -42062,6 +45983,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -42072,6 +45997,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -42114,7 +46040,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/miningministry/repair": { + "/v2/lcotc/repair": { parameters: { query?: never; header?: never; @@ -42123,6 +46049,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -42133,6 +46063,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -42176,7 +46107,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/miningministry/get_stats_for_level": { + "/v2/lcotc/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -42185,6 +46116,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -42195,7 +46130,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -42259,7 +46196,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/miningministry/view": { + "/v2/lcotc/view": { parameters: { query?: never; header?: never; @@ -42268,6 +46205,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -42278,6 +46219,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -42320,7 +46262,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/miningministry/view_platforms": { + "/v2/lcotd/build": { parameters: { query?: never; header?: never; @@ -42329,6 +46271,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -42339,12 +46285,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Returns a list of the mining platforms currently controlled by this ministry. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -42354,44 +46305,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - max_platforms: number; - platforms: { + building: { id: number; - asteroid: { - id: number; - name: string; - x: number; - y: number; - image: string; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; - rutile_hour?: number; - chromite_hour?: number; - chalcopyrite_hour?: number; - galena_hour?: number; - gold_hour?: number; - uraninite_hour?: number; - bauxite_hour?: number; - goethite_hour?: number; - halite_hour?: number; - gypsum_hour?: number; - trona_hour?: number; - kerogen_hour?: number; - methane_hour?: number; - anthracite_hour?: number; - sulfur_hour?: number; - zircon_hour?: number; - monazite_hour?: number; - fluorite_hour?: number; - beryl_hour?: number; - magnetite_hour?: number; - /** @description A percent indicating production vs shipping efficiency. -1 means no ships are servicing the platforms, 0 means ships but no production, 1-99 means more shipping capacity than production, 100 means production and shipping are in harmony, and greater than 100 means more ships are needed. */ - shipping_capacity: number; - }[]; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -42413,7 +46341,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/miningministry/view_ships": { + "/v2/lcotd/upgrade": { parameters: { query?: never; header?: never; @@ -42422,6 +46350,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -42432,12 +46364,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Shows the ships that are working in the mining fleet, and available to work in it. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -42447,79 +46380,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - ships: { - name: string; + building: { id: number; - task: string; - speed: number; - hold_size: number; - }[]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; }; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/miningministry/add_cargo_ship_to_fleet": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - ship_id: number; - }; - }; - }; - responses: { - /** @description Takes a cargo ship from the space port and adds it to the mining fleet. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -42541,7 +46416,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/miningministry/remove_cargo_ship_from_fleet": { + "/v2/lcotd/downgrade": { parameters: { query?: never; header?: never; @@ -42550,6 +46425,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -42560,13 +46439,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - ship_id: number; }; }; }; responses: { - /** @description Tells one of the cargo ships in the mining fleet to come home and park at the space port. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -42576,11 +46455,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -42602,7 +46483,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/miningministry/abandon_platform": { + "/v2/lcotd/demolish": { parameters: { query?: never; header?: never; @@ -42611,6 +46492,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -42621,13 +46506,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - platform_id: number; }; }; }; responses: { - /** @description Closes down an existing mining platform. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -42642,6 +46527,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -42663,7 +46549,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/miningministry/mass_abandon_platform": { + "/v2/lcotd/repair": { parameters: { query?: never; header?: never; @@ -42672,6 +46558,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -42682,12 +46572,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Destroys all platforms controlled by this ministry. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -42697,11 +46588,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -42723,7 +46616,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/missioncommand/build": { + "/v2/lcotd/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -42732,6 +46625,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -42742,14 +46639,15 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -42761,11 +46659,24 @@ export interface paths { result?: { building: { id: number; + name: string; + image: string; level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; }; }; status: { @@ -42773,7 +46684,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -42795,7 +46705,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/missioncommand/upgrade": { + "/v2/lcotd/view": { parameters: { query?: never; header?: never; @@ -42804,6 +46714,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -42814,12 +46728,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -42829,21 +46744,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -42865,7 +46771,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/missioncommand/downgrade": { + "/v2/lcote/build": { parameters: { query?: never; header?: never; @@ -42874,6 +46780,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -42884,12 +46794,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -42899,7 +46814,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -42927,7 +46850,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/missioncommand/demolish": { + "/v2/lcote/upgrade": { parameters: { query?: never; header?: never; @@ -42936,6 +46859,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -42946,12 +46873,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -42961,6 +46889,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -42988,7 +46925,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/missioncommand/repair": { + "/v2/lcote/downgrade": { parameters: { query?: never; header?: never; @@ -42997,6 +46934,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -43007,12 +46948,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -43050,7 +46992,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/missioncommand/get_stats_for_level": { + "/v2/lcote/demolish": { parameters: { query?: never; header?: never; @@ -43059,6 +47001,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -43069,13 +47015,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -43085,33 +47031,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -43133,7 +47058,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/missioncommand/view": { + "/v2/lcote/repair": { parameters: { query?: never; header?: never; @@ -43142,6 +47067,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -43152,12 +47081,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -43173,6 +47103,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -43194,7 +47125,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/missioncommand/get_missions": { + "/v2/lcote/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -43203,6 +47134,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -43213,12 +47148,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Returns a (non-exhaustive) list of missions eligible to be completed in this zone. Excludes missions already completed or above the empire's university level. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -43228,77 +47166,28 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - missions: { + building: { id: number; - max_university_level: number; - date_posted: string; name: string; - description: string; - objectives: string[]; - rewards: string[]; - }[]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; }; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/missioncommand/complete_mission": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - /** @description The unique id of the mission to complete. */ - mission_id: number; - }; - }; - }; - responses: { - /** @description Completes a mission. Rejected if the objectives are not all met; otherwise the rewards are distributed. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -43325,7 +47214,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/missioncommand/skip_mission": { + "/v2/lcote/view": { parameters: { query?: never; header?: never; @@ -43334,6 +47223,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -43344,14 +47237,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; - /** @description The unique id of the mission to skip. Won't appear again for this empire for 30 days. */ - mission_id: number; }; }; }; responses: { - /** @description Skips a mission, hiding it from this list for 30 days. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -43361,6 +47253,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -43387,7 +47280,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/munitionslab/build": { + "/v2/lcotf/build": { parameters: { query?: never; header?: never; @@ -43396,6 +47289,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -43406,8 +47303,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -43459,7 +47359,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/munitionslab/upgrade": { + "/v2/lcotf/upgrade": { parameters: { query?: never; header?: never; @@ -43468,6 +47368,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -43478,6 +47382,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -43529,7 +47434,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/munitionslab/downgrade": { + "/v2/lcotf/downgrade": { parameters: { query?: never; header?: never; @@ -43538,6 +47443,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -43548,6 +47457,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -43591,7 +47501,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/munitionslab/demolish": { + "/v2/lcotf/demolish": { parameters: { query?: never; header?: never; @@ -43600,6 +47510,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -43610,6 +47524,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -43652,7 +47567,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/munitionslab/repair": { + "/v2/lcotf/repair": { parameters: { query?: never; header?: never; @@ -43661,6 +47576,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -43671,6 +47590,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -43714,7 +47634,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/munitionslab/get_stats_for_level": { + "/v2/lcotf/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -43723,6 +47643,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -43733,7 +47657,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -43797,7 +47723,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/munitionslab/view": { + "/v2/lcotf/view": { parameters: { query?: never; header?: never; @@ -43806,6 +47732,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -43816,6 +47746,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -43858,7 +47789,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/naturalspring/build": { + "/v2/lcotg/build": { parameters: { query?: never; header?: never; @@ -43867,6 +47798,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -43877,8 +47812,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -43930,7 +47868,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/naturalspring/upgrade": { + "/v2/lcotg/upgrade": { parameters: { query?: never; header?: never; @@ -43939,6 +47877,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -43949,6 +47891,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -44000,7 +47943,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/naturalspring/downgrade": { + "/v2/lcotg/downgrade": { parameters: { query?: never; header?: never; @@ -44009,6 +47952,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -44019,6 +47966,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -44062,7 +48010,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/naturalspring/demolish": { + "/v2/lcotg/demolish": { parameters: { query?: never; header?: never; @@ -44071,6 +48019,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -44081,6 +48033,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -44123,7 +48076,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/naturalspring/repair": { + "/v2/lcotg/repair": { parameters: { query?: never; header?: never; @@ -44132,6 +48085,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -44142,6 +48099,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -44185,7 +48143,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/naturalspring/get_stats_for_level": { + "/v2/lcotg/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -44194,6 +48152,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -44204,7 +48166,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -44268,7 +48232,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/naturalspring/view": { + "/v2/lcotg/view": { parameters: { query?: never; header?: never; @@ -44277,6 +48241,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -44287,6 +48255,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -44329,7 +48298,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/network19/build": { + "/v2/lcoth/build": { parameters: { query?: never; header?: never; @@ -44338,6 +48307,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -44348,8 +48321,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -44401,7 +48377,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/network19/upgrade": { + "/v2/lcoth/upgrade": { parameters: { query?: never; header?: never; @@ -44410,6 +48386,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -44420,6 +48400,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -44471,7 +48452,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/network19/downgrade": { + "/v2/lcoth/downgrade": { parameters: { query?: never; header?: never; @@ -44480,6 +48461,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -44490,6 +48475,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -44533,7 +48519,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/network19/demolish": { + "/v2/lcoth/demolish": { parameters: { query?: never; header?: never; @@ -44542,6 +48528,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -44552,6 +48542,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -44594,7 +48585,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/network19/repair": { + "/v2/lcoth/repair": { parameters: { query?: never; header?: never; @@ -44603,6 +48594,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -44613,6 +48608,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -44656,7 +48652,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/network19/get_stats_for_level": { + "/v2/lcoth/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -44665,6 +48661,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -44675,7 +48675,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -44739,7 +48741,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/network19/view": { + "/v2/lcoth/view": { parameters: { query?: never; header?: never; @@ -44748,6 +48750,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -44758,6 +48764,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -44779,11 +48786,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - /** - * @description Whether a policy restricting coverage of this planet is currently in effect. See restrict_coverage. - * @enum {integer} - */ - restrict_coverage?: 1 | 0; }; }; }; @@ -44805,7 +48807,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/network19/restrict_coverage": { + "/v2/lcoti/build": { parameters: { query?: never; header?: never; @@ -44814,6 +48816,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -44824,17 +48830,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - /** - * @description Whether to restrict what Network 19 covers about your planet. Restricting makes citizens unhappy. - * @enum {integer} - */ - onoff: 1 | 0; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Enacts or disbands a policy restricting what Network 19 covers about your planet. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -44844,11 +48850,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -44870,7 +48886,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/network19/view_news": { + "/v2/lcoti/upgrade": { parameters: { query?: never; header?: never; @@ -44879,6 +48895,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -44889,12 +48909,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Returns the top 100 headlines from this zone, and a list of RSS feeds usable outside the game to see the same news. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -44904,19 +48925,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - news: { - headline: string; - date: string; - }[]; - /** @description Keyed by zone coordinates (e.g. "0|0|0"), values are RSS feed URLs. */ - feeds: { - [key: string]: string; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -44938,7 +48961,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/observatory/build": { + "/v2/lcoti/downgrade": { parameters: { query?: never; header?: never; @@ -44947,6 +48970,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -44957,14 +48984,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -44974,15 +49000,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -45010,7 +49028,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/observatory/upgrade": { + "/v2/lcoti/demolish": { parameters: { query?: never; header?: never; @@ -45019,6 +49037,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -45029,12 +49051,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -45044,15 +49067,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -45080,130 +49094,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/observatory/downgrade": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; - responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/observatory/demolish": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; - responses: { - /** @description Instantly destroys a building. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/observatory/repair": { + "/v2/lcoti/repair": { parameters: { query?: never; header?: never; @@ -45212,6 +49103,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -45222,6 +49117,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -45265,7 +49161,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/observatory/get_stats_for_level": { + "/v2/lcoti/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -45274,6 +49170,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -45284,7 +49184,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -45348,7 +49250,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/observatory/view": { + "/v2/lcoti/view": { parameters: { query?: never; header?: never; @@ -45357,6 +49259,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -45367,6 +49273,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -45409,7 +49316,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/observatory/get_probed_stars": { + "/v2/libraryofjith/build": { parameters: { query?: never; header?: never; @@ -45418,6 +49325,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -45428,14 +49339,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - /** @description Optional. Which page of probes to return. Defaults to 1. Up to 25 probes per page. */ - page_number?: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Returns a list of the stars that have been probed by this planet. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -45445,41 +49359,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - stars: { + building: { id: number; - color: string; - name: string; - x: number; - y: number; - bodies: { - id: number; - x: number; - y: number; - star_id: number; - star_name: string; - orbit: number; - type: string; - name: string; - image: string; - size: number; - notes: string; - zone: string; - station?: { - id: number; - x: number; - y: number; - name: string; - }; - }[]; - }[]; - star_count: number; - max_probes: number; - travelling: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -45501,7 +49395,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/observatory/abandon_probe": { + "/v2/libraryofjith/upgrade": { parameters: { query?: never; header?: never; @@ -45510,6 +49404,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -45520,14 +49418,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - /** @description The unique id of the star the probe is attached to. */ - star_id: number; }; }; }; responses: { - /** @description Deactivates a single probe, allowing it to burn up in the star. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -45537,11 +49434,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -45563,7 +49470,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/observatory/abandon_all_probes": { + "/v2/libraryofjith/downgrade": { parameters: { query?: never; header?: never; @@ -45572,6 +49479,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -45582,12 +49493,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Deactivates all probes controlled by this observatory, allowing them to burn up in the stars. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -45597,11 +49509,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -45623,7 +49537,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/operahouse/view": { + "/v2/libraryofjith/demolish": { parameters: { query?: never; header?: never; @@ -45632,6 +49546,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -45642,12 +49560,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of this module. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -45657,20 +49576,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - x: number; - y: number; - efficiency: number; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -45692,7 +49603,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/oracleofanid/build": { + "/v2/libraryofjith/repair": { parameters: { query?: never; header?: never; @@ -45701,6 +49612,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -45711,14 +49626,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -45728,15 +49642,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -45764,7 +49670,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/oracleofanid/upgrade": { + "/v2/libraryofjith/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -45773,6 +49679,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -45783,12 +49693,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -45800,11 +49713,24 @@ export interface paths { result?: { building: { id: number; + name: string; + image: string; level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; }; }; status: { @@ -45812,7 +49738,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -45834,7 +49759,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/oracleofanid/downgrade": { + "/v2/libraryofjith/view": { parameters: { query?: never; header?: never; @@ -45843,6 +49768,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -45853,12 +49782,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -45874,7 +49804,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -45896,7 +49825,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/oracleofanid/demolish": { + "/v2/libraryofjith/research_species": { parameters: { query?: never; header?: never; @@ -45905,6 +49834,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Research species. + * @description Returns species stats for any species in the game. + */ post: { parameters: { query?: never; @@ -45915,12 +49848,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of an empire you'd like to know more about. */ + empire_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Returns species stats for any species in the game. */ 200: { headers: { [name: string]: unknown; @@ -45930,12 +49866,43 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + species: { + /** @description The name of the species. Limited to 30 characters, cannot be blank, and cannot contain @, &, <, >, or ;. */ + name: string; + /** @description The species description. Limited to 1024 characters and cannot contain < or >. */ + description: string; + /** @description The closest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be less than or equal to max_orbit. */ + min_orbit: number; + /** @description The furthest orbit this species can inhabit, where 1 is nearest the star. Every orbit from min_orbit to max_orbit inclusive costs a point. Must be greater than or equal to min_orbit. */ + max_orbit: number; + /** @description 7 is best. Determines advantages in manufactured goods, such as ships. */ + manufacturing_affinity: number; + /** @description 7 is best. Determines advantages in spying. */ + deception_affinity: number; + /** @description 7 is best. Determines advantages in upgrading buildings. */ + research_affinity: number; + /** @description 7 is best. Determines advantages in the speed of building. */ + management_affinity: number; + /** @description 7 is best. Determines advantages in food production. */ + farming_affinity: number; + /** @description 7 is best. Determines advantages in mineral production. */ + mining_affinity: number; + /** @description 7 is best. Determines advantages in energy, propulsion, and other technologies. */ + science_affinity: number; + /** @description 7 is best. Determines advantages in waste and water management. */ + environmental_affinity: number; + /** @description 7 is best. Determines advantages in managing population happiness. */ + political_affinity: number; + /** @description 7 is best. Determines advantages in freight handling. */ + trade_affinity: number; + /** @description 7 is best. Determines advantages in colonization. */ + growth_affinity: number; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -45957,7 +49924,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/oracleofanid/repair": { + "/v2/luxuryhousing/build": { parameters: { query?: never; header?: never; @@ -45966,6 +49933,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -45976,12 +49947,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -45991,7 +49967,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -46019,7 +50003,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/oracleofanid/get_stats_for_level": { + "/v2/luxuryhousing/upgrade": { parameters: { query?: never; header?: never; @@ -46028,6 +50012,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -46038,13 +50026,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -46056,24 +50044,11 @@ export interface paths { result?: { building: { id: number; - name: string; - image: string; level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; }; status: { @@ -46081,6 +50056,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -46102,7 +50078,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/oracleofanid/view": { + "/v2/luxuryhousing/downgrade": { parameters: { query?: never; header?: never; @@ -46111,6 +50087,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -46121,12 +50101,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -46142,6 +50123,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -46163,7 +50145,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/oracleofanid/get_star": { + "/v2/luxuryhousing/demolish": { parameters: { query?: never; header?: never; @@ -46172,6 +50154,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -46182,13 +50168,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - star_id: number; }; }; }; responses: { - /** @description Retrieves info on a single star, including its bodies, even without a probe there. The Oracle's range is 10 map units per level; requesting a star outside that range throws 1009. Use Map/search_stars to look up a star's id by name. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -46198,19 +50184,79 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - star: { - id: number; - color: string; - name: string; - x: number; - y: number; - bodies: components["schemas"]["body_status"][]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/luxuryhousing/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -46232,7 +50278,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/oracleofanid/get_probed_stars": { + "/v2/luxuryhousing/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -46241,6 +50287,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -46251,16 +50301,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; - /** @description Optional. Defaults to 1. Each page contains page_size records. */ - page_number?: number; - /** @description Optional. Defaults to 25. */ - page_size?: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Returns all stars within range of the Oracle. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -46270,16 +50319,28 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - stars: { + building: { id: number; - color: string; name: string; - x: number; - y: number; - bodies: components["schemas"]["body_status"][]; - }[]; - star_count: number; - max_distance: number; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -46306,7 +50367,73 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/orerefinery/build": { + "/v2/luxuryhousing/view": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the building you wish to retrieve. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/malcud/build": { parameters: { query?: never; header?: never; @@ -46315,6 +50442,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -46325,8 +50456,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -46378,7 +50512,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/orerefinery/upgrade": { + "/v2/malcud/upgrade": { parameters: { query?: never; header?: never; @@ -46387,6 +50521,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -46397,6 +50535,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -46448,7 +50587,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/orerefinery/downgrade": { + "/v2/malcud/downgrade": { parameters: { query?: never; header?: never; @@ -46457,6 +50596,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -46467,6 +50610,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -46510,7 +50654,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/orerefinery/demolish": { + "/v2/malcud/demolish": { parameters: { query?: never; header?: never; @@ -46519,6 +50663,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -46529,6 +50677,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -46571,7 +50720,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/orerefinery/repair": { + "/v2/malcud/repair": { parameters: { query?: never; header?: never; @@ -46580,6 +50729,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -46590,6 +50743,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -46633,7 +50787,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/orerefinery/get_stats_for_level": { + "/v2/malcud/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -46642,6 +50796,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -46652,7 +50810,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -46716,7 +50876,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/orerefinery/view": { + "/v2/malcud/view": { parameters: { query?: never; header?: never; @@ -46725,6 +50885,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -46735,6 +50899,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -46777,7 +50942,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/orestorage/build": { + "/v2/malcudfield/build": { parameters: { query?: never; header?: never; @@ -46786,6 +50951,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -46796,8 +50965,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -46849,7 +51021,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/orestorage/upgrade": { + "/v2/malcudfield/upgrade": { parameters: { query?: never; header?: never; @@ -46858,6 +51030,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -46868,6 +51044,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -46919,7 +51096,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/orestorage/downgrade": { + "/v2/malcudfield/downgrade": { parameters: { query?: never; header?: never; @@ -46928,6 +51105,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -46938,6 +51119,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -46981,7 +51163,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/orestorage/demolish": { + "/v2/malcudfield/demolish": { parameters: { query?: never; header?: never; @@ -46990,6 +51172,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -47000,6 +51186,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -47042,7 +51229,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/orestorage/repair": { + "/v2/malcudfield/repair": { parameters: { query?: never; header?: never; @@ -47051,6 +51238,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -47061,6 +51252,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -47104,7 +51296,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/orestorage/get_stats_for_level": { + "/v2/malcudfield/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -47113,6 +51305,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -47123,7 +51319,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -47187,7 +51385,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/orestorage/view": { + "/v2/malcudfield/view": { parameters: { query?: never; header?: never; @@ -47196,6 +51394,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -47206,6 +51408,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -47227,10 +51430,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - /** @description Keyed by ore type. */ - ore_stored?: { - [key: string]: number; - }; }; }; }; @@ -47252,7 +51451,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/orestorage/dump": { + "/v2/map/get_star_map": { parameters: { query?: never; header?: never; @@ -47261,6 +51460,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Draw the star map (lite). + * @description The preferred, lite way to get star data for drawing the star map — it returns just enough to render it, omitting most owned-planet detail such as ore and water and the station-influence block. The maximum area that can be returned is 1001 units (e.g. 50x20 or 1001x1). + */ post: { parameters: { query?: never; @@ -47271,15 +51474,131 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - /** @description Ore type to convert into waste, e.g. gold, bauxite, galena. */ - type: string; - amount: number; + /** @description The left edge of the bounding rectangle. */ + left: number; + /** @description The top edge of the bounding rectangle. */ + top: number; + /** @description The right edge of the bounding rectangle. */ + right: number; + /** @description The bottom edge of the bounding rectangle. */ + bottom: number; }; }; }; responses: { - /** @description Converts ore into waste. */ + /** @description The preferred, 'lite' way to draw the starmap — returns just enough data to render it, and does not include most owned-planet detail (ore, water, etc). Maximum requestable area is 1001 units (e.g. 50x20 or 1001x1). */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + stars: { + name: string; + color: string; + x: number; + y: number; + id: number; + zone: string; + /** @description May be null when the star is outside any station jurisdiction. */ + influence: number; + /** @description Only present if this star is under the influence of a space station. */ + station?: { + id: number; + x: number; + y: number; + name: string; + alliance: { + name: string; + id: number; + image: string; + }; + }; + bodies: { + name: string; + id: number; + orbit: number; + x: number; + y: number; + type: string; + image: string; + size: number; + /** @description Only present if the body is occupied by an empire. */ + empire?: { + id: number; + name: string; + /** @enum {string} */ + alignment: "ally" | "self" | "hostile"; + /** @enum {integer} */ + is_isolationist: 1 | 0; + }; + /** + * @description Only present on asteroids or bodies that have a fissure. + * @enum {integer} + */ + body_has_fissure?: 1 | 0; + }[]; + }[]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/map/get_stars": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Get a chunk of the star map. + * @description Retrieves a chunk of the map as an array of stars. Coordinates without a star are omitted. The requested area can be no larger than 900 spaces (30x30). Throws 1003 when the area is too large. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The top left x coordinate. */ + x1: number; + /** @description The top left y coordinate. */ + y1: number; + /** @description The bottom right x coordinate. */ + x2: number; + /** @description The bottom right y coordinate. */ + y2: number; + }; + }; + }; + responses: { + /** @description Retrieves a chunk of the map. Coordinates without a star are omitted from the results. Maximum requestable area is 900 spaces (e.g. 30x30). Throws 1003 if the area is too large. */ 200: { headers: { [name: string]: unknown; @@ -47289,6 +51608,24 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + stars: { + name: string; + color: string; + x: number; + y: number; + zone: string; + influence?: number; + id: number; + /** @description Only present if this star is under the influence of a space station. */ + station?: { + id: number; + x: number; + y: number; + name: string; + }; + /** @description Only present if a probe is present in the system. */ + bodies?: components["schemas"]["body_status"][]; + }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -47315,7 +51652,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/oversight/build": { + "/v2/map/check_star_for_incoming_probe": { parameters: { query?: never; header?: never; @@ -47324,6 +51661,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Check for an inbound probe to a star. + * @description If a star has a status of "unprobed", call this to find out whether a probe from this empire is on its way. + */ post: { parameters: { query?: never; @@ -47334,14 +51675,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the star. */ + star_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description If the star has a status of "unprobed", call this to check whether a probe from this empire is inbound. */ 200: { headers: { [name: string]: unknown; @@ -47351,21 +51691,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; + /** @description The arrival date of the inbound probe. Only present if one is inbound. */ + incoming_probe?: string; }; }; }; @@ -47387,7 +51719,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/oversight/upgrade": { + "/v2/map/get_star": { parameters: { query?: never; header?: never; @@ -47396,6 +51728,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get one star by id. + * @description Retrieves info on a single star. + */ post: { parameters: { query?: never; @@ -47406,12 +51742,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The unique id of the star. */ + star_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Retrieves info on a single star. */ 200: { headers: { [name: string]: unknown; @@ -47421,21 +51758,29 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { + star: { + name: string; + color: string; + x: number; + y: number; + zone: string; + influence?: number; id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; + /** @description Only present if this star is under the influence of a space station. */ + station?: { + id: number; + x: number; + y: number; + name: string; }; + /** @description Only present if a probe is present in the system. */ + bodies?: components["schemas"]["body_status"][]; }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -47457,7 +51802,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/oversight/downgrade": { + "/v2/map/get_star_by_name": { parameters: { query?: never; header?: never; @@ -47466,6 +51811,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get one star by name. + * @description Retrieves info on a single star by its exact, case insensitive name. + */ post: { parameters: { query?: never; @@ -47476,12 +51825,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The exact name of the star. Case insensitive. */ + name: string; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Retrieves info on a single star by its exact (case insensitive) name. */ 200: { headers: { [name: string]: unknown; @@ -47491,13 +51841,29 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + star: { + name: string; + color: string; + x: number; + y: number; + zone: string; + influence?: number; + id: number; + /** @description Only present if this star is under the influence of a space station. */ + station?: { + id: number; + x: number; + y: number; + name: string; + }; + /** @description Only present if a probe is present in the system. */ + bodies?: components["schemas"]["body_status"][]; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -47519,7 +51885,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/oversight/demolish": { + "/v2/map/get_star_by_xy": { parameters: { query?: never; header?: never; @@ -47528,6 +51894,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get one star by coordinates. + * @description Retrieves info on a single star by its coordinates. + */ post: { parameters: { query?: never; @@ -47538,12 +51908,15 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The x coordinate of the star. */ + x: number; + /** @description The y coordinate of the star. */ + y: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Retrieves info on a single star by coordinates. */ 200: { headers: { [name: string]: unknown; @@ -47553,12 +51926,29 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + star: { + name: string; + color: string; + x: number; + y: number; + zone: string; + influence?: number; + id: number; + /** @description Only present if this star is under the influence of a space station. */ + station?: { + id: number; + x: number; + y: number; + name: string; + }; + /** @description Only present if a probe is present in the system. */ + bodies?: components["schemas"]["body_status"][]; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -47580,7 +51970,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/oversight/repair": { + "/v2/map/search_stars": { parameters: { query?: never; header?: never; @@ -47589,6 +51979,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Search stars by partial name. + * @description Searches for stars by partial, case insensitive name. Returns up to 25 results, with no body data. + */ post: { parameters: { query?: never; @@ -47599,12 +51993,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description A partial name of a star. Case insensitive. Must be at least 3 characters. */ + name: string; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Searches for stars by partial, case insensitive name (minimum 3 characters). No body data is returned. Returns up to 25 results. */ 200: { headers: { [name: string]: unknown; @@ -47614,13 +52009,17 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + stars: { + name: string; + color: string; + x: number; + y: number; + }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -47642,7 +52041,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/oversight/get_stats_for_level": { + "/v2/map/probe_summary_fissures": { parameters: { query?: never; header?: never; @@ -47651,6 +52050,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Summarize known fissures in a zone. + * @description Returns a summary of every body with a fissure known to your own or your alliance's probes in the given zone. Returns an empty object when no fissures are known. + */ post: { parameters: { query?: never; @@ -47661,13 +52064,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - level: number; + /** @description A zone string, e.g. "-1|0", "5|-5", or "0|0". If omitted, all zones are searched. */ + zone?: string; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description A summary of every body with a fissure known to your (or your alliance's) probes in the given zone. Returns an empty object if no fissures are known. */ 200: { headers: { [name: string]: unknown; @@ -47677,33 +52080,33 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; + /** @description Keyed by body id. */ + fissures?: { + [key: string]: { + name: string; + id: number; + orbit: number; + x: number; + y: number; + type: string; image: string; + size: number; + /** @description Only present if the body is occupied by an empire. */ + empire?: { + id: number; + name: string; + /** @enum {string} */ + alignment: "ally" | "self" | "hostile"; + /** @enum {integer} */ + is_isolationist: 1 | 0; + }; + /** + * @description Only present on asteroids or bodies that have a fissure. + * @enum {integer} + */ + body_has_fissure?: 1 | 0; }; }; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; }; }; }; @@ -47725,7 +52128,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/oversight/view": { + "/v2/map/view_laws": { parameters: { query?: never; header?: never; @@ -47734,6 +52137,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View the laws controlling a star. + * @description Pass the id of a star and the laws enacted by the controlling space station are returned. + */ post: { parameters: { query?: never; @@ -47744,12 +52151,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The unique id of the star. */ + star_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Returns the laws enacted by the space station controlling this star. */ 200: { headers: { [name: string]: unknown; @@ -47759,12 +52167,17 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + laws: { + id: number; + name: string; + description: string; + date_enacted: string; + }[]; }; }; }; @@ -47786,7 +52199,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pancake/build": { + "/v2/massadshenge/build": { parameters: { query?: never; header?: never; @@ -47795,6 +52208,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -47805,8 +52222,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -47858,7 +52278,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pancake/upgrade": { + "/v2/massadshenge/upgrade": { parameters: { query?: never; header?: never; @@ -47867,6 +52287,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -47877,6 +52301,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -47928,7 +52353,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pancake/downgrade": { + "/v2/massadshenge/downgrade": { parameters: { query?: never; header?: never; @@ -47937,6 +52362,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -47947,6 +52376,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -47990,7 +52420,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pancake/demolish": { + "/v2/massadshenge/demolish": { parameters: { query?: never; header?: never; @@ -47999,6 +52429,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -48009,6 +52443,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -48051,7 +52486,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pancake/repair": { + "/v2/massadshenge/repair": { parameters: { query?: never; header?: never; @@ -48060,6 +52495,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -48070,6 +52509,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -48113,7 +52553,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pancake/get_stats_for_level": { + "/v2/massadshenge/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -48122,6 +52562,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -48132,7 +52576,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -48196,7 +52642,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pancake/view": { + "/v2/massadshenge/view": { parameters: { query?: never; header?: never; @@ -48205,6 +52651,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -48215,6 +52665,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -48257,7 +52708,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pantheonofhagness/build": { + "/v2/mayhemtraining/build": { parameters: { query?: never; header?: never; @@ -48266,6 +52717,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -48276,8 +52731,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -48329,7 +52787,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pantheonofhagness/upgrade": { + "/v2/mayhemtraining/upgrade": { parameters: { query?: never; header?: never; @@ -48338,6 +52796,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -48348,6 +52810,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -48399,7 +52862,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pantheonofhagness/downgrade": { + "/v2/mayhemtraining/downgrade": { parameters: { query?: never; header?: never; @@ -48408,6 +52871,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -48418,6 +52885,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -48461,7 +52929,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pantheonofhagness/demolish": { + "/v2/mayhemtraining/demolish": { parameters: { query?: never; header?: never; @@ -48470,6 +52938,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -48480,6 +52952,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -48522,7 +52995,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pantheonofhagness/repair": { + "/v2/mayhemtraining/repair": { parameters: { query?: never; header?: never; @@ -48531,6 +53004,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -48541,6 +53018,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -48584,7 +53062,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pantheonofhagness/get_stats_for_level": { + "/v2/mayhemtraining/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -48593,6 +53071,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -48603,7 +53085,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -48667,7 +53151,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pantheonofhagness/view": { + "/v2/mayhemtraining/view": { parameters: { query?: never; header?: never; @@ -48676,6 +53160,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -48686,6 +53174,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -48707,6 +53196,15 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + /** @description Summary of spy training capacity for this facility. */ + spies?: { + /** @description The maximum training points a spy can hold. */ + max_points: number; + /** @description Training points added per training cycle. */ + points_per: number; + /** @description The number of spies currently training here. */ + in_training: number; + }; }; }; }; @@ -48728,7 +53226,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/park/build": { + "/v2/mercenariesguild/build": { parameters: { query?: never; header?: never; @@ -48737,6 +53235,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -48747,8 +53249,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -48800,7 +53305,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/park/upgrade": { + "/v2/mercenariesguild/upgrade": { parameters: { query?: never; header?: never; @@ -48809,6 +53314,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -48819,6 +53328,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -48870,7 +53380,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/park/downgrade": { + "/v2/mercenariesguild/downgrade": { parameters: { query?: never; header?: never; @@ -48879,6 +53389,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -48889,6 +53403,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -48932,7 +53447,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/park/demolish": { + "/v2/mercenariesguild/demolish": { parameters: { query?: never; header?: never; @@ -48941,6 +53456,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -48951,6 +53470,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -48993,7 +53513,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/park/repair": { + "/v2/mercenariesguild/repair": { parameters: { query?: never; header?: never; @@ -49002,6 +53522,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -49012,6 +53536,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -49055,7 +53580,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/park/get_stats_for_level": { + "/v2/mercenariesguild/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -49064,6 +53589,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -49074,7 +53603,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -49138,7 +53669,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/park/view": { + "/v2/mercenariesguild/view": { parameters: { query?: never; header?: never; @@ -49147,6 +53678,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -49157,6 +53692,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -49178,11 +53714,77 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - party?: { - seconds_remaining?: number; - happiness?: number; - /** @enum {integer} */ - can_throw?: 1 | 0; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/mercenariesguild/add_to_market": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Add to market. + * @description Queues a trade of a spy for others to see. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description See get_spies for a list of your spies. */ + spy_id: number; + /** @description Amount of essentia being asked for. */ + ask: number; + /** @description Optional. See get_trade_ships for details. */ + ship_id?: number; + }; + }; + }; + responses: { + /** @description Queues a trade of a spy for others to see. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + trade_id: number; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; }; }; }; @@ -49205,7 +53807,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/park/throw_a_party": { + "/v2/mercenariesguild/get_spies": { parameters: { query?: never; header?: never; @@ -49214,6 +53816,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get spies. + * @description Returns a list of spies that may be traded. Used with add_to_market. + */ post: { parameters: { query?: never; @@ -49224,12 +53830,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Spends 10,000 food to throw a day-long party generating happiness. Returns the building view. */ + /** @description Returns a list of spies that may be traded. Used with add_to_market. */ 200: { headers: { [name: string]: unknown; @@ -49239,17 +53846,82 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + spies: { + id: number; + name: string; + level: number; + }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - party: { - seconds_remaining?: number; - happiness?: number; - /** @enum {integer} */ - can_throw?: 1 | 0; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/mercenariesguild/withdraw_from_market": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Withdraw from market. + * @description Removes a trade that you have offered and collects the items up for trade. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description The unique id of the trade. */ + trade_id: number; + }; + }; + }; + responses: { + /** @description Removes a trade that you have offered and collects the items up for trade. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; }; }; }; @@ -49272,7 +53944,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/park/subsidize_party": { + "/v2/mercenariesguild/accept_from_market": { parameters: { query?: never; header?: never; @@ -49281,6 +53953,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Accept from market. + * @description Accepts a trade offer from the list of available trades. See view_market. + */ post: { parameters: { query?: never; @@ -49291,12 +53967,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the trade. */ + trade_id: number; }; }; }; responses: { - /** @description Spends 2 essentia to complete the current party immediately. Returns the building view. */ + /** @description Accepts a trade offer from the list of available trades. See view_market. */ 200: { headers: { [name: string]: unknown; @@ -49306,18 +53985,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - party: { - seconds_remaining?: number; - happiness?: number; - /** @enum {integer} */ - can_throw?: 1 | 0; - }; }; }; }; @@ -49339,7 +54011,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/view": { + "/v2/mercenariesguild/view_market": { parameters: { query?: never; header?: never; @@ -49348,6 +54020,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View market. + * @description Displays a list of trades available at the present time. + */ post: { parameters: { query?: never; @@ -49358,12 +54034,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description Optional. Defaults to 1. 25 trades per page. */ + page_number?: number; }; }; }; responses: { - /** @description Retrieves the properties of this module. */ + /** @description Displays a list of trades available at the present time. */ 200: { headers: { [name: string]: unknown; @@ -49373,82 +54052,24 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { + trades: { + date_offered: string; id: number; - name: string; - image: string; - level: number; - x: number; - y: number; - efficiency: number; - }; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/parliament/view_laws": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** @description The unique id of the space station. */ - body_id: number; - }; - }; - }; - responses: { - /** @description Lists the laws currently in effect for this station's jurisdiction. Still usable, but superseded by the equivalent call on Body. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - laws: { - id?: number; - name?: string; - description?: string; - date_enacted?: string; + /** @description Amount of essentia being asked for. */ + ask: number; + offer: string[]; + /** @description Only present on view_market. Use with get_trade_ships to determine travel time. */ + body?: { + id: number; + }; + /** @description Only present on view_market. */ + empire?: { + id: number; + name: string; + }; }[]; + trade_count: number; + page_number: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -49475,7 +54096,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/view_propositions": { + "/v2/mercenariesguild/view_my_market": { parameters: { query?: never; header?: never; @@ -49484,6 +54105,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View my market. + * @description Displays a list of trades the current user has posted. + */ post: { parameters: { query?: never; @@ -49494,12 +54119,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description Optional. Defaults to 1. 25 trades per page. */ + page_number?: number; }; }; }; responses: { - /** @description Returns a list of the pending propositions. */ + /** @description Displays a list of trades the current user has posted. */ 200: { headers: { [name: string]: unknown; @@ -49509,25 +54137,24 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - propositions: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; + trades: { + date_offered: string; + id: number; + /** @description Amount of essentia being asked for. */ + ask: number; + offer: string[]; + /** @description Only present on view_market. Use with get_trade_ships to determine travel time. */ + body?: { + id: number; + }; + /** @description Only present on view_market. */ + empire?: { + id: number; + name: string; }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; }[]; + trade_count: number; + page_number: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -49554,7 +54181,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/view_taxes_collected": { + "/v2/mercenariesguild/get_trade_ships": { parameters: { query?: never; header?: never; @@ -49563,6 +54190,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get trade ships. + * @description Returns a list of the ships that could be used to do a trade. + */ post: { parameters: { query?: never; @@ -49573,12 +54204,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description Optional. If included, the estimated travel time to this body is calculated. */ + target_body_id?: number; }; }; }; responses: { - /** @description Returns, for each empire that has paid taxes, their payments for today and the previous six days plus the seven-day total. */ + /** @description Returns a list of the ships that could be used to do a trade. */ 200: { headers: { [name: string]: unknown; @@ -49588,12 +54222,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - taxes_collected: { - id?: number; - name?: string; - /** @description Element 0 is today, followed by the previous six days. */ - paid?: number[]; - total?: number; + ships: { + id: number; + type: string; + name: string; + /** @description In seconds, one way. Only present when target_body_id is provided. */ + estimated_travel_time?: number; }[]; status: { server: components["schemas"]["server_status"]; @@ -49621,7 +54255,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/get_stars_in_jurisdiction": { + "/v2/mercenariesguild/report_abuse": { parameters: { query?: never; header?: never; @@ -49630,6 +54264,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Report abuse. + * @description Reports a trade that is suspected of abusing the trade system. + */ post: { parameters: { query?: never; @@ -49640,12 +54278,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the trade. */ + trade_id: number; }; }; }; responses: { - /** @description Returns a list of the stars in the jurisdiction of this space station. */ + /** @description Reports a trade that is suspected of abusing the trade system. */ 200: { headers: { [name: string]: unknown; @@ -49655,20 +54296,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - stars: { - id?: number; - name?: string; - color?: string; - x?: number; - y?: number; - /** @description Only present if this star is under the influence of a space station. */ - station?: { - id?: number; - x?: number; - y?: number; - name?: string; - }; - }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -49695,7 +54322,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/get_bodies_for_star_in_jurisdiction": { + "/v2/metaljunkarches/build": { parameters: { query?: never; header?: never; @@ -49704,6 +54331,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -49714,14 +54345,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - /** @description The unique id of a star in jurisdiction. See get_stars_in_jurisdiction. */ - star_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Returns a list of the bodies for a star in the jurisdiction of the space station. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -49731,12 +54365,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - bodies: components["schemas"]["body_status"][]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -49758,7 +54401,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/get_mining_platforms_for_asteroid_in_jurisdiction": { + "/v2/metaljunkarches/upgrade": { parameters: { query?: never; header?: never; @@ -49767,6 +54410,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -49777,14 +54424,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - /** @description The unique id of an asteroid in jurisdiction. See get_bodies_for_star_in_jurisdiction. */ - asteroid_id: number; }; }; }; responses: { - /** @description Returns a list of the mining platforms for an asteroid in the jurisdiction of the space station. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -49794,18 +54440,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - platforms: { - id?: number; - empire?: { - id?: number; - name?: string; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; - }[]; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -49827,7 +54476,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/cast_vote": { + "/v2/metaljunkarches/downgrade": { parameters: { query?: never; header?: never; @@ -49836,6 +54485,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -49846,19 +54499,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - /** @description The id of the proposition being voted on. See view_propositions. */ - proposition_id: number; - /** - * @description 1 for yes, 0 for no. Defaults to 0. - * @enum {integer} - */ - vote?: 1 | 0; }; }; }; responses: { - /** @description Casts a vote for or against a proposition. Cannot be voted on using a sitter password. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -49868,30 +54515,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -49913,7 +54543,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_writ": { + "/v2/metaljunkarches/demolish": { parameters: { query?: never; header?: never; @@ -49922,6 +54552,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -49932,14 +54566,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - title: string; - description: string; }; }; }; responses: { - /** @description Proposes an unenforceable law (writ). Requires Parliament level 4+. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -49954,25 +54587,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -49994,7 +54609,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_repeal_law": { + "/v2/metaljunkarches/repair": { parameters: { query?: never; header?: never; @@ -50003,6 +54618,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -50013,13 +54632,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - law_id: number; }; }; }; responses: { - /** @description Proposes repealing an existing law. Requires Parliament level 5+. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -50029,30 +54648,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -50074,7 +54676,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_transfer_station_ownership": { + "/v2/metaljunkarches/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -50083,6 +54685,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -50093,13 +54699,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; - to_empire_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Proposes transferring ownership of the station to another alliance member. Requires Parliament level 6+. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -50109,30 +54717,33 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; }; }; }; @@ -50154,7 +54765,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_rename_star": { + "/v2/metaljunkarches/view": { parameters: { query?: never; header?: never; @@ -50163,6 +54774,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -50173,14 +54788,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; - star_id: number; - name: string; }; }; }; responses: { - /** @description Proposes renaming a star. Requires Parliament level 8+. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -50190,30 +54804,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; }; }; }; @@ -50235,7 +54831,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_broadcast_on_network19": { + "/v2/mine/build": { parameters: { query?: never; header?: never; @@ -50244,6 +54840,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -50254,14 +54854,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - /** @description Cannot contain special characters or profanity. */ - message: string; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Proposes broadcasting a message on Network 19. Requires Parliament level 9+. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -50271,30 +54874,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -50316,7 +54910,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_induct_member": { + "/v2/mine/upgrade": { parameters: { query?: never; header?: never; @@ -50325,6 +54919,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -50335,15 +54933,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - empire_id: number; - /** @description Optional personalized welcome message included in the invitation. */ - message?: string; }; }; }; responses: { - /** @description Proposes inducting a new member into the alliance; if passed, an invitation is sent. Requires Parliament level 10+. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -50353,30 +54949,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -50398,7 +54985,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_expel_member": { + "/v2/mine/downgrade": { parameters: { query?: never; header?: never; @@ -50407,6 +54994,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -50417,15 +55008,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - empire_id: number; - /** @description Optional reason. Cannot contain restricted characters or profanity. */ - message?: string; }; }; }; responses: { - /** @description Proposes expelling a member from the alliance. Requires Parliament level 10+. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -50435,30 +55024,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -50480,7 +55052,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_elect_new_leader": { + "/v2/mine/demolish": { parameters: { query?: never; header?: never; @@ -50489,6 +55061,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -50499,13 +55075,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - to_empire_id: number; }; }; }; responses: { - /** @description Proposes electing a new alliance leader (who must already be a member). Requires Parliament level 11+. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -50520,25 +55096,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -50560,7 +55118,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_rename_asteroid": { + "/v2/mine/repair": { parameters: { query?: never; header?: never; @@ -50569,6 +55127,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -50579,14 +55141,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - asteroid_id: number; - name: string; }; }; }; responses: { - /** @description Proposes renaming an asteroid in the jurisdiction. Requires Parliament level 12+. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -50596,30 +55157,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -50641,7 +55185,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_members_only_mining_rights": { + "/v2/mine/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -50650,6 +55194,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -50660,12 +55208,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Proposes restricting new mining platforms in the jurisdiction to alliance members only. Requires Parliament level 13+. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -50675,30 +55226,33 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; }; }; }; @@ -50720,7 +55274,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_evict_mining_platform": { + "/v2/mine/view": { parameters: { query?: never; header?: never; @@ -50729,6 +55283,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -50739,14 +55297,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; - /** @description See get_mining_platforms_for_asteroid_in_jurisdiction. */ - platform_id: number; }; }; }; responses: { - /** @description Proposes destroying a mining platform on an asteroid. Requires Parliament level 14+. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -50756,30 +55313,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; }; }; }; @@ -50801,7 +55340,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_taxation": { + "/v2/miningministry/build": { parameters: { query?: never; header?: never; @@ -50810,6 +55349,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -50820,14 +55363,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - /** @description The amount of resources to tax per day. */ - taxes: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Proposes an unenforceable daily tax on all empires in the jurisdiction. Requires Parliament level 15+. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -50837,30 +55383,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -50882,7 +55419,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_foreign_aid": { + "/v2/miningministry/upgrade": { parameters: { query?: never; header?: never; @@ -50891,6 +55428,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -50901,15 +55442,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - planet_id: number; - /** @description The amount of resources to send to the receiving planet. */ - resources: number; }; }; }; responses: { - /** @description Proposes sending a foreign aid supply pod to a planet in the jurisdiction. Costs double the resources sent (half covers the pod, half is the aid). Limited to one per day, like normal supply pods. Requires Parliament level 16+. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -50919,30 +55458,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -50964,7 +55494,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_rename_uninhabited": { + "/v2/miningministry/downgrade": { parameters: { query?: never; header?: never; @@ -50973,6 +55503,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -50983,14 +55517,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - planet_id: number; - name: string; }; }; }; responses: { - /** @description Proposes renaming an uninhabited planet in the jurisdiction. Requires Parliament level 17+. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -51000,30 +55533,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -51045,7 +55561,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_members_only_colonization": { + "/v2/miningministry/demolish": { parameters: { query?: never; header?: never; @@ -51054,6 +55570,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -51064,12 +55584,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Proposes restricting new colonies in the jurisdiction to alliance members only. Requires Parliament level 18+. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -51084,25 +55605,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -51124,7 +55627,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_members_only_excavation": { + "/v2/miningministry/repair": { parameters: { query?: never; header?: never; @@ -51133,6 +55636,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -51143,12 +55650,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Proposes restricting new excavations in the jurisdiction to alliance members only. Requires Parliament level 18+. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -51158,30 +55666,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -51203,7 +55694,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_members_only_stations": { + "/v2/miningministry/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -51212,6 +55703,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -51222,12 +55717,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Proposes restricting new space stations in the jurisdiction to alliance members only. Requires Parliament level 18+. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -51237,30 +55735,33 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; }; }; }; @@ -51282,7 +55783,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_neutralize_bhg": { + "/v2/miningministry/view": { parameters: { query?: never; header?: never; @@ -51291,6 +55792,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -51301,12 +55806,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; }; responses: { - /** @description Proposes preventing non-alliance members from using Black Hole Generators on or from systems in the jurisdiction. Requires Parliament level 23+. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -51316,30 +55822,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; }; }; }; @@ -51361,7 +55849,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/parliament/propose_fire_bfg": { + "/v2/miningministry/view_platforms": { parameters: { query?: never; header?: never; @@ -51370,6 +55858,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View platforms. + * @description Returns a list of the mining platforms currently controlled by this ministry. + */ post: { parameters: { query?: never; @@ -51380,15 +55872,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - /** @description See get_bodies_for_star_in_jurisdiction. */ - body_id: number; - reason: string; }; }; }; responses: { - /** @description Proposes firing the BFG equipped on all space stations at a planet within the jurisdiction. Requires Parliament level 25+. */ + /** @description Returns a list of the mining platforms currently controlled by this ministry. */ 200: { headers: { [name: string]: unknown; @@ -51398,110 +55888,44 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; + max_platforms: number; + platforms: { + id: number; + asteroid: { + id: number; + name: string; + x: number; + y: number; + image: string; }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/parliament/allow_bhg_by_alliance": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - alliance_id: number; - }; - }; - }; - responses: { - /** @description Proposes allowing another alliance to use Black Hole Generators in this jurisdiction, ignoring members-only colonization/stations restrictions. Requires Parliament level 28+. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { + rutile_hour?: number; + chromite_hour?: number; + chalcopyrite_hour?: number; + galena_hour?: number; + gold_hour?: number; + uraninite_hour?: number; + bauxite_hour?: number; + goethite_hour?: number; + halite_hour?: number; + gypsum_hour?: number; + trona_hour?: number; + kerogen_hour?: number; + methane_hour?: number; + anthracite_hour?: number; + sulfur_hour?: number; + zircon_hour?: number; + monazite_hour?: number; + fluorite_hour?: number; + beryl_hour?: number; + magnetite_hour?: number; + /** @description A percent indicating production vs shipping efficiency. -1 means no ships are servicing the platforms, 0 means ships but no production, 1-99 means more shipping capacity than production, 100 means production and shipping are in harmony, and greater than 100 means more ships are needed. */ + shipping_capacity: number; + }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - proposition: { - id?: number; - name?: string; - description?: string; - votes_needed?: number; - votes_yes?: number; - votes_no?: number; - status?: string; - date_ends?: string; - proposed_by?: { - id?: number; - name?: string; - }; - /** - * @description Only present if this empire has voted. - * @enum {integer} - */ - my_vote?: 1 | 0; - }; }; }; }; @@ -51523,7 +55947,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pie/build": { + "/v2/miningministry/view_ships": { parameters: { query?: never; header?: never; @@ -51532,6 +55956,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View ships. + * @description Shows the ships that are working in the mining fleet, and available to work in it. + */ post: { parameters: { query?: never; @@ -51542,14 +55970,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Shows the ships that are working in the mining fleet, and available to work in it. */ 200: { headers: { [name: string]: unknown; @@ -51559,21 +55986,18 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { + ships: { + name: string; id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + task: string; + speed: number; + hold_size: number; + }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -51595,7 +56019,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pie/upgrade": { + "/v2/miningministry/add_cargo_ship_to_fleet": { parameters: { query?: never; header?: never; @@ -51604,6 +56028,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Add cargo ship to fleet. + * @description Takes a cargo ship from the space port and adds it to the mining fleet. + */ post: { parameters: { query?: never; @@ -51614,12 +56042,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the ship. */ + ship_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Takes a cargo ship from the space port and adds it to the mining fleet. */ 200: { headers: { [name: string]: unknown; @@ -51629,21 +56060,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -51665,7 +56086,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pie/downgrade": { + "/v2/miningministry/remove_cargo_ship_from_fleet": { parameters: { query?: never; header?: never; @@ -51674,6 +56095,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Remove cargo ship from fleet. + * @description Tells one of the cargo ships in the mining fleet to come home and park at the space port. + */ post: { parameters: { query?: never; @@ -51684,12 +56109,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the ship. */ + ship_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Tells one of the cargo ships in the mining fleet to come home and park at the space port. */ 200: { headers: { [name: string]: unknown; @@ -51699,13 +56127,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -51727,7 +56153,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pie/demolish": { + "/v2/miningministry/abandon_platform": { parameters: { query?: never; header?: never; @@ -51736,6 +56162,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Abandon platform. + * @description Closes down an existing mining platform. + */ post: { parameters: { query?: never; @@ -51746,12 +56176,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the mining platform. */ + platform_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Closes down an existing mining platform. */ 200: { headers: { [name: string]: unknown; @@ -51766,7 +56199,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -51788,7 +56220,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pie/repair": { + "/v2/miningministry/mass_abandon_platform": { parameters: { query?: never; header?: never; @@ -51797,6 +56229,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Mass abandon platform. + * @description Destroys all platforms controlled by this ministry. + */ post: { parameters: { query?: never; @@ -51807,12 +56243,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Destroys all platforms controlled by this ministry. */ 200: { headers: { [name: string]: unknown; @@ -51822,13 +56259,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -51850,7 +56285,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pie/get_stats_for_level": { + "/v2/missioncommand/build": { parameters: { query?: never; header?: never; @@ -51859,6 +56294,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -51869,13 +56308,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - level: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -51887,24 +56330,11 @@ export interface paths { result?: { building: { id: number; - name: string; - image: string; level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; }; status: { @@ -51912,6 +56342,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -51933,7 +56364,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pie/view": { + "/v2/missioncommand/upgrade": { parameters: { query?: never; header?: never; @@ -51942,6 +56373,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -51952,12 +56387,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -51967,12 +56403,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -51994,7 +56439,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pilottraining/build": { + "/v2/missioncommand/downgrade": { parameters: { query?: never; header?: never; @@ -52003,6 +56448,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -52013,14 +56462,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -52030,15 +56478,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -52066,7 +56506,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pilottraining/upgrade": { + "/v2/missioncommand/demolish": { parameters: { query?: never; header?: never; @@ -52075,6 +56515,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -52085,12 +56529,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -52100,15 +56545,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -52136,7 +56572,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pilottraining/downgrade": { + "/v2/missioncommand/repair": { parameters: { query?: never; header?: never; @@ -52145,6 +56581,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -52155,12 +56595,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -52198,7 +56639,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pilottraining/demolish": { + "/v2/missioncommand/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -52207,6 +56648,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -52217,12 +56662,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -52232,12 +56680,33 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -52259,7 +56728,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pilottraining/repair": { + "/v2/missioncommand/view": { parameters: { query?: never; header?: never; @@ -52268,6 +56737,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -52278,12 +56751,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -52299,7 +56773,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -52321,7 +56794,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pilottraining/get_stats_for_level": { + "/v2/missioncommand/get_missions": { parameters: { query?: never; header?: never; @@ -52330,6 +56803,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get missions. + * @description Returns a (non-exhaustive) list of missions eligible to be completed in this zone. Excludes missions already completed or above the empire's university level. + */ post: { parameters: { query?: never; @@ -52340,13 +56817,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Returns a (non-exhaustive) list of missions eligible to be completed in this zone. Excludes missions already completed or above the empire's university level. */ 200: { headers: { [name: string]: unknown; @@ -52356,28 +56833,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { + missions: { id: number; + max_university_level: number; + date_posted: string; name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; + description: string; + objectives: string[]; + rewards: string[]; + }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -52404,7 +56868,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pilottraining/view": { + "/v2/missioncommand/complete_mission": { parameters: { query?: never; header?: never; @@ -52413,6 +56877,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Complete mission. + * @description Completes a mission. Rejected if the objectives are not all met; otherwise the rewards are distributed. + */ post: { parameters: { query?: never; @@ -52423,12 +56891,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the mission to complete. */ + mission_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Completes a mission. Rejected if the objectives are not all met; otherwise the rewards are distributed. */ 200: { headers: { [name: string]: unknown; @@ -52438,7 +56909,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -52465,7 +56935,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/planetarycommand/build": { + "/v2/missioncommand/skip_mission": { parameters: { query?: never; header?: never; @@ -52474,6 +56944,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Skip mission. + * @description Skips a mission, hiding it from this list for 30 days. + */ post: { parameters: { query?: never; @@ -52484,14 +56958,15 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; + /** @description The unique id of the mission to skip. Won't appear again for this empire for 30 days. */ + mission_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Skips a mission, hiding it from this list for 30 days. */ 200: { headers: { [name: string]: unknown; @@ -52501,21 +56976,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -52537,7 +57002,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/planetarycommand/upgrade": { + "/v2/munitionslab/build": { parameters: { query?: never; header?: never; @@ -52546,6 +57011,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -52556,12 +57025,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -52607,7 +57081,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/planetarycommand/downgrade": { + "/v2/munitionslab/upgrade": { parameters: { query?: never; header?: never; @@ -52616,6 +57090,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -52626,12 +57104,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -52641,68 +57120,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; }; - buildings: components["schemas"]["buildings_list"]; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/planetarycommand/demolish": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; - responses: { - /** @description Instantly destroys a building. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -52730,7 +57156,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/planetarycommand/repair": { + "/v2/munitionslab/downgrade": { parameters: { query?: never; header?: never; @@ -52739,6 +57165,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -52749,12 +57179,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -52792,7 +57223,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/planetarycommand/get_stats_for_level": { + "/v2/munitionslab/demolish": { parameters: { query?: never; header?: never; @@ -52801,6 +57232,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -52811,13 +57246,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -52827,33 +57262,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -52875,7 +57289,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/planetarycommand/view": { + "/v2/munitionslab/repair": { parameters: { query?: never; header?: never; @@ -52884,6 +57298,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -52894,12 +57312,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -52915,19 +57334,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - /** @description Happiness required to settle the next colony. */ - next_colony_cost?: number; - /** @description Hourly rate and stored amount, keyed by food type (algae, bean, etc). */ - food?: { - [key: string]: number; - }; - /** @description Hourly rate and stored amount, keyed by ore type. */ - ore?: { - [key: string]: number; - }; - /** @description Seconds between supply pods being sent. */ - pod_delay?: number; - planet?: components["schemas"]["planet_status"]; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -52949,7 +57356,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/planetarycommand/view_plans": { + "/v2/munitionslab/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -52958,6 +57365,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -52968,12 +57379,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Lists all building plans this empire has collected. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -52983,12 +57397,28 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - plans: { - quantity?: number; - name?: string; - level?: number; - extra_build_level?: number; - }[]; + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -53015,7 +57445,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/planetarycommand/view_incoming_supply_chains": { + "/v2/munitionslab/view": { parameters: { query?: never; header?: never; @@ -53024,6 +57454,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -53034,12 +57468,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; }; responses: { - /** @description Lists supply chains feeding resources into this planet. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -53049,21 +57484,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - supply_chains: { - id?: number; - from_body?: { - id?: number; - name?: string; - x?: number; - y?: number; - image?: string; - }; - resource_hour?: number; - resource_type?: string; - percent_transferred?: number; - /** @enum {integer} */ - stalled?: 1 | 0; - }[]; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -53090,7 +57511,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/planetarycommand/subsidize_pod_cooldown": { + "/v2/naturalspring/build": { parameters: { query?: never; header?: never; @@ -53099,6 +57520,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -53109,12 +57534,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Spends 2 essentia to send a supply pod immediately. Returns the building view. Throws 1011. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -53124,12 +57554,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -53151,7 +57590,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/policestation/view": { + "/v2/naturalspring/upgrade": { parameters: { query?: never; header?: never; @@ -53160,6 +57599,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -53170,12 +57613,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of this module. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -53187,18 +57631,19 @@ export interface paths { result?: { building: { id: number; - name: string; - image: string; level: number; - x: number; - y: number; - efficiency: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -53220,7 +57665,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/policestation/view_prisoners": { + "/v2/naturalspring/downgrade": { parameters: { query?: never; header?: never; @@ -53229,6 +57674,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -53239,14 +57688,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - /** @description Defaults to 1. Each page contains 25 results. */ - page_number?: number; }; }; }; responses: { - /** @description Displays a list of the spies that have been captured. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -53256,21 +57704,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - /** @description Total captured spies across all pages (the pager is sized from this). */ - captured_count: number; - prisoners: { - id?: number; - name?: string; - level?: number; - /** @enum {string} */ - task?: "Captured" | "Prisoner Transport"; - sentence_expires?: string; - }[]; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -53292,7 +57732,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/policestation/execute_prisoner": { + "/v2/naturalspring/demolish": { parameters: { query?: never; header?: never; @@ -53301,6 +57741,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -53311,13 +57755,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - prisoner_id: number; }; }; }; responses: { - /** @description Executes a captured prisoner rather than letting them serve their sentence. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -53332,6 +57776,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -53353,7 +57798,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/policestation/release_prisoner": { + "/v2/naturalspring/repair": { parameters: { query?: never; header?: never; @@ -53362,6 +57807,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -53372,13 +57821,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - prisoner_id: number; }; }; }; responses: { - /** @description Releases a captured prisoner. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -53388,11 +57837,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -53414,7 +57865,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/policestation/view_foreign_spies": { + "/v2/naturalspring/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -53423,6 +57874,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -53433,14 +57888,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; - /** @description Defaults to 1. Each page contains 25 results. */ - page_number?: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Displays a list of the spies on your planet with a level lower than your Police Station. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -53450,14 +57906,28 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - /** @description Total foreign spies across all pages (the pager is sized from this). */ - spy_count: number; - spies: { - name?: string; - level?: number; - task?: string; - next_mission?: string; - }[]; + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -53484,7 +57954,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/policestation/view_foreign_ships": { + "/v2/naturalspring/view": { parameters: { query?: never; header?: never; @@ -53493,6 +57963,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -53503,14 +57977,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; - /** @description Defaults to 1. Each page contains 25 results. */ - page_number?: number; }; }; }; responses: { - /** @description Shows incoming foreign ships filtered by the ship's stealth vs the Police Station's level (525 * level >= stealth to be visible at all; the `from` block requires 675 * level >= stealth). */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -53520,24 +57993,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - ships: { - id?: number; - name?: string; - type?: string; - type_human?: string; - date_arrives?: string; - date_arrived?: string; - /** @description Only included if the ship's stealth is low enough relative to the Police Station's level. */ - from?: { - id?: number; - name?: string; - empire?: { - id?: number; - name?: string; - }; - }; - }[]; - number_of_ships: number; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -53564,7 +58020,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/policestation/view_ships_travelling": { + "/v2/network19/build": { parameters: { query?: never; header?: never; @@ -53573,6 +58029,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -53583,14 +58043,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - /** @description Defaults to 1. Each page contains 25 results. */ - page_number?: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Returns a list of ships travelling to or from this planet, regardless of destination space port. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -53600,28 +58063,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - ships_travelling: { - id?: number; - type?: string; - type_human?: string; - date_arrives?: string; - from?: { - id?: number; - type?: string; - name?: string; - }; - to?: { - id?: number; - type?: string; - name?: string; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; - }[]; - number_of_ships_travelling: number; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -53643,7 +58099,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/policestation/view_ships_orbiting": { + "/v2/network19/upgrade": { parameters: { query?: never; header?: never; @@ -53652,6 +58108,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -53662,14 +58122,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - /** @description Defaults to 1. Each page contains 25 results. */ - page_number?: number; }; }; }; responses: { - /** @description Shows foreign ships orbiting this planet, filtered by the ship's stealth vs the Police Station's level (525 * level >= stealth to be visible at all; the `from` block requires 675 * level >= stealth). */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -53679,29 +58138,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - ships: { - id?: number; - name?: string; - type?: string; - type_human?: string; - date_arrives?: string; - date_arrived?: string; - /** @description Only included if the ship's stealth is low enough relative to the Police Station's level. */ - from?: { - id?: number; - name?: string; - empire?: { - id?: number; - name?: string; - }; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; - }[]; - number_of_ships: number; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -53723,7 +58174,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/politicstraining/build": { + "/v2/network19/downgrade": { parameters: { query?: never; header?: never; @@ -53732,6 +58183,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -53742,14 +58197,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -53759,15 +58213,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -53795,139 +58241,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/politicstraining/upgrade": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; - responses: { - /** @description Adds the requested upgrade to the build queue. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/politicstraining/downgrade": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; - responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - buildings: components["schemas"]["buildings_list"]; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/politicstraining/demolish": { + "/v2/network19/demolish": { parameters: { query?: never; header?: never; @@ -53936,6 +58250,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -53946,6 +58264,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -53988,7 +58307,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/politicstraining/repair": { + "/v2/network19/repair": { parameters: { query?: never; header?: never; @@ -53997,6 +58316,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -54007,6 +58330,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -54050,7 +58374,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/politicstraining/get_stats_for_level": { + "/v2/network19/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -54059,6 +58383,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -54069,7 +58397,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -54133,7 +58463,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/politicstraining/view": { + "/v2/network19/view": { parameters: { query?: never; header?: never; @@ -54142,6 +58472,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -54152,6 +58486,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -54173,11 +58508,11 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - spies?: { - max_points: number; - points_per: number; - in_training: number; - }; + /** + * @description Whether a policy restricting coverage of this planet is currently in effect. See restrict_coverage. + * @enum {integer} + */ + restrict_coverage?: 1 | 0; }; }; }; @@ -54199,7 +58534,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/potato/build": { + "/v2/network19/restrict_coverage": { parameters: { query?: never; header?: never; @@ -54208,6 +58543,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Restrict coverage. + * @description Enacts or disbands a policy restricting what Network 19 covers about your planet. + */ post: { parameters: { query?: never; @@ -54218,14 +58557,18 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; + /** + * @description Whether to restrict what Network 19 covers about your planet. Restricting makes citizens unhappy. + * @enum {integer} + */ + onoff: 1 | 0; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Enacts or disbands a policy restricting what Network 19 covers about your planet. */ 200: { headers: { [name: string]: unknown; @@ -54235,21 +58578,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -54271,7 +58604,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/potato/upgrade": { + "/v2/network19/view_news": { parameters: { query?: never; header?: never; @@ -54280,6 +58613,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View news. + * @description Returns the top 100 headlines from this zone, and a list of RSS feeds usable outside the game to see the same news. + */ post: { parameters: { query?: never; @@ -54290,12 +58627,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Returns the top 100 headlines from this zone, and a list of RSS feeds usable outside the game to see the same news. */ 200: { headers: { [name: string]: unknown; @@ -54305,21 +58643,19 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; + news: { + headline: string; + date: string; + }[]; + /** @description Keyed by zone coordinates (e.g. "0|0|0"), values are RSS feed URLs. */ + feeds: { + [key: string]: string; }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -54341,7 +58677,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/potato/downgrade": { + "/v2/observatory/build": { parameters: { query?: never; header?: never; @@ -54350,6 +58686,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -54360,12 +58700,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -54375,7 +58720,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -54403,7 +58756,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/potato/demolish": { + "/v2/observatory/upgrade": { parameters: { query?: never; header?: never; @@ -54412,6 +58765,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -54422,12 +58779,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -54437,6 +58795,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -54464,7 +58831,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/potato/repair": { + "/v2/observatory/downgrade": { parameters: { query?: never; header?: never; @@ -54473,6 +58840,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -54483,12 +58854,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -54526,7 +58898,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/potato/get_stats_for_level": { + "/v2/observatory/demolish": { parameters: { query?: never; header?: never; @@ -54535,6 +58907,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -54545,13 +58921,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -54561,33 +58937,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -54609,7 +58964,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/potato/view": { + "/v2/observatory/repair": { parameters: { query?: never; header?: never; @@ -54618,6 +58973,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -54628,12 +58987,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -54649,6 +59009,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -54670,7 +59031,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/propulsion/build": { + "/v2/observatory/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -54679,6 +59040,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -54689,14 +59054,15 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -54708,11 +59074,24 @@ export interface paths { result?: { building: { id: number; + name: string; + image: string; level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; }; }; status: { @@ -54720,7 +59099,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -54742,7 +59120,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/propulsion/upgrade": { + "/v2/observatory/view": { parameters: { query?: never; header?: never; @@ -54751,6 +59129,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -54761,12 +59143,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -54776,21 +59159,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -54812,7 +59186,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/propulsion/downgrade": { + "/v2/observatory/get_probed_stars": { parameters: { query?: never; header?: never; @@ -54821,6 +59195,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get probed stars. + * @description Returns a list of the stars that have been probed by this planet. + */ post: { parameters: { query?: never; @@ -54831,12 +59209,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description Optional. Which page of probes to return. Defaults to 1. Up to 25 probes per page. */ + page_number?: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Returns a list of the stars that have been probed by this planet. */ 200: { headers: { [name: string]: unknown; @@ -54846,13 +59227,41 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + stars: { + id: number; + color: string; + name: string; + x: number; + y: number; + bodies: { + id: number; + x: number; + y: number; + star_id: number; + star_name: string; + orbit: number; + type: string; + name: string; + image: string; + size: number; + notes: string; + zone: string; + station?: { + id: number; + x: number; + y: number; + name: string; + }; + }[]; + }[]; + star_count: number; + max_probes: number; + travelling: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -54874,7 +59283,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/propulsion/demolish": { + "/v2/observatory/abandon_probe": { parameters: { query?: never; header?: never; @@ -54883,6 +59292,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Abandon probe. + * @description Deactivates a single probe, allowing it to burn up in the star. + */ post: { parameters: { query?: never; @@ -54893,12 +59306,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the star the probe is attached to. */ + star_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Deactivates a single probe, allowing it to burn up in the star. */ 200: { headers: { [name: string]: unknown; @@ -54913,7 +59329,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -54935,7 +59350,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/propulsion/repair": { + "/v2/observatory/abandon_all_probes": { parameters: { query?: never; header?: never; @@ -54944,6 +59359,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Abandon all probes. + * @description Deactivates all probes controlled by this observatory, allowing them to burn up in the stars. + */ post: { parameters: { query?: never; @@ -54954,12 +59373,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Deactivates all probes controlled by this observatory, allowing them to burn up in the stars. */ 200: { headers: { [name: string]: unknown; @@ -54969,13 +59389,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -54997,7 +59415,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/propulsion/get_stats_for_level": { + "/v2/operahouse/view": { parameters: { query?: never; header?: never; @@ -55006,6 +59424,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this module's properties. + * @description Retrieves the properties of this module. + */ post: { parameters: { query?: never; @@ -55016,13 +59438,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Retrieves the properties of this module. */ 200: { headers: { [name: string]: unknown; @@ -55037,84 +59459,10 @@ export interface paths { name: string; image: string; level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; + x: number; + y: number; + efficiency: number; }; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/propulsion/view": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; - responses: { - /** @description Retrieves the properties of the building. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -55141,7 +59489,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pyramidjunksculpture/build": { + "/v2/oracleofanid/build": { parameters: { query?: never; header?: never; @@ -55150,6 +59498,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -55160,8 +59512,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -55213,7 +59568,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pyramidjunksculpture/upgrade": { + "/v2/oracleofanid/upgrade": { parameters: { query?: never; header?: never; @@ -55222,6 +59577,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -55232,6 +59591,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -55283,7 +59643,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pyramidjunksculpture/downgrade": { + "/v2/oracleofanid/downgrade": { parameters: { query?: never; header?: never; @@ -55292,6 +59652,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -55302,6 +59666,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -55345,7 +59710,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pyramidjunksculpture/demolish": { + "/v2/oracleofanid/demolish": { parameters: { query?: never; header?: never; @@ -55354,6 +59719,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -55364,6 +59733,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -55406,7 +59776,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pyramidjunksculpture/repair": { + "/v2/oracleofanid/repair": { parameters: { query?: never; header?: never; @@ -55415,6 +59785,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -55425,6 +59799,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -55468,7 +59843,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pyramidjunksculpture/get_stats_for_level": { + "/v2/oracleofanid/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -55477,6 +59852,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -55487,7 +59866,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -55551,68 +59932,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/pyramidjunksculpture/view": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; - responses: { - /** @description Retrieves the properties of the building. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/ravine/build": { + "/v2/oracleofanid/view": { parameters: { query?: never; header?: never; @@ -55621,6 +59941,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -55631,8 +59955,231 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/oracleofanid/get_star": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Get star. + * @description Retrieves info on a single star, including its bodies, even without a probe there. The Oracle's range is 10 map units per level; requesting a star outside that range throws 1009. Use Map/search_stars to look up a star's id by name. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description The unique id of the star. */ + star_id: number; + }; + }; + }; + responses: { + /** @description Retrieves info on a single star, including its bodies, even without a probe there. The Oracle's range is 10 map units per level; requesting a star outside that range throws 1009. Use Map/search_stars to look up a star's id by name. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + star: { + id: number; + color: string; + name: string; + x: number; + y: number; + bodies: components["schemas"]["body_status"][]; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/oracleofanid/get_probed_stars": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Get probed stars. + * @description Returns all stars within range of the Oracle. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description Optional. Defaults to 1. Each page contains page_size records. */ + page_number?: number; + /** @description Optional. Defaults to 25. */ + page_size?: number; + }; + }; + }; + responses: { + /** @description Returns all stars within range of the Oracle. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + stars: { + id: number; + color: string; + name: string; + x: number; + y: number; + bodies: components["schemas"]["body_status"][]; + }[]; + star_count: number; + max_distance: number; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/orerefinery/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -55684,7 +60231,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/ravine/upgrade": { + "/v2/orerefinery/upgrade": { parameters: { query?: never; header?: never; @@ -55693,6 +60240,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -55703,6 +60254,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -55754,7 +60306,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/ravine/downgrade": { + "/v2/orerefinery/downgrade": { parameters: { query?: never; header?: never; @@ -55763,6 +60315,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -55773,6 +60329,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -55816,7 +60373,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/ravine/demolish": { + "/v2/orerefinery/demolish": { parameters: { query?: never; header?: never; @@ -55825,6 +60382,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -55835,6 +60396,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -55877,7 +60439,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/ravine/repair": { + "/v2/orerefinery/repair": { parameters: { query?: never; header?: never; @@ -55886,6 +60448,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -55896,6 +60462,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -55939,7 +60506,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/ravine/get_stats_for_level": { + "/v2/orerefinery/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -55948,6 +60515,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -55958,7 +60529,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -56022,7 +60595,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/ravine/view": { + "/v2/orerefinery/view": { parameters: { query?: never; header?: never; @@ -56031,6 +60604,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -56041,6 +60618,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -56083,7 +60661,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/rockyoutcrop/build": { + "/v2/orestorage/build": { parameters: { query?: never; header?: never; @@ -56092,6 +60670,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -56102,8 +60684,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -56155,7 +60740,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/rockyoutcrop/upgrade": { + "/v2/orestorage/upgrade": { parameters: { query?: never; header?: never; @@ -56164,6 +60749,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -56174,6 +60763,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -56225,7 +60815,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/rockyoutcrop/downgrade": { + "/v2/orestorage/downgrade": { parameters: { query?: never; header?: never; @@ -56234,6 +60824,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -56244,6 +60838,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -56287,7 +60882,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/rockyoutcrop/demolish": { + "/v2/orestorage/demolish": { parameters: { query?: never; header?: never; @@ -56296,6 +60891,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -56306,6 +60905,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -56348,7 +60948,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/rockyoutcrop/repair": { + "/v2/orestorage/repair": { parameters: { query?: never; header?: never; @@ -56357,6 +60957,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -56367,6 +60971,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -56410,7 +61015,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/rockyoutcrop/get_stats_for_level": { + "/v2/orestorage/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -56419,6 +61024,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -56429,7 +61038,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -56493,7 +61104,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/rockyoutcrop/view": { + "/v2/orestorage/view": { parameters: { query?: never; header?: never; @@ -56502,6 +61113,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -56512,6 +61127,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -56533,6 +61149,10 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + /** @description Keyed by ore type. */ + ore_stored?: { + [key: string]: number; + }; }; }; }; @@ -56554,7 +61174,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/sand/build": { + "/v2/orestorage/dump": { parameters: { query?: never; header?: never; @@ -56563,6 +61183,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Dump ore as waste. + * @description Converts ore into waste. + */ post: { parameters: { query?: never; @@ -56573,14 +61197,17 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; + /** @description Ore type to convert into waste, e.g. gold, bauxite, galena. */ + type: string; + /** @description The amount to convert into waste. */ + amount: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Converts ore into waste. */ 200: { headers: { [name: string]: unknown; @@ -56590,21 +61217,11 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -56626,7 +61243,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/sand/upgrade": { + "/v2/oversight/build": { parameters: { query?: never; header?: never; @@ -56635,6 +61252,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -56645,6 +61266,86 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/oversight/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -56696,7 +61397,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/sand/downgrade": { + "/v2/oversight/downgrade": { parameters: { query?: never; header?: never; @@ -56705,6 +61406,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -56715,6 +61420,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -56758,7 +61464,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/sand/demolish": { + "/v2/oversight/demolish": { parameters: { query?: never; header?: never; @@ -56767,6 +61473,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -56777,6 +61487,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -56819,7 +61530,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/sand/repair": { + "/v2/oversight/repair": { parameters: { query?: never; header?: never; @@ -56828,6 +61539,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -56838,6 +61553,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -56881,7 +61597,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/sand/get_stats_for_level": { + "/v2/oversight/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -56890,6 +61606,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -56900,7 +61620,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -56964,7 +61686,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/sand/view": { + "/v2/oversight/view": { parameters: { query?: never; header?: never; @@ -56973,6 +61695,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -56983,6 +61709,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -57025,7 +61752,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/saw/build": { + "/v2/pancake/build": { parameters: { query?: never; header?: never; @@ -57034,6 +61761,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -57044,8 +61775,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -57097,7 +61831,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/saw/upgrade": { + "/v2/pancake/upgrade": { parameters: { query?: never; header?: never; @@ -57106,6 +61840,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -57116,6 +61854,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -57167,7 +61906,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/saw/downgrade": { + "/v2/pancake/downgrade": { parameters: { query?: never; header?: never; @@ -57176,6 +61915,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -57186,6 +61929,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -57229,7 +61973,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/saw/demolish": { + "/v2/pancake/demolish": { parameters: { query?: never; header?: never; @@ -57238,6 +61982,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -57248,6 +61996,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -57290,7 +62039,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/saw/repair": { + "/v2/pancake/repair": { parameters: { query?: never; header?: never; @@ -57299,6 +62048,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -57309,6 +62062,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -57352,7 +62106,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/saw/get_stats_for_level": { + "/v2/pancake/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -57361,6 +62115,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -57371,7 +62129,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -57435,7 +62195,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/saw/view": { + "/v2/pancake/view": { parameters: { query?: never; header?: never; @@ -57444,6 +62204,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -57454,6 +62218,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -57496,7 +62261,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/security/build": { + "/v2/pantheonofhagness/build": { parameters: { query?: never; header?: never; @@ -57505,6 +62270,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -57515,8 +62284,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -57568,7 +62340,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/security/upgrade": { + "/v2/pantheonofhagness/upgrade": { parameters: { query?: never; header?: never; @@ -57577,6 +62349,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -57587,6 +62363,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -57638,7 +62415,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/security/downgrade": { + "/v2/pantheonofhagness/downgrade": { parameters: { query?: never; header?: never; @@ -57647,6 +62424,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -57657,6 +62438,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -57700,7 +62482,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/security/demolish": { + "/v2/pantheonofhagness/demolish": { parameters: { query?: never; header?: never; @@ -57709,6 +62491,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -57719,6 +62505,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -57761,7 +62548,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/security/repair": { + "/v2/pantheonofhagness/repair": { parameters: { query?: never; header?: never; @@ -57770,6 +62557,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -57780,6 +62571,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -57823,7 +62615,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/security/get_stats_for_level": { + "/v2/pantheonofhagness/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -57832,6 +62624,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -57842,7 +62638,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -57906,7 +62704,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/security/view": { + "/v2/pantheonofhagness/view": { parameters: { query?: never; header?: never; @@ -57915,6 +62713,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -57925,6 +62727,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -57967,7 +62770,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/security/view_prisoners": { + "/v2/park/build": { parameters: { query?: never; header?: never; @@ -57976,6 +62779,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -57986,14 +62793,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - /** @description Defaults to 1. Each page contains 25 spies. */ - page_number?: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Displays a list of the spies that have been captured. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -58003,21 +62813,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - /** @description Total captured spies across all pages (the pager is sized from this). */ - captured_count: number; - prisoners: { - id: number; - name: string; - level: number; - /** @enum {string} */ - task: "Captured" | "Prisoner Transport"; - sentence_expires: string; - }[]; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -58039,7 +62849,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/security/execute_prisoner": { + "/v2/park/upgrade": { parameters: { query?: never; header?: never; @@ -58048,6 +62858,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -58058,13 +62872,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - prisoner_id: number; }; }; }; responses: { - /** @description Executes a prisoner rather than letting them serve out their sentence. Costs 10,000 times the prisoner's level in happiness from your planet. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -58074,11 +62888,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -58100,7 +62924,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/security/release_prisoner": { + "/v2/park/downgrade": { parameters: { query?: never; header?: never; @@ -58109,6 +62933,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -58119,13 +62947,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - prisoner_id: number; }; }; }; responses: { - /** @description Releases a captured prisoner. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -58135,11 +62963,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -58161,7 +62991,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/security/view_foreign_spies": { + "/v2/park/demolish": { parameters: { query?: never; header?: never; @@ -58170,6 +63000,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -58180,14 +63014,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - /** @description Defaults to 1. Each page contains 25 spies. */ - page_number?: number; }; }; }; responses: { - /** @description Displays a list of the spies that are on your planet and have a level lower than your security ministry. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -58202,14 +63035,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - /** @description Total foreign spies across all pages (the pager is sized from this). */ - spy_count: number; - spies: { - name: string; - level: number; - task: string; - next_mission: string; - }[]; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -58231,7 +63057,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shake/build": { + "/v2/park/repair": { parameters: { query?: never; header?: never; @@ -58240,6 +63066,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -58250,14 +63080,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -58267,15 +63096,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -58303,7 +63124,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shake/upgrade": { + "/v2/park/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -58312,6 +63133,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -58322,12 +63147,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -58339,11 +63167,24 @@ export interface paths { result?: { building: { id: number; + name: string; + image: string; level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; }; }; status: { @@ -58351,7 +63192,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -58373,7 +63213,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shake/downgrade": { + "/v2/park/view": { parameters: { query?: never; header?: never; @@ -58382,6 +63222,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -58392,12 +63236,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -58413,7 +63258,12 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; + party?: { + seconds_remaining?: number; + happiness?: number; + /** @enum {integer} */ + can_throw?: 1 | 0; + }; }; }; }; @@ -58435,7 +63285,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shake/demolish": { + "/v2/park/throw_a_party": { parameters: { query?: never; header?: never; @@ -58444,6 +63294,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Throw a party. + * @description Spends 10,000 food to throw a day-long party generating happiness. Returns the building view. + */ post: { parameters: { query?: never; @@ -58454,12 +63308,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Spends 10,000 food to throw a day-long party generating happiness. Returns the building view. */ 200: { headers: { [name: string]: unknown; @@ -58469,12 +63324,18 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; + party: { + seconds_remaining?: number; + happiness?: number; + /** @enum {integer} */ + can_throw?: 1 | 0; + }; }; }; }; @@ -58496,7 +63357,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shake/repair": { + "/v2/park/subsidize_party": { parameters: { query?: never; header?: never; @@ -58505,6 +63366,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Subsidize party. + * @description Spends 2 essentia to complete the current party immediately. Returns the building view. + */ post: { parameters: { query?: never; @@ -58515,12 +63380,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Spends 2 essentia to complete the current party immediately. Returns the building view. */ 200: { headers: { [name: string]: unknown; @@ -58536,7 +63402,12 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; + party: { + seconds_remaining?: number; + happiness?: number; + /** @enum {integer} */ + can_throw?: 1 | 0; + }; }; }; }; @@ -58558,7 +63429,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shake/get_stats_for_level": { + "/v2/parliament/view": { parameters: { query?: never; header?: never; @@ -58567,6 +63438,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this module's properties. + * @description Retrieves the properties of this module. + */ post: { parameters: { query?: never; @@ -58577,13 +63452,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Retrieves the properties of this module. */ 200: { headers: { [name: string]: unknown; @@ -58598,22 +63473,9 @@ export interface paths { name: string; image: string; level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; + x: number; + y: number; + efficiency: number; }; status: { server: components["schemas"]["server_status"]; @@ -58641,7 +63503,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shake/view": { + "/v2/parliament/view_laws": { parameters: { query?: never; header?: never; @@ -58650,6 +63512,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View laws. + * @description Lists the laws currently in effect for this station's jurisdiction. Still usable, but superseded by the equivalent call on Body. + */ post: { parameters: { query?: never; @@ -58660,12 +63526,13 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The unique id of the space station. */ + body_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Lists the laws currently in effect for this station's jurisdiction. Still usable, but superseded by the equivalent call on Body. */ 200: { headers: { [name: string]: unknown; @@ -58675,7 +63542,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + laws: { + id?: number; + name?: string; + description?: string; + date_enacted?: string; + }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -58702,7 +63574,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shipyard/build": { + "/v2/parliament/view_propositions": { parameters: { query?: never; header?: never; @@ -58711,6 +63583,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View propositions. + * @description Returns a list of the pending propositions. + */ post: { parameters: { query?: never; @@ -58721,14 +63597,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Returns a list of the pending propositions. */ 200: { headers: { [name: string]: unknown; @@ -58738,21 +63613,30 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; + propositions: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; }; - }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -58774,7 +63658,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shipyard/upgrade": { + "/v2/parliament/view_taxes_collected": { parameters: { query?: never; header?: never; @@ -58783,6 +63667,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View taxes collected. + * @description Returns, for each empire that has paid taxes, their payments for today and the previous six days plus the seven-day total. + */ post: { parameters: { query?: never; @@ -58793,12 +63681,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Returns, for each empire that has paid taxes, their payments for today and the previous six days plus the seven-day total. */ 200: { headers: { [name: string]: unknown; @@ -58808,21 +63697,18 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + taxes_collected: { + id?: number; + name?: string; + /** @description Element 0 is today, followed by the previous six days. */ + paid?: number[]; + total?: number; + }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -58844,7 +63730,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shipyard/downgrade": { + "/v2/parliament/get_stars_in_jurisdiction": { parameters: { query?: never; header?: never; @@ -58853,6 +63739,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get stars in jurisdiction. + * @description Returns a list of the stars in the jurisdiction of this space station. + */ post: { parameters: { query?: never; @@ -58863,12 +63753,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Returns a list of the stars in the jurisdiction of this space station. */ 200: { headers: { [name: string]: unknown; @@ -58878,13 +63769,25 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + stars: { + id?: number; + name?: string; + color?: string; + x?: number; + y?: number; + /** @description Only present if this star is under the influence of a space station. */ + station?: { + id?: number; + x?: number; + y?: number; + name?: string; + }; + }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -58906,7 +63809,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shipyard/demolish": { + "/v2/parliament/get_bodies_for_star_in_jurisdiction": { parameters: { query?: never; header?: never; @@ -58915,6 +63818,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get bodies for star in jurisdiction. + * @description Returns a list of the bodies for a star in the jurisdiction of the space station. + */ post: { parameters: { query?: never; @@ -58925,12 +63832,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of a star in jurisdiction. See get_stars_in_jurisdiction. */ + star_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Returns a list of the bodies for a star in the jurisdiction of the space station. */ 200: { headers: { [name: string]: unknown; @@ -58940,12 +63850,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + bodies: components["schemas"]["body_status"][]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -58967,7 +63877,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shipyard/repair": { + "/v2/parliament/get_mining_platforms_for_asteroid_in_jurisdiction": { parameters: { query?: never; header?: never; @@ -58976,6 +63886,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get mining platforms for asteroid in jurisdiction. + * @description Returns a list of the mining platforms for an asteroid in the jurisdiction of the space station. + */ post: { parameters: { query?: never; @@ -58986,12 +63900,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of an asteroid in jurisdiction. See get_bodies_for_star_in_jurisdiction. */ + asteroid_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Returns a list of the mining platforms for an asteroid in the jurisdiction of the space station. */ 200: { headers: { [name: string]: unknown; @@ -59001,13 +63918,18 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + platforms: { + id?: number; + empire?: { + id?: number; + name?: string; + }; + }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -59029,7 +63951,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shipyard/get_stats_for_level": { + "/v2/parliament/cast_vote": { parameters: { query?: never; header?: never; @@ -59038,6 +63960,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Cast vote. + * @description Casts a vote for or against a proposition. Cannot be voted on using a sitter password. + */ post: { parameters: { query?: never; @@ -59048,13 +63974,20 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; + /** @description The id of the proposition being voted on. See view_propositions. */ + proposition_id: number; + /** + * @description 1 for yes, 0 for no. Defaults to 0. + * @enum {integer} + */ + vote?: 1 | 0; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Casts a vote for or against a proposition. Cannot be voted on using a sitter password. */ 200: { headers: { [name: string]: unknown; @@ -59064,33 +63997,118 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/parliament/propose_writ": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Propose writ. + * @description Proposes an unenforceable law (writ). Requires Parliament level 4+. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the Parliament building. */ + building_id: number; + /** @description The name of the law. */ + title: string; + /** @description A detailed description of what the law intends to promote or prohibit. Same rules as an Inbox message body. */ + description: string; + }; + }; + }; + responses: { + /** @description Proposes an unenforceable law (writ). Requires Parliament level 4+. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -59112,7 +64130,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shipyard/view": { + "/v2/parliament/propose_repeal_law": { parameters: { query?: never; header?: never; @@ -59121,6 +64139,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Propose repeal law. + * @description Proposes repealing an existing law. Requires Parliament level 5+. + */ post: { parameters: { query?: never; @@ -59131,12 +64153,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the Parliament building. */ building_id: number; + /** @description The id of the law to repeal. */ + law_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Proposes repealing an existing law. Requires Parliament level 5+. */ 200: { headers: { [name: string]: unknown; @@ -59146,12 +64171,30 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -59173,7 +64216,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shipyard/view_build_queue": { + "/v2/parliament/propose_transfer_station_ownership": { parameters: { query?: never; header?: never; @@ -59182,6 +64225,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Propose transfer station ownership. + * @description Proposes transferring ownership of the station to another alliance member. Requires Parliament level 6+. + */ post: { parameters: { query?: never; @@ -59192,14 +64239,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the Parliament building. */ building_id: number; - /** @description Defaults to 1. 25 items per page. */ - page_number?: number; + /** @description The id of the alliance member to receive the station. */ + to_empire_id: number; }; }; }; responses: { - /** @description Retrieves the ships currently being built at this shipyard. */ + /** @description Proposes transferring ownership of the station to another alliance member. Requires Parliament level 6+. */ 200: { headers: { [name: string]: unknown; @@ -59214,14 +64262,25 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - number_of_ships_building: number; - cost_to_subsidize: number; - ships_building: { - id: number; - type: string; - type_human: string; - date_completed: string; - }[]; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -59243,7 +64302,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shipyard/subsidize_build_queue": { + "/v2/parliament/propose_rename_star": { parameters: { query?: never; header?: never; @@ -59252,6 +64311,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Propose rename star. + * @description Proposes renaming a star. Requires Parliament level 8+. + */ post: { parameters: { query?: never; @@ -59262,12 +64325,17 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the Parliament building. */ building_id: number; + /** @description The id of the star to rename. */ + star_id: number; + /** @description The new name of the star. */ + name: string; }; }; }; responses: { - /** @description Completes the entire build queue immediately for 1 essentia per ship. Throws 1011. */ + /** @description Proposes renaming a star. Requires Parliament level 8+. */ 200: { headers: { [name: string]: unknown; @@ -59282,14 +64350,25 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - number_of_ships_building: number; - cost_to_subsidize: number; - ships_building: { - id: number; - type: string; - type_human: string; - date_completed: string; - }[]; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -59311,7 +64390,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shipyard/subsidize_ship": { + "/v2/parliament/propose_broadcast_on_network19": { parameters: { query?: never; header?: never; @@ -59320,6 +64399,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Propose broadcast on Network 19. + * @description Proposes broadcasting a message on Network 19. Requires Parliament level 9+. + */ post: { parameters: { query?: never; @@ -59330,13 +64413,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the Parliament building. */ building_id: number; - ship_id: number; + /** @description Cannot contain special characters or profanity. */ + message: string; }; }; }; responses: { - /** @description Completes a single ship immediately for 1 essentia. Throws 1011. */ + /** @description Proposes broadcasting a message on Network 19. Requires Parliament level 9+. */ 200: { headers: { [name: string]: unknown; @@ -59351,14 +64436,25 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - number_of_ships_building: number; - cost_to_subsidize: number; - ships_building: { - id: number; - type: string; - type_human: string; - date_completed: string; - }[]; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -59380,7 +64476,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shipyard/get_buildable": { + "/v2/parliament/propose_induct_member": { parameters: { query?: never; header?: never; @@ -59389,6 +64485,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Propose induct member. + * @description Proposes inducting a new member into the alliance; if passed, an invitation is sent. Requires Parliament level 10+. + */ post: { parameters: { query?: never; @@ -59399,14 +64499,17 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the Parliament building. */ building_id: number; - /** @enum {string} */ - tag?: "Trade" | "Colonization" | "Intelligence" | "Exploration" | "War" | "Mining"; + /** @description The id of the empire proposed for membership. */ + empire_id: number; + /** @description Optional personalized welcome message included in the invitation. */ + message?: string; }; }; }; responses: { - /** @description Lists buildable ship types with cost and availability. */ + /** @description Proposes inducting a new member into the alliance; if passed, an invitation is sent. Requires Parliament level 10+. */ 200: { headers: { [name: string]: unknown; @@ -59416,36 +64519,30 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - /** @description Keyed by ship type. */ - buildable: { - [key: string]: { - can: boolean; - reason?: unknown[]; - cost: { - seconds?: number; - food?: number; - water?: number; - energy?: number; - ore?: number; - waste?: number; - }; - attributes: { - speed?: number; - hold_size?: number; - max_occupants?: number; - combat?: number; - stealth?: number; - }; - }; - }; - docks_available: number; - build_queue_max: number; - build_queue_used: number; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -59467,7 +64564,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shipyard/build_ship": { + "/v2/parliament/propose_expel_member": { parameters: { query?: never; header?: never; @@ -59476,6 +64573,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Propose expel member. + * @description Proposes expelling a member from the alliance. Requires Parliament level 10+. + */ post: { parameters: { query?: never; @@ -59486,15 +64587,17 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the Parliament building. */ building_id: number; - type: string; - /** @description Defaults to 1. */ - quantity?: number; + /** @description The id of the empire proposed for removal. */ + empire_id: number; + /** @description Optional reason. Cannot contain restricted characters or profanity. */ + message?: string; }; }; }; responses: { - /** @description Queues ships for construction at this shipyard. */ + /** @description Proposes expelling a member from the alliance. Requires Parliament level 10+. */ 200: { headers: { [name: string]: unknown; @@ -59509,14 +64612,25 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - number_of_ships_building: number; - cost_to_subsidize: number; - ships_building: { - id: number; - type: string; - type_human: string; - date_completed: string; - }[]; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -59538,7 +64652,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/shipyard/build_ships": { + "/v2/parliament/propose_elect_new_leader": { parameters: { query?: never; header?: never; @@ -59547,6 +64661,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Propose elect new leader. + * @description Proposes electing a new alliance leader (who must already be a member). Requires Parliament level 11+. + */ post: { parameters: { query?: never; @@ -59557,22 +64675,15 @@ export interface paths { requestBody?: { content: { "application/json": { - options: { - type: string; - /** @description Defaults to 1. */ - quantity?: number; - /** @description Alternative to building_id. */ - body_id?: number; - /** @description A single shipyard id, or an array of shipyard ids. */ - building_id?: number | number[]; - /** @enum {string} */ - autoselect?: "all" | "higher" | "only"; - }; + /** @description The unique id of the Parliament building. */ + building_id: number; + /** @description The id of the alliance member to elect as leader. */ + to_empire_id: number; }; }; }; responses: { - /** @description Queues ships for construction across multiple shipyards at once. */ + /** @description Proposes electing a new alliance leader (who must already be a member). Requires Parliament level 11+. */ 200: { headers: { [name: string]: unknown; @@ -59587,6 +64698,25 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -59608,7 +64738,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/singularity/build": { + "/v2/parliament/propose_rename_asteroid": { parameters: { query?: never; header?: never; @@ -59617,6 +64747,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Propose rename asteroid. + * @description Proposes renaming an asteroid in the jurisdiction. Requires Parliament level 12+. + */ post: { parameters: { query?: never; @@ -59627,14 +64761,17 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the Parliament building. */ + building_id: number; + /** @description The id of the asteroid in the jurisdiction to rename. */ + asteroid_id: number; + /** @description The new name (max 30 characters, no profanity or special characters). */ + name: string; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Proposes renaming an asteroid in the jurisdiction. Requires Parliament level 12+. */ 200: { headers: { [name: string]: unknown; @@ -59644,21 +64781,30 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -59680,7 +64826,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/singularity/upgrade": { + "/v2/parliament/propose_members_only_mining_rights": { parameters: { query?: never; header?: never; @@ -59689,6 +64835,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Propose members only mining rights. + * @description Proposes restricting new mining platforms in the jurisdiction to alliance members only. Requires Parliament level 13+. + */ post: { parameters: { query?: never; @@ -59699,12 +64849,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the Parliament building. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Proposes restricting new mining platforms in the jurisdiction to alliance members only. Requires Parliament level 13+. */ 200: { headers: { [name: string]: unknown; @@ -59714,21 +64865,30 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -59750,7 +64910,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/singularity/downgrade": { + "/v2/parliament/propose_evict_mining_platform": { parameters: { query?: never; header?: never; @@ -59759,6 +64919,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Propose evict mining platform. + * @description Proposes destroying a mining platform on an asteroid. Requires Parliament level 14+. + */ post: { parameters: { query?: never; @@ -59769,12 +64933,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the Parliament building. */ building_id: number; + /** @description See get_mining_platforms_for_asteroid_in_jurisdiction. */ + platform_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Proposes destroying a mining platform on an asteroid. Requires Parliament level 14+. */ 200: { headers: { [name: string]: unknown; @@ -59784,13 +64951,30 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -59812,7 +64996,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/singularity/demolish": { + "/v2/parliament/propose_taxation": { parameters: { query?: never; header?: never; @@ -59821,6 +65005,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Propose taxation. + * @description Proposes an unenforceable daily tax on all empires in the jurisdiction. Requires Parliament level 15+. + */ post: { parameters: { query?: never; @@ -59831,12 +65019,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the Parliament building. */ building_id: number; + /** @description The amount of resources to tax per day. */ + taxes: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Proposes an unenforceable daily tax on all empires in the jurisdiction. Requires Parliament level 15+. */ 200: { headers: { [name: string]: unknown; @@ -59851,7 +65042,25 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -59873,7 +65082,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/singularity/repair": { + "/v2/parliament/propose_foreign_aid": { parameters: { query?: never; header?: never; @@ -59882,6 +65091,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Propose foreign aid. + * @description Proposes sending a foreign aid supply pod to a planet in the jurisdiction. Costs double the resources sent (half covers the pod, half is the aid). Limited to one per day, like normal supply pods. Requires Parliament level 16+. + */ post: { parameters: { query?: never; @@ -59892,12 +65105,17 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the Parliament building. */ building_id: number; + /** @description The id of the planet to receive the foreign aid. */ + planet_id: number; + /** @description The amount of resources to send to the receiving planet. */ + resources: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Proposes sending a foreign aid supply pod to a planet in the jurisdiction. Costs double the resources sent (half covers the pod, half is the aid). Limited to one per day, like normal supply pods. Requires Parliament level 16+. */ 200: { headers: { [name: string]: unknown; @@ -59907,13 +65125,30 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -59935,7 +65170,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/singularity/get_stats_for_level": { + "/v2/parliament/propose_rename_uninhabited": { parameters: { query?: never; header?: never; @@ -59944,6 +65179,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Propose rename uninhabited. + * @description Proposes renaming an uninhabited planet in the jurisdiction. Requires Parliament level 17+. + */ post: { parameters: { query?: never; @@ -59954,13 +65193,17 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the Parliament building. */ building_id: number; - level: number; + /** @description The id of the uninhabited planet in the jurisdiction to rename. */ + planet_id: number; + /** @description The new name (max 30 characters, no profanity or special characters). */ + name: string; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Proposes renaming an uninhabited planet in the jurisdiction. Requires Parliament level 17+. */ 200: { headers: { [name: string]: unknown; @@ -59970,33 +65213,30 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -60018,7 +65258,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/singularity/view": { + "/v2/parliament/propose_members_only_colonization": { parameters: { query?: never; header?: never; @@ -60027,6 +65267,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Propose members only colonization. + * @description Proposes restricting new colonies in the jurisdiction to alliance members only. Requires Parliament level 18+. + */ post: { parameters: { query?: never; @@ -60037,12 +65281,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the Parliament building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Proposes restricting new colonies in the jurisdiction to alliance members only. Requires Parliament level 18+. */ 200: { headers: { [name: string]: unknown; @@ -60052,12 +65297,30 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -60079,7 +65342,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/soup/build": { + "/v2/parliament/propose_members_only_excavation": { parameters: { query?: never; header?: never; @@ -60088,6 +65351,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Propose members only excavation. + * @description Proposes restricting new excavations in the jurisdiction to alliance members only. Requires Parliament level 18+. + */ post: { parameters: { query?: never; @@ -60098,14 +65365,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the Parliament building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Proposes restricting new excavations in the jurisdiction to alliance members only. Requires Parliament level 18+. */ 200: { headers: { [name: string]: unknown; @@ -60115,21 +65381,30 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -60151,7 +65426,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/soup/upgrade": { + "/v2/parliament/propose_members_only_stations": { parameters: { query?: never; header?: never; @@ -60160,6 +65435,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Propose members only stations. + * @description Proposes restricting new space stations in the jurisdiction to alliance members only. Requires Parliament level 18+. + */ post: { parameters: { query?: never; @@ -60170,12 +65449,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the Parliament building. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Proposes restricting new space stations in the jurisdiction to alliance members only. Requires Parliament level 18+. */ 200: { headers: { [name: string]: unknown; @@ -60185,21 +65465,30 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -60221,7 +65510,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/soup/downgrade": { + "/v2/parliament/propose_neutralize_bhg": { parameters: { query?: never; header?: never; @@ -60230,6 +65519,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Propose neutralize BHG. + * @description Proposes preventing non-alliance members from using Black Hole Generators on or from systems in the jurisdiction. Requires Parliament level 23+. + */ post: { parameters: { query?: never; @@ -60240,12 +65533,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the Parliament building. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Proposes preventing non-alliance members from using Black Hole Generators on or from systems in the jurisdiction. Requires Parliament level 23+. */ 200: { headers: { [name: string]: unknown; @@ -60255,13 +65549,30 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -60283,7 +65594,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/soup/demolish": { + "/v2/parliament/propose_fire_bfg": { parameters: { query?: never; header?: never; @@ -60292,6 +65603,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Propose fire BFG. + * @description Proposes firing the BFG equipped on all space stations at a planet within the jurisdiction. Requires Parliament level 25+. + */ post: { parameters: { query?: never; @@ -60302,12 +65617,17 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the Parliament building. */ building_id: number; + /** @description The planet to fire at. See get_bodies_for_star_in_jurisdiction. */ + body_id: number; + /** @description An explicit reason why the BFG should be fired. Same rules as an Inbox message body. */ + reason: string; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Proposes firing the BFG equipped on all space stations at a planet within the jurisdiction. Requires Parliament level 25+. */ 200: { headers: { [name: string]: unknown; @@ -60322,7 +65642,25 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -60344,7 +65682,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/soup/repair": { + "/v2/parliament/allow_bhg_by_alliance": { parameters: { query?: never; header?: never; @@ -60353,6 +65691,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Allow BHG by alliance. + * @description Proposes allowing another alliance to use Black Hole Generators in this jurisdiction, ignoring members-only colonization/stations restrictions. Requires Parliament level 28+. + */ post: { parameters: { query?: never; @@ -60363,12 +65705,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the Parliament building. */ building_id: number; + /** @description The id of the alliance to be allowed to use their BHGs here. */ + alliance_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Proposes allowing another alliance to use Black Hole Generators in this jurisdiction, ignoring members-only colonization/stations restrictions. Requires Parliament level 28+. */ 200: { headers: { [name: string]: unknown; @@ -60378,13 +65723,30 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; + proposition: { + id?: number; + name?: string; + description?: string; + votes_needed?: number; + votes_yes?: number; + votes_no?: number; + status?: string; + date_ends?: string; + proposed_by?: { + id?: number; + name?: string; + }; + /** + * @description Only present if this empire has voted. + * @enum {integer} + */ + my_vote?: 1 | 0; + }; }; }; }; @@ -60406,7 +65768,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/soup/get_stats_for_level": { + "/v2/pie/build": { parameters: { query?: never; header?: never; @@ -60415,6 +65777,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -60425,13 +65791,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - level: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -60443,24 +65813,11 @@ export interface paths { result?: { building: { id: number; - name: string; - image: string; level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; }; status: { @@ -60468,6 +65825,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -60489,7 +65847,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/soup/view": { + "/v2/pie/upgrade": { parameters: { query?: never; header?: never; @@ -60498,6 +65856,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -60508,75 +65870,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; - }; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/spacejunkpark/build": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - body_id: number; - x: number; - y: number; - }; - }; - }; - responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -60622,7 +65922,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spacejunkpark/upgrade": { + "/v2/pie/downgrade": { parameters: { query?: never; header?: never; @@ -60631,6 +65931,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -60641,12 +65945,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -60656,15 +65961,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -60692,7 +65989,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spacejunkpark/downgrade": { + "/v2/pie/demolish": { parameters: { query?: never; header?: never; @@ -60701,6 +65998,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -60711,12 +66012,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -60726,7 +66028,6 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -60754,7 +66055,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spacejunkpark/demolish": { + "/v2/pie/repair": { parameters: { query?: never; header?: never; @@ -60763,6 +66064,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -60773,12 +66078,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -60788,6 +66094,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -60815,7 +66122,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spacejunkpark/repair": { + "/v2/pie/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -60824,6 +66131,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -60834,12 +66145,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -60849,13 +66163,33 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -60877,7 +66211,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spacejunkpark/get_stats_for_level": { + "/v2/pie/view": { parameters: { query?: never; header?: never; @@ -60886,6 +66220,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -60896,13 +66234,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -60912,28 +66250,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -60960,7 +66277,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spacejunkpark/view": { + "/v2/pilottraining/build": { parameters: { query?: never; header?: never; @@ -60969,6 +66286,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -60979,12 +66300,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -60994,12 +66320,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -61021,7 +66356,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/build": { + "/v2/pilottraining/upgrade": { parameters: { query?: never; header?: never; @@ -61030,6 +66365,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -61040,14 +66379,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -61093,7 +66431,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/upgrade": { + "/v2/pilottraining/downgrade": { parameters: { query?: never; header?: never; @@ -61102,6 +66440,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -61112,12 +66454,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -61127,15 +66470,73 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/pilottraining/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -61163,7 +66564,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/downgrade": { + "/v2/pilottraining/repair": { parameters: { query?: never; header?: never; @@ -61172,6 +66573,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -61182,12 +66587,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -61225,7 +66631,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/demolish": { + "/v2/pilottraining/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -61234,6 +66640,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -61244,12 +66654,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Instantly destroys a building. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -61259,12 +66672,33 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -61286,7 +66720,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/repair": { + "/v2/pilottraining/view": { parameters: { query?: never; header?: never; @@ -61295,6 +66729,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -61305,12 +66743,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -61326,6 +66765,84 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/planetarycommand/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; buildings: components["schemas"]["buildings_list"]; }; }; @@ -61348,7 +66865,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/get_stats_for_level": { + "/v2/planetarycommand/upgrade": { parameters: { query?: never; header?: never; @@ -61357,6 +66874,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -61367,13 +66888,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -61385,24 +66906,11 @@ export interface paths { result?: { building: { id: number; - name: string; - image: string; level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; }; status: { @@ -61410,6 +66918,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -61431,7 +66940,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/view": { + "/v2/planetarycommand/downgrade": { parameters: { query?: never; header?: never; @@ -61440,6 +66949,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -61450,12 +66963,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -61471,13 +66985,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - /** @description Twice the level of the Space Port. */ - max_ships?: number; - docks_available?: number; - /** @description Count of docked ships, keyed by ship type. */ - docked_ships?: { - [key: string]: number; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -61499,7 +67007,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/view_all_ships": { + "/v2/planetarycommand/demolish": { parameters: { query?: never; header?: never; @@ -61508,6 +67016,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -61518,33 +67030,79 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - paging?: { - /** @description Defaults to 1. */ - page_number?: number; - /** @description Defaults to 25. */ - items_per_page?: number; - /** @enum {integer} */ - no_paging?: 1 | 0; - }; - filter?: { - /** @description One or more of: Building, Defend, Docked, Mining, Orbiting, Supply Chain, Travelling, Waiting on Trade, Waste Chain. */ - task?: string | string[]; - /** @description One or more existing ship type names. */ - type?: string | string[]; - /** @description One or more of Trade, Colonization, Intelligence, Exploration, War, Mining. Converted to types before filtering, overriding any `type` passed. */ - tag?: string | string[]; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; }; - /** - * @description Defaults to 'type'. A secondary sort by 'name' is always applied. - * @enum {string} - */ - sort?: "combat" | "name" | "speed" | "stealth" | "task" | "type"; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/planetarycommand/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Shows all of this empire's ships, whatever they are doing. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -61554,73 +67112,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - ships: { - id?: number; - name?: string; - type?: string; - type_human?: string; - task?: string; - speed?: number; - fleet_speed?: number; - stealth?: number; - combat?: number; - hold_size?: number; - max_occupants?: number; - berth_level?: number; - date_started?: string; - date_available?: string; - date_arrives?: string; - estimated_travel_time?: number; - /** @enum {integer} */ - can_recall?: 1 | 0; - /** @enum {integer} */ - can_scuttle?: 1 | 0; - from?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - to?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - orbiting?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - details?: { - payload?: string[]; - }; - }[]; - number_of_ships: number; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -61642,7 +67140,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/view_foreign_ships": { + "/v2/planetarycommand/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -61651,6 +67149,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -61661,14 +67163,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; - /** @description Defaults to 1. 25 per page. */ - page_number?: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Lists incoming foreign ships whose stealth this Space Port's level can detect (350 * level >= ship stealth). The `from` block is only included if 450 * level >= ship stealth. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -61678,68 +67181,28 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - ships: { - id?: number; - name?: string; - type?: string; - type_human?: string; - task?: string; - speed?: number; - fleet_speed?: number; - stealth?: number; - combat?: number; - hold_size?: number; - max_occupants?: number; - berth_level?: number; - date_started?: string; - date_available?: string; - date_arrives?: string; - estimated_travel_time?: number; - /** @enum {integer} */ - can_recall?: 1 | 0; - /** @enum {integer} */ - can_scuttle?: 1 | 0; - from?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - to?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - orbiting?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - details?: { - payload?: string[]; + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; }; - }[]; - number_of_ships: number; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -61766,7 +67229,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/get_fleet_for": { + "/v2/planetarycommand/view": { parameters: { query?: never; header?: never; @@ -61775,6 +67238,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -61785,21 +67252,13 @@ export interface paths { requestBody?: { content: { "application/json": { - from_body_id: number; - /** @description Identifies a star or body by exactly one of these keys. */ - target: { - body_name?: string; - body_id?: number; - star_name?: string; - star_id?: number; - x?: number; - y?: number; - }; + /** @description The id of the building you wish to retrieve. */ + building_id: number; }; }; }; responses: { - /** @description Summarizes ships available to include in a fleet action, grouped by type/speed/stealth/combat. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -61809,22 +67268,25 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - ships: { - type?: string; - type_human?: string; - speed?: number; - stealth?: number; - combat?: number; - name?: string; - hold_size?: number; - quantity?: number; - estimated_travel_time?: number; - }[]; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + /** @description Happiness required to settle the next colony. */ + next_colony_cost?: number; + /** @description Hourly rate and stored amount, keyed by food type (algae, bean, etc). */ + food?: { + [key: string]: number; + }; + /** @description Hourly rate and stored amount, keyed by ore type. */ + ore?: { + [key: string]: number; + }; + /** @description Seconds between supply pods being sent. */ + pod_delay?: number; + planet?: components["schemas"]["planet_status"]; }; }; }; @@ -61846,7 +67308,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/get_ships_for": { + "/v2/planetarycommand/view_plans": { parameters: { query?: never; header?: never; @@ -61855,6 +67317,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View plans. + * @description Lists all building plans this empire has collected. + */ post: { parameters: { query?: never; @@ -61865,21 +67331,13 @@ export interface paths { requestBody?: { content: { "application/json": { - from_body_id: number; - /** @description Identifies a star or body by exactly one of these keys. */ - target: { - body_name?: string; - body_id?: number; - star_name?: string; - star_id?: number; - x?: number; - y?: number; - }; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Lists incoming ships and ships available to send to a target. Use with send_ship. */ + /** @description Lists all building plans this empire has collected. */ 200: { headers: { [name: string]: unknown; @@ -61889,7 +67347,10779 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - incoming: { + plans: { + quantity?: number; + name?: string; + level?: number; + extra_build_level?: number; + }[]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/planetarycommand/view_incoming_supply_chains": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * View incoming supply chains. + * @description Lists supply chains feeding resources into this planet. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Lists supply chains feeding resources into this planet. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + supply_chains: { + id?: number; + from_body?: { + id?: number; + name?: string; + x?: number; + y?: number; + image?: string; + }; + resource_hour?: number; + resource_type?: string; + percent_transferred?: number; + /** @enum {integer} */ + stalled?: 1 | 0; + }[]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/planetarycommand/subsidize_pod_cooldown": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Subsidize pod cooldown. + * @description Spends 2 essentia to send a supply pod immediately. Returns the building view. Throws 1011. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Spends 2 essentia to send a supply pod immediately. Returns the building view. Throws 1011. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/policestation/view": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Retrieve this module's properties. + * @description Retrieves the properties of this module. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of this module. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + name: string; + image: string; + level: number; + x: number; + y: number; + efficiency: number; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/policestation/view_prisoners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * View prisoners. + * @description Displays a list of the spies that have been captured. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description Defaults to 1. Each page contains 25 results. */ + page_number?: number; + }; + }; + }; + responses: { + /** @description Displays a list of the spies that have been captured. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + /** @description Total captured spies across all pages (the pager is sized from this). */ + captured_count: number; + prisoners: { + id?: number; + name?: string; + level?: number; + /** @enum {string} */ + task?: "Captured" | "Prisoner Transport"; + sentence_expires?: string; + }[]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/policestation/execute_prisoner": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Execute prisoner. + * @description Executes a captured prisoner rather than letting them serve their sentence. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description The unique id of a captured prisoner. See view_prisoners. */ + prisoner_id: number; + }; + }; + }; + responses: { + /** @description Executes a captured prisoner rather than letting them serve their sentence. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/policestation/release_prisoner": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Release prisoner. + * @description Releases a captured prisoner. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description The unique id of a captured prisoner. See view_prisoners. */ + prisoner_id: number; + }; + }; + }; + responses: { + /** @description Releases a captured prisoner. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/policestation/view_foreign_spies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * View foreign spies. + * @description Displays a list of the spies on your planet with a level lower than your Police Station. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description Defaults to 1. Each page contains 25 results. */ + page_number?: number; + }; + }; + }; + responses: { + /** @description Displays a list of the spies on your planet with a level lower than your Police Station. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + /** @description Total foreign spies across all pages (the pager is sized from this). */ + spy_count: number; + spies: { + name?: string; + level?: number; + task?: string; + next_mission?: string; + }[]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/policestation/view_foreign_ships": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * View foreign ships. + * @description Shows incoming foreign ships filtered by the ship's stealth vs the Police Station's level (525 * level >= stealth to be visible at all; the `from` block requires 675 * level >= stealth). + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description Defaults to 1. Each page contains 25 results. */ + page_number?: number; + }; + }; + }; + responses: { + /** @description Shows incoming foreign ships filtered by the ship's stealth vs the Police Station's level (525 * level >= stealth to be visible at all; the `from` block requires 675 * level >= stealth). */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + ships: { + id?: number; + name?: string; + type?: string; + type_human?: string; + date_arrives?: string; + date_arrived?: string; + /** @description Only included if the ship's stealth is low enough relative to the Police Station's level. */ + from?: { + id?: number; + name?: string; + empire?: { + id?: number; + name?: string; + }; + }; + }[]; + number_of_ships: number; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/policestation/view_ships_travelling": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * View ships travelling. + * @description Returns a list of ships travelling to or from this planet, regardless of destination space port. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description Defaults to 1. Each page contains 25 results. */ + page_number?: number; + }; + }; + }; + responses: { + /** @description Returns a list of ships travelling to or from this planet, regardless of destination space port. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + ships_travelling: { + id?: number; + type?: string; + type_human?: string; + date_arrives?: string; + from?: { + id?: number; + type?: string; + name?: string; + }; + to?: { + id?: number; + type?: string; + name?: string; + }; + }[]; + number_of_ships_travelling: number; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/policestation/view_ships_orbiting": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * View ships orbiting. + * @description Shows foreign ships orbiting this planet, filtered by the ship's stealth vs the Police Station's level (525 * level >= stealth to be visible at all; the `from` block requires 675 * level >= stealth). + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description Defaults to 1. Each page contains 25 results. */ + page_number?: number; + }; + }; + }; + responses: { + /** @description Shows foreign ships orbiting this planet, filtered by the ship's stealth vs the Police Station's level (525 * level >= stealth to be visible at all; the `from` block requires 675 * level >= stealth). */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + ships: { + id?: number; + name?: string; + type?: string; + type_human?: string; + date_arrives?: string; + date_arrived?: string; + /** @description Only included if the ship's stealth is low enough relative to the Police Station's level. */ + from?: { + id?: number; + name?: string; + empire?: { + id?: number; + name?: string; + }; + }; + }[]; + number_of_ships: number; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/politicstraining/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/politicstraining/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Adds the requested upgrade to the build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/politicstraining/downgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/politicstraining/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/politicstraining/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/politicstraining/get_stats_for_level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; + responses: { + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/politicstraining/view": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the building you wish to retrieve. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + /** @description Summary of spy training capacity for this facility. */ + spies?: { + /** @description The maximum training points a spy can hold. */ + max_points: number; + /** @description Training points added per training cycle. */ + points_per: number; + /** @description The number of spies currently training here. */ + in_training: number; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/potato/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/potato/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Adds the requested upgrade to the build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/potato/downgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/potato/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/potato/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/potato/get_stats_for_level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; + responses: { + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/potato/view": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the building you wish to retrieve. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/propulsion/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/propulsion/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Adds the requested upgrade to the build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/propulsion/downgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/propulsion/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/propulsion/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/propulsion/get_stats_for_level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; + responses: { + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/propulsion/view": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the building you wish to retrieve. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/pyramidjunksculpture/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/pyramidjunksculpture/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Adds the requested upgrade to the build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/pyramidjunksculpture/downgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/pyramidjunksculpture/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/pyramidjunksculpture/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/pyramidjunksculpture/get_stats_for_level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; + responses: { + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/pyramidjunksculpture/view": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the building you wish to retrieve. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/ravine/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/ravine/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Adds the requested upgrade to the build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/ravine/downgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/ravine/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/ravine/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/ravine/get_stats_for_level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; + responses: { + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/ravine/view": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the building you wish to retrieve. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/rockyoutcrop/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/rockyoutcrop/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Adds the requested upgrade to the build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/rockyoutcrop/downgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/rockyoutcrop/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/rockyoutcrop/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/rockyoutcrop/get_stats_for_level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; + responses: { + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/rockyoutcrop/view": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the building you wish to retrieve. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/sand/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/sand/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Adds the requested upgrade to the build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/sand/downgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/sand/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/sand/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/sand/get_stats_for_level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; + responses: { + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/sand/view": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the building you wish to retrieve. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/saw/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/saw/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Adds the requested upgrade to the build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/saw/downgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/saw/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/saw/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/saw/get_stats_for_level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; + responses: { + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/saw/view": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the building you wish to retrieve. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/security/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/security/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Adds the requested upgrade to the build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/security/downgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/security/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/security/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/security/get_stats_for_level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; + responses: { + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/security/view": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the building you wish to retrieve. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/security/view_prisoners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * View prisoners. + * @description Displays a list of the spies that have been captured. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description Defaults to 1. Each page contains 25 spies. */ + page_number?: number; + }; + }; + }; + responses: { + /** @description Displays a list of the spies that have been captured. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + /** @description Total captured spies across all pages (the pager is sized from this). */ + captured_count: number; + prisoners: { + id: number; + name: string; + level: number; + /** @enum {string} */ + task: "Captured" | "Prisoner Transport"; + sentence_expires: string; + }[]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/security/execute_prisoner": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Execute prisoner. + * @description Executes a prisoner rather than letting them serve out their sentence. Costs 10,000 times the prisoner's level in happiness from your planet. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description The unique id of a captured prisoner. See view_prisoners. */ + prisoner_id: number; + }; + }; + }; + responses: { + /** @description Executes a prisoner rather than letting them serve out their sentence. Costs 10,000 times the prisoner's level in happiness from your planet. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/security/release_prisoner": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Release prisoner. + * @description Releases a captured prisoner. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description The unique id of a captured prisoner. See view_prisoners. */ + prisoner_id: number; + }; + }; + }; + responses: { + /** @description Releases a captured prisoner. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/security/view_foreign_spies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * View foreign spies. + * @description Displays a list of the spies that are on your planet and have a level lower than your security ministry. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description Defaults to 1. Each page contains 25 spies. */ + page_number?: number; + }; + }; + }; + responses: { + /** @description Displays a list of the spies that are on your planet and have a level lower than your security ministry. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + /** @description Total foreign spies across all pages (the pager is sized from this). */ + spy_count: number; + spies: { + name: string; + level: number; + task: string; + next_mission: string; + }[]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shake/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shake/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Adds the requested upgrade to the build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shake/downgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shake/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shake/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shake/get_stats_for_level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; + responses: { + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shake/view": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the building you wish to retrieve. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shipyard/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shipyard/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Adds the requested upgrade to the build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shipyard/downgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shipyard/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shipyard/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shipyard/get_stats_for_level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; + responses: { + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shipyard/view": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the building you wish to retrieve. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shipyard/view_build_queue": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * View build queue. + * @description Retrieves the ships currently being built at this shipyard. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description Defaults to 1. 25 items per page. */ + page_number?: number; + }; + }; + }; + responses: { + /** @description Retrieves the ships currently being built at this shipyard. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + number_of_ships_building: number; + cost_to_subsidize: number; + ships_building: { + id: number; + type: string; + type_human: string; + date_completed: string; + }[]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shipyard/subsidize_build_queue": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Subsidize build queue. + * @description Completes the entire build queue immediately for 1 essentia per ship. Throws 1011. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Completes the entire build queue immediately for 1 essentia per ship. Throws 1011. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + number_of_ships_building: number; + cost_to_subsidize: number; + ships_building: { + id: number; + type: string; + type_human: string; + date_completed: string; + }[]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shipyard/subsidize_ship": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Subsidize ship. + * @description Completes a single ship immediately for 1 essentia. Throws 1011. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description The unique id of the ship. */ + ship_id: number; + }; + }; + }; + responses: { + /** @description Completes a single ship immediately for 1 essentia. Throws 1011. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + number_of_ships_building: number; + cost_to_subsidize: number; + ships_building: { + id: number; + type: string; + type_human: string; + date_completed: string; + }[]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shipyard/get_buildable": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Get buildable. + * @description Lists buildable ship types with cost and availability. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** + * @description Optional tag to limit which ship types are listed. + * @enum {string} + */ + tag?: "Trade" | "Colonization" | "Intelligence" | "Exploration" | "War" | "Mining"; + }; + }; + }; + responses: { + /** @description Lists buildable ship types with cost and availability. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + /** @description Keyed by ship type. */ + buildable: { + [key: string]: { + can: boolean; + reason?: unknown[]; + cost: { + seconds?: number; + food?: number; + water?: number; + energy?: number; + ore?: number; + waste?: number; + }; + attributes: { + speed?: number; + hold_size?: number; + max_occupants?: number; + combat?: number; + stealth?: number; + }; + }; + }; + docks_available: number; + build_queue_max: number; + build_queue_used: number; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shipyard/build_ship": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Build ship. + * @description Queues ships for construction at this shipyard. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description A ship type, from get_buildable. */ + type: string; + /** @description Number of ships to build, up to 600. Defaults to 1. */ + quantity?: number; + }; + }; + }; + responses: { + /** @description Queues ships for construction at this shipyard. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + number_of_ships_building: number; + cost_to_subsidize: number; + ships_building: { + id: number; + type: string; + type_human: string; + date_completed: string; + }[]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/shipyard/build_ships": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Build ships. + * @description Queues ships for construction across multiple shipyards at once. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Build options selecting ship type, quantity, and which shipyards to use. */ + options: { + /** @description A ship type, from get_buildable. */ + type: string; + /** @description Defaults to 1. */ + quantity?: number; + /** @description Alternative to building_id. */ + body_id?: number; + /** @description A single shipyard id, or an array of shipyard ids. */ + building_id?: number | number[]; + /** + * @description Shipyard autoselect mode. Defaults to using only the shipyard(s) in building_id. + * @enum {string} + */ + autoselect?: "all" | "higher" | "only"; + }; + }; + }; + }; + responses: { + /** @description Queues ships for construction across multiple shipyards at once. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/singularity/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/singularity/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Adds the requested upgrade to the build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/singularity/downgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/singularity/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/singularity/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/singularity/get_stats_for_level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; + responses: { + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/singularity/view": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the building you wish to retrieve. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/soup/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/soup/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Adds the requested upgrade to the build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/soup/downgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/soup/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/soup/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/soup/get_stats_for_level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; + responses: { + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/soup/view": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the building you wish to retrieve. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spacejunkpark/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spacejunkpark/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Adds the requested upgrade to the build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spacejunkpark/downgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spacejunkpark/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spacejunkpark/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spacejunkpark/get_stats_for_level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; + responses: { + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spacejunkpark/view": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the building you wish to retrieve. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Adds the requested upgrade to the build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/downgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/get_stats_for_level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; + responses: { + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/view": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the building you wish to retrieve. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Retrieves the properties of the building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + /** @description Twice the level of the Space Port. */ + max_ships?: number; + docks_available?: number; + /** @description Count of docked ships, keyed by ship type. */ + docked_ships?: { + [key: string]: number; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/view_all_ships": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * View all ships. + * @description Shows all of this empire's ships, whatever they are doing. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description Optional paging controls. */ + paging?: { + /** @description Defaults to 1. */ + page_number?: number; + /** @description Defaults to 25. */ + items_per_page?: number; + /** + * @description If 1, all other paging options are ignored and every result is returned. + * @enum {integer} + */ + no_paging?: 1 | 0; + }; + /** @description Optional filters on task, type, and tag. */ + filter?: { + /** @description One or more of: Building, Defend, Docked, Mining, Orbiting, Supply Chain, Travelling, Waiting on Trade, Waste Chain. */ + task?: string | string[]; + /** @description One or more existing ship type names. */ + type?: string | string[]; + /** @description One or more of Trade, Colonization, Intelligence, Exploration, War, Mining. Converted to types before filtering, overriding any `type` passed. */ + tag?: string | string[]; + }; + /** + * @description Defaults to 'type'. A secondary sort by 'name' is always applied. + * @enum {string} + */ + sort?: "combat" | "name" | "speed" | "stealth" | "task" | "type"; + }; + }; + }; + responses: { + /** @description Shows all of this empire's ships, whatever they are doing. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + ships: { + id?: number; + name?: string; + type?: string; + type_human?: string; + task?: string; + speed?: number; + fleet_speed?: number; + stealth?: number; + combat?: number; + hold_size?: number; + max_occupants?: number; + berth_level?: number; + date_started?: string; + date_available?: string; + date_arrives?: string; + estimated_travel_time?: number; + /** @enum {integer} */ + can_recall?: 1 | 0; + /** @enum {integer} */ + can_scuttle?: 1 | 0; + from?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + to?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + orbiting?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + details?: { + payload?: string[]; + }; + }[]; + number_of_ships: number; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/view_foreign_ships": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * View foreign ships. + * @description Lists incoming foreign ships whose stealth this Space Port's level can detect (350 * level >= ship stealth). The `from` block is only included if 450 * level >= ship stealth. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description Defaults to 1. 25 per page. */ + page_number?: number; + }; + }; + }; + responses: { + /** @description Lists incoming foreign ships whose stealth this Space Port's level can detect (350 * level >= ship stealth). The `from` block is only included if 450 * level >= ship stealth. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + ships: { + id?: number; + name?: string; + type?: string; + type_human?: string; + task?: string; + speed?: number; + fleet_speed?: number; + stealth?: number; + combat?: number; + hold_size?: number; + max_occupants?: number; + berth_level?: number; + date_started?: string; + date_available?: string; + date_arrives?: string; + estimated_travel_time?: number; + /** @enum {integer} */ + can_recall?: 1 | 0; + /** @enum {integer} */ + can_scuttle?: 1 | 0; + from?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + to?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + orbiting?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + details?: { + payload?: string[]; + }; + }[]; + number_of_ships: number; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/get_fleet_for": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Summarize a fleet available for a target. + * @description Summarizes ships available to include in a fleet action, grouped by type/speed/stealth/combat. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the planet the ships are dispatched from. */ + from_body_id: number; + /** @description Identifies a star or body by exactly one of these keys. */ + target: { + body_name?: string; + body_id?: number; + star_name?: string; + star_id?: number; + x?: number; + y?: number; + }; + }; + }; + }; + responses: { + /** @description Summarizes ships available to include in a fleet action, grouped by type/speed/stealth/combat. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + ships: { + type?: string; + type_human?: string; + speed?: number; + stealth?: number; + combat?: number; + name?: string; + hold_size?: number; + quantity?: number; + estimated_travel_time?: number; + }[]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/get_ships_for": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * List ships available for a target. + * @description Lists incoming ships and ships available to send to a target. Use with send_ship. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the planet the ships are dispatched from. */ + from_body_id: number; + /** @description Identifies a star or body by exactly one of these keys. */ + target: { + body_name?: string; + body_id?: number; + star_name?: string; + star_id?: number; + x?: number; + y?: number; + }; + }; + }; + }; + responses: { + /** @description Lists incoming ships and ships available to send to a target. Use with send_ship. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + incoming: { + id?: number; + name?: string; + type?: string; + type_human?: string; + task?: string; + speed?: number; + fleet_speed?: number; + stealth?: number; + combat?: number; + hold_size?: number; + max_occupants?: number; + berth_level?: number; + date_started?: string; + date_available?: string; + date_arrives?: string; + estimated_travel_time?: number; + /** @enum {integer} */ + can_recall?: 1 | 0; + /** @enum {integer} */ + can_scuttle?: 1 | 0; + from?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + to?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + orbiting?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + details?: { + payload?: string[]; + }; + }[]; + available: { + id?: number; + name?: string; + type?: string; + type_human?: string; + task?: string; + speed?: number; + fleet_speed?: number; + stealth?: number; + combat?: number; + hold_size?: number; + max_occupants?: number; + berth_level?: number; + date_started?: string; + date_available?: string; + date_arrives?: string; + estimated_travel_time?: number; + /** @enum {integer} */ + can_recall?: 1 | 0; + /** @enum {integer} */ + can_scuttle?: 1 | 0; + from?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + to?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + orbiting?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + details?: { + payload?: string[]; + }; + }[]; + /** @description Docked ships that are not available to send, with a reason. */ + unavailable: { + reason?: unknown[]; + ship?: { + id?: number; + name?: string; + type?: string; + type_human?: string; + task?: string; + speed?: number; + fleet_speed?: number; + stealth?: number; + combat?: number; + hold_size?: number; + max_occupants?: number; + berth_level?: number; + date_started?: string; + date_available?: string; + date_arrives?: string; + estimated_travel_time?: number; + /** @enum {integer} */ + can_recall?: 1 | 0; + /** @enum {integer} */ + can_scuttle?: 1 | 0; + from?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + to?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + orbiting?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + details?: { + payload?: string[]; + }; + }; + }[]; + /** @description Only present if the target is a body. Defending fighters that can be recalled. */ + orbiting: { + id?: number; + name?: string; + type?: string; + type_human?: string; + task?: string; + speed?: number; + fleet_speed?: number; + stealth?: number; + combat?: number; + hold_size?: number; + max_occupants?: number; + berth_level?: number; + date_started?: string; + date_available?: string; + date_arrives?: string; + estimated_travel_time?: number; + /** @enum {integer} */ + can_recall?: 1 | 0; + /** @enum {integer} */ + can_scuttle?: 1 | 0; + from?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + to?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + orbiting?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + details?: { + payload?: string[]; + }; + }[]; + /** @description Only present if the target is an asteroid with platforms on it. */ + mining_platforms?: { + empire_id?: number; + empire_name?: string; + }[]; + fleet_send_limit: number; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/send_ship": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Send ship. + * @description Sends a single ship to a body or star. Use with get_ships_for. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the ship. */ + ship_id: number; + /** @description Identifies a star or body by exactly one of these keys. */ + target: { + body_name?: string; + body_id?: number; + star_name?: string; + star_id?: number; + x?: number; + y?: number; + }; + }; + }; + }; + responses: { + /** @description Sends a single ship to a body or star. Use with get_ships_for. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + ship: { + id?: number; + name?: string; + type?: string; + type_human?: string; + task?: string; + speed?: number; + fleet_speed?: number; + stealth?: number; + combat?: number; + hold_size?: number; + max_occupants?: number; + berth_level?: number; + date_started?: string; + date_available?: string; + date_arrives?: string; + estimated_travel_time?: number; + /** @enum {integer} */ + can_recall?: 1 | 0; + /** @enum {integer} */ + can_scuttle?: 1 | 0; + from?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + to?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + orbiting?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + details?: { + payload?: string[]; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/send_ship_types": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Send ship types. + * @description Sends the given quantities of matching docked ships to a target. Returns the same shape as get_fleet_for, showing ships remaining to send. Throws 1002, 1009, 1010, 1019. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the planet the ships are dispatched from. */ + from_body_id: number; + /** @description Identifies a star or body by exactly one of these keys. */ + target: { + body_name?: string; + body_id?: number; + star_name?: string; + star_id?: number; + x?: number; + y?: number; + }; + /** @description The ship specifications and quantities to send. See get_fleet_for. */ + types: { + type: string; + speed?: number; + stealth?: number; + combat?: number; + /** @description How many to process. Defaults to 1. */ + quantity: number; + }[]; + /** @description The desired arrival time, either an absolute day/time or the earliest possible. */ + arrival: { + /** @description Day of the month, up to 60 days in the future. */ + day?: number; + hour?: number; + minute?: number; + second?: number; + } | { + /** @enum {integer} */ + earliest?: 1; + }; + }; + }; + }; + responses: { + /** @description Sends the given quantities of matching docked ships to a target. Returns the same shape as get_fleet_for, showing ships remaining to send. Throws 1002, 1009, 1010, 1019. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + ships: { + type?: string; + type_human?: string; + speed?: number; + stealth?: number; + combat?: number; + quantity?: number; + }[]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/send_fleet": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Send fleet. + * @description Sends a fleet of ships to a body or star. Use with get_ships_for. Throws 1002, 1009, 1010, 1016. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An array of ship ids. */ + ship_ids: number[]; + /** @description Identifies a star or body by exactly one of these keys. */ + target: { + body_name?: string; + body_id?: number; + star_name?: string; + star_id?: number; + x?: number; + y?: number; + }; + /** @description Speed all ships in the fleet should travel at. 0 uses the slowest ship's speed. Cannot exceed the slowest ship's speed. */ + set_speed?: number; + }; + }; + }; + responses: { + /** @description Sends a fleet of ships to a body or star. Use with get_ships_for. Throws 1002, 1009, 1010, 1016. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + fleet: { + id?: number; + name?: string; + type?: string; + type_human?: string; + task?: string; + speed?: number; + fleet_speed?: number; + stealth?: number; + combat?: number; + hold_size?: number; + max_occupants?: number; + berth_level?: number; + date_started?: string; + date_available?: string; + date_arrives?: string; + estimated_travel_time?: number; + /** @enum {integer} */ + can_recall?: 1 | 0; + /** @enum {integer} */ + can_scuttle?: 1 | 0; + from?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + to?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + orbiting?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + details?: { + payload?: string[]; + }; + }[]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/recall_ship": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Recall ship. + * @description Recalls an orbiting ship (task Defend or Orbiting) to its body of origin. Recalling an orbiting Spy Shuttle also fetches as many idle spies as will fit. Throws 1002, 1010, 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description The unique id of the ship. */ + ship_id: number; + }; + }; + }; + responses: { + /** @description Recalls an orbiting ship (task Defend or Orbiting) to its body of origin. Recalling an orbiting Spy Shuttle also fetches as many idle spies as will fit. Throws 1002, 1010, 1013. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + ship: { + id?: number; + name?: string; + type?: string; + type_human?: string; + task?: string; + speed?: number; + fleet_speed?: number; + stealth?: number; + combat?: number; + hold_size?: number; + max_occupants?: number; + berth_level?: number; + date_started?: string; + date_available?: string; + date_arrives?: string; + estimated_travel_time?: number; + /** @enum {integer} */ + can_recall?: 1 | 0; + /** @enum {integer} */ + can_scuttle?: 1 | 0; + from?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + to?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + orbiting?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + details?: { + payload?: string[]; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/recall_all": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Recall all. + * @description Recalls all of this planet's orbiting ships (task Defend or Orbiting) to their Space Port of origin. Throws 1002, 1010. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Recalls all of this planet's orbiting ships (task Defend or Orbiting) to their Space Port of origin. Throws 1002, 1010. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + ships: { + id?: number; + name?: string; + type?: string; + type_human?: string; + task?: string; + speed?: number; + fleet_speed?: number; + stealth?: number; + combat?: number; + hold_size?: number; + max_occupants?: number; + berth_level?: number; + date_started?: string; + date_available?: string; + date_arrives?: string; + estimated_travel_time?: number; + /** @enum {integer} */ + can_recall?: 1 | 0; + /** @enum {integer} */ + can_scuttle?: 1 | 0; + from?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + to?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + orbiting?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + details?: { + payload?: string[]; + }; + }[]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/name_ship": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Name ship. + * @description Renames a ship. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description The unique id of the ship. */ + ship_id: number; + /** @description The new ship name. 1-30 characters, no profanity or special characters. */ + name: string; + }; + }; + }; + responses: { + /** @description Renames a ship. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/scuttle_ship": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Scuttle ship. + * @description Destroys a docked ship. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description The unique id of the ship. */ + ship_id: number; + }; + }; + }; + responses: { + /** @description Destroys a docked ship. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/mass_scuttle_ship": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Mass scuttle ship. + * @description Destroys multiple docked ships. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description An array of ship ids. */ + ship_ids: number[]; + }; + }; + }; + responses: { + /** @description Destroys multiple docked ships. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/view_ships_travelling": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * View ships travelling. + * @description Lists ships travelling to or from this planet, regardless of which Space Port they'll land at. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description Defaults to 1. 25 per page. */ + page_number?: number; + }; + }; + }; + responses: { + /** @description Lists ships travelling to or from this planet, regardless of which Space Port they'll land at. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + number_of_ships_travelling: number; + ships_travelling: { id?: number; name?: string; type?: string; @@ -61950,7 +78180,74 @@ export interface paths { payload?: string[]; }; }[]; - available: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/view_ships_orbiting": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * View ships orbiting. + * @description Lists foreign ships orbiting this planet whose stealth this Space Port's level can detect (350 * level >= ship stealth). The `from` block is only included if 450 * level >= ship stealth. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description Defaults to 1. 25 per page. */ + page_number?: number; + }; + }; + }; + responses: { + /** @description Lists foreign ships orbiting this planet whose stealth this Space Port's level can detect (350 * level >= ship stealth). The `from` block is only included if 450 * level >= ship stealth. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + ships: { id?: number; name?: string; type?: string; @@ -62011,73 +78308,489 @@ export interface paths { payload?: string[]; }; }[]; - /** @description Docked ships that are not available to send, with a reason. */ - unavailable: { - reason?: unknown[]; - ship?: { + number_of_ships: number; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/prepare_send_spies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Prepare send spies. + * @description Gathers the ships and spies needed to call send_spies. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the planet the spies are on. */ + on_body_id: number; + /** @description The unique id of the destination planet. */ + to_body_id: number; + }; + }; + }; + responses: { + /** @description Gathers the ships and spies needed to call send_spies. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + /** @description Spy Pods hold 1 spy, Spy Shuttles hold 4, other cargo-hold ships hold 1 per 350 units of hold size. */ + ships: { + id?: number; + name?: string; + type?: string; + type_human?: string; + task?: string; + speed?: number; + fleet_speed?: number; + stealth?: number; + combat?: number; + hold_size?: number; + max_occupants?: number; + berth_level?: number; + date_started?: string; + date_available?: string; + date_arrives?: string; + estimated_travel_time?: number; + /** @enum {integer} */ + can_recall?: 1 | 0; + /** @enum {integer} */ + can_scuttle?: 1 | 0; + from?: { id?: number; + /** @enum {string} */ + type?: "body" | "star"; name?: string; - type?: string; - type_human?: string; - task?: string; - speed?: number; - fleet_speed?: number; - stealth?: number; - combat?: number; - hold_size?: number; - max_occupants?: number; - berth_level?: number; - date_started?: string; - date_available?: string; - date_arrives?: string; - estimated_travel_time?: number; - /** @enum {integer} */ - can_recall?: 1 | 0; - /** @enum {integer} */ - can_scuttle?: 1 | 0; - from?: { + x?: number; + y?: number; + empire?: { id?: number; - /** @enum {string} */ - type?: "body" | "star"; name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; }; - to?: { + }; + to?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { id?: number; - /** @enum {string} */ - type?: "body" | "star"; name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; }; - orbiting?: { + }; + orbiting?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { id?: number; - /** @enum {string} */ - type?: "body" | "star"; name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; }; - details?: { - payload?: string[]; + }; + details?: { + payload?: string[]; + }; + }[]; + spies: { + id?: number; + level?: number; + name?: string; + assigned_to?: { + body_id?: number; + name?: string; + }; + }[]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/send_spies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Send spies. + * @description Sends spies from on_body_id to to_body_id using the chosen ship. See prepare_send_spies. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the planet the spies are on. */ + on_body_id: number; + /** @description The unique id of the destination planet. */ + to_body_id: number; + /** @description The unique id of the ship. */ + ship_id: number; + /** @description An array of spy ids. */ + spy_ids: number[]; + }; + }; + }; + responses: { + /** @description Sends spies from on_body_id to to_body_id using the chosen ship. See prepare_send_spies. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + ship: { + id?: number; + name?: string; + type?: string; + type_human?: string; + task?: string; + speed?: number; + fleet_speed?: number; + stealth?: number; + combat?: number; + hold_size?: number; + max_occupants?: number; + berth_level?: number; + date_started?: string; + date_available?: string; + date_arrives?: string; + estimated_travel_time?: number; + /** @enum {integer} */ + can_recall?: 1 | 0; + /** @enum {integer} */ + can_scuttle?: 1 | 0; + from?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + to?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + orbiting?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + details?: { + payload?: string[]; + }; + }; + spies_sent: number[]; + /** @description Should only be non-empty in edge cases (e.g. a spy died between calls). */ + spies_not_sent: number[]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/prepare_fetch_spies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Prepare fetch spies. + * @description Gathers the ships and spies needed to call fetch_spies. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The planet the spies are currently on. */ + on_body_id: number; + /** @description The planet the spies should be brought to, and the ship will be dispatched from. */ + to_body_id: number; + }; + }; + }; + responses: { + /** @description Gathers the ships and spies needed to call fetch_spies. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + ships: { + id?: number; + name?: string; + type?: string; + type_human?: string; + task?: string; + speed?: number; + fleet_speed?: number; + stealth?: number; + combat?: number; + hold_size?: number; + max_occupants?: number; + berth_level?: number; + date_started?: string; + date_available?: string; + date_arrives?: string; + estimated_travel_time?: number; + /** @enum {integer} */ + can_recall?: 1 | 0; + /** @enum {integer} */ + can_scuttle?: 1 | 0; + from?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + to?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; + }; + }; + orbiting?: { + id?: number; + /** @enum {string} */ + type?: "body" | "star"; + name?: string; + x?: number; + y?: number; + empire?: { + id?: number; + name?: string; }; }; + details?: { + payload?: string[]; + }; }[]; - /** @description Only present if the target is a body. Defending fighters that can be recalled. */ - orbiting: { + spies: { + id?: number; + level?: number; + name?: string; + assigned_to?: { + body_id?: number; + name?: string; + }; + }[]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/fetch_spies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Fetch spies. + * @description Sends a ship to fetch spies from on_body_id and bring them to to_body_id. Spies not Idle on arrival are not picked up. See prepare_fetch_spies. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The planet the spies are currently on. */ + on_body_id: number; + /** @description The planet the spies should be brought to, and the ship will be dispatched from. */ + to_body_id: number; + /** @description The unique id of the ship. */ + ship_id: number; + /** @description An array of spy ids. */ + spy_ids: number[]; + }; + }; + }; + responses: { + /** @description Sends a ship to fetch spies from on_body_id and bring them to to_body_id. Spies not Idle on arrival are not picked up. See prepare_fetch_spies. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + ship: { id?: number; name?: string; type?: string; @@ -62137,13 +78850,529 @@ export interface paths { details?: { payload?: string[]; }; - }[]; - /** @description Only present if the target is an asteroid with platforms on it. */ - mining_platforms?: { - empire_id?: number; - empire_name?: string; - }[]; - fleet_send_limit: number; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaceport/view_battle_logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * View battle logs. + * @description Lists this empire's battle logs, most recent first. Cleared out every seven days. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + /** @description Defaults to 1. 25 per page. */ + page_number?: number; + }; + }; + }; + responses: { + /** @description Lists this empire's battle logs, most recent first. Cleared out every seven days. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + battle_log: { + date?: string; + attacking_body?: string; + attacking_empire?: string; + attacking_unit?: string; + defending_body?: string; + defending_empire?: string; + defending_unit?: string; + /** @enum {string} */ + victory_to?: "attacker" | "defender"; + }[]; + number_of_logs: number; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/ssla/build": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; + }; + }; + }; + responses: { + /** @description Adds this building to the planet's build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/ssla/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Adds the requested upgrade to the build queue. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/ssla/downgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/ssla/demolish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Instantly destroys a building. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/ssla/repair": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/ssla/get_stats_for_level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building you want to get the stats for. */ + building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; + }; + }; + }; + responses: { + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -62170,7 +79399,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/send_ship": { + "/v2/ssla/view": { parameters: { query?: never; header?: never; @@ -62179,6 +79408,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -62189,21 +79422,13 @@ export interface paths { requestBody?: { content: { "application/json": { - ship_id: number; - /** @description Identifies a star or body by exactly one of these keys. */ - target: { - body_name?: string; - body_id?: number; - star_name?: string; - star_id?: number; - x?: number; - y?: number; - }; + /** @description The id of the building you wish to retrieve. */ + building_id: number; }; }; }; responses: { - /** @description Sends a single ship to a body or star. Use with get_ships_for. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -62213,72 +79438,32 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - ship: { - id?: number; - name?: string; - type?: string; - type_human?: string; - task?: string; - speed?: number; - fleet_speed?: number; - stealth?: number; - combat?: number; - hold_size?: number; - max_occupants?: number; - berth_level?: number; - date_started?: string; - date_available?: string; - date_arrives?: string; - estimated_travel_time?: number; - /** @enum {integer} */ - can_recall?: 1 | 0; - /** @enum {integer} */ - can_scuttle?: 1 | 0; - from?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - to?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - orbiting?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - details?: { - payload?: string[]; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + make_plan?: { + types?: { + type?: string; + name?: string; + image?: string; + url?: string; + }[]; + level_costs?: { + level?: number; + food?: number; + ore?: number; + water?: number; + energy?: number; + waste?: number; + time?: number; + }[]; + subsidy_cost?: number; + /** @description Only present if a plan is currently being made. */ + making?: string; + }; }; }; }; @@ -62300,7 +79485,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/send_ship_types": { + "/v2/ssla/make_plan": { parameters: { query?: never; header?: never; @@ -62309,6 +79494,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Make plan. + * @description Starts the plan creation process. Returns the building view. + */ post: { parameters: { query?: never; @@ -62319,40 +79508,17 @@ export interface paths { requestBody?: { content: { "application/json": { - from_body_id: number; - /** @description Identifies a star or body by exactly one of these keys. */ - target: { - body_name?: string; - body_id?: number; - star_name?: string; - star_id?: number; - x?: number; - y?: number; - }; - /** @description The ship specifications and quantities to send. See get_fleet_for. */ - types: { - type: string; - speed?: number; - stealth?: number; - combat?: number; - quantity: number; - }[]; - /** @description The desired arrival time, either an absolute day/time or the earliest possible. */ - arrival: { - /** @description Day of the month, up to 60 days in the future. */ - day?: number; - hour?: number; - minute?: number; - second?: number; - } | { - /** @enum {integer} */ - earliest?: 1; - }; + /** @description The unique id of the building. */ + building_id: number; + /** @description Key from view's make_plan > types, e.g. 'ibs'. */ + type: string; + /** @description The plan level (1-30), from view's make_plan > level_costs. */ + level: number; }; }; }; responses: { - /** @description Sends the given quantities of matching docked ships to a target. Returns the same shape as get_fleet_for, showing ships remaining to send. Throws 1002, 1009, 1010, 1019. */ + /** @description Starts the plan creation process. Returns the building view. */ 200: { headers: { [name: string]: unknown; @@ -62362,19 +79528,32 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - ships: { - type?: string; - type_human?: string; - speed?: number; - stealth?: number; - combat?: number; - quantity?: number; - }[]; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + make_plan?: { + types?: { + type?: string; + name?: string; + image?: string; + url?: string; + }[]; + level_costs?: { + level?: number; + food?: number; + ore?: number; + water?: number; + energy?: number; + waste?: number; + time?: number; + }[]; + subsidy_cost?: number; + /** @description Only present if a plan is currently being made. */ + making?: string; + }; }; }; }; @@ -62396,7 +79575,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/send_fleet": { + "/v2/ssla/subsidize_plan": { parameters: { query?: never; header?: never; @@ -62405,6 +79584,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Subsidize plan. + * @description Spends essentia equal to view's subsidy_cost to complete the current plan immediately. Returns the building view. Throws 1011. + */ post: { parameters: { query?: never; @@ -62415,23 +79598,13 @@ export interface paths { requestBody?: { content: { "application/json": { - ship_ids: number[]; - /** @description Identifies a star or body by exactly one of these keys. */ - target: { - body_name?: string; - body_id?: number; - star_name?: string; - star_id?: number; - x?: number; - y?: number; - }; - /** @description Speed all ships in the fleet should travel at. 0 uses the slowest ship's speed. Cannot exceed the slowest ship's speed. */ - set_speed?: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Sends a fleet of ships to a body or star. Use with get_ships_for. Throws 1002, 1009, 1010, 1016. */ + /** @description Spends essentia equal to view's subsidy_cost to complete the current plan immediately. Returns the building view. Throws 1011. */ 200: { headers: { [name: string]: unknown; @@ -62441,72 +79614,32 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - fleet: { - id?: number; - name?: string; - type?: string; - type_human?: string; - task?: string; - speed?: number; - fleet_speed?: number; - stealth?: number; - combat?: number; - hold_size?: number; - max_occupants?: number; - berth_level?: number; - date_started?: string; - date_available?: string; - date_arrives?: string; - estimated_travel_time?: number; - /** @enum {integer} */ - can_recall?: 1 | 0; - /** @enum {integer} */ - can_scuttle?: 1 | 0; - from?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - to?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - orbiting?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - details?: { - payload?: string[]; - }; - }[]; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + make_plan?: { + types?: { + type?: string; + name?: string; + image?: string; + url?: string; + }[]; + level_costs?: { + level?: number; + food?: number; + ore?: number; + water?: number; + energy?: number; + waste?: number; + time?: number; + }[]; + subsidy_cost?: number; + /** @description Only present if a plan is currently being made. */ + making?: string; + }; }; }; }; @@ -62528,7 +79661,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/recall_ship": { + "/v2/sslb/build": { parameters: { query?: never; header?: never; @@ -62537,6 +79670,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -62547,13 +79684,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - ship_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Recalls an orbiting ship (task Defend or Orbiting) to its body of origin. Recalling an orbiting Spy Shuttle also fetches as many idle spies as will fit. Throws 1002, 1010, 1013. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -62563,65 +79704,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - ship: { - id?: number; - name?: string; - type?: string; - type_human?: string; - task?: string; - speed?: number; - fleet_speed?: number; - stealth?: number; - combat?: number; - hold_size?: number; - max_occupants?: number; - berth_level?: number; - date_started?: string; - date_available?: string; - date_arrives?: string; - estimated_travel_time?: number; - /** @enum {integer} */ - can_recall?: 1 | 0; - /** @enum {integer} */ - can_scuttle?: 1 | 0; - from?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - to?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - orbiting?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - details?: { - payload?: string[]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; }; status: { @@ -62629,6 +79718,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -62650,7 +79740,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/recall_all": { + "/v2/sslb/upgrade": { parameters: { query?: never; header?: never; @@ -62659,6 +79749,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -62669,12 +79763,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Recalls all of this planet's orbiting ships (task Defend or Orbiting) to their Space Port of origin. Throws 1002, 1010. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -62684,72 +79779,88 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - ships: { - id?: number; - name?: string; - type?: string; - type_human?: string; - task?: string; - speed?: number; - fleet_speed?: number; - stealth?: number; - combat?: number; - hold_size?: number; - max_occupants?: number; - berth_level?: number; - date_started?: string; - date_available?: string; - date_arrives?: string; - estimated_travel_time?: number; - /** @enum {integer} */ - can_recall?: 1 | 0; - /** @enum {integer} */ - can_scuttle?: 1 | 0; - from?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - to?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - orbiting?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - details?: { - payload?: string[]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; - }[]; + }; + status: { + server: components["schemas"]["server_status"]; + empire?: components["schemas"]["empire_status"]; + body?: components["schemas"]["body_status"]; + }; + buildings: components["schemas"]["buildings_list"]; + }; + }; + }; + }; + /** @description RPC Error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["rpc_error"]; + }; + }; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/sslb/downgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The unique id of the building. */ + building_id: number; + }; + }; + }; + responses: { + /** @description Downgrades a building by one level and then returns the building's view. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + id?: number; + jsonrpc?: string; + result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -62771,7 +79882,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/name_ship": { + "/v2/sslb/demolish": { parameters: { query?: never; header?: never; @@ -62780,6 +79891,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -62790,14 +79905,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - ship_id: number; - name: string; }; }; }; responses: { - /** @description Renames a ship. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -62812,6 +79926,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -62833,7 +79948,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/scuttle_ship": { + "/v2/sslb/repair": { parameters: { query?: never; header?: never; @@ -62842,6 +79957,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -62852,13 +79971,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - ship_id: number; }; }; }; responses: { - /** @description Destroys a docked ship. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -62868,11 +79987,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -62894,7 +80015,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/mass_scuttle_ship": { + "/v2/sslb/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -62903,6 +80024,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -62913,13 +80038,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; - ship_ids: number[]; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Destroys multiple docked ships. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -62929,6 +80056,28 @@ export interface paths { id?: number; jsonrpc?: string; result?: { + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -62955,7 +80104,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/view_ships_travelling": { + "/v2/sslb/view": { parameters: { query?: never; header?: never; @@ -62964,6 +80113,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -62974,14 +80127,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; - /** @description Defaults to 1. 25 per page. */ - page_number?: number; }; }; }; responses: { - /** @description Lists ships travelling to or from this planet, regardless of which Space Port they'll land at. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -62991,68 +80143,7 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - number_of_ships_travelling: number; - ships_travelling: { - id?: number; - name?: string; - type?: string; - type_human?: string; - task?: string; - speed?: number; - fleet_speed?: number; - stealth?: number; - combat?: number; - hold_size?: number; - max_occupants?: number; - berth_level?: number; - date_started?: string; - date_available?: string; - date_arrives?: string; - estimated_travel_time?: number; - /** @enum {integer} */ - can_recall?: 1 | 0; - /** @enum {integer} */ - can_scuttle?: 1 | 0; - from?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - to?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - orbiting?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - details?: { - payload?: string[]; - }; - }[]; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -63079,7 +80170,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/view_ships_orbiting": { + "/v2/sslc/build": { parameters: { query?: never; header?: never; @@ -63088,6 +80179,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -63098,14 +80193,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; - /** @description Defaults to 1. 25 per page. */ - page_number?: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Lists foreign ships orbiting this planet whose stealth this Space Port's level can detect (350 * level >= ship stealth). The `from` block is only included if 450 * level >= ship stealth. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -63115,73 +80213,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - ships: { - id?: number; - name?: string; - type?: string; - type_human?: string; - task?: string; - speed?: number; - fleet_speed?: number; - stealth?: number; - combat?: number; - hold_size?: number; - max_occupants?: number; - berth_level?: number; - date_started?: string; - date_available?: string; - date_arrives?: string; - estimated_travel_time?: number; - /** @enum {integer} */ - can_recall?: 1 | 0; - /** @enum {integer} */ - can_scuttle?: 1 | 0; - from?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - to?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - orbiting?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - details?: { - payload?: string[]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; - }[]; - number_of_ships: number; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -63203,7 +80249,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/prepare_send_spies": { + "/v2/sslc/upgrade": { parameters: { query?: never; header?: never; @@ -63212,6 +80258,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -63222,13 +80272,13 @@ export interface paths { requestBody?: { content: { "application/json": { - on_body_id: number; - to_body_id: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Gathers the ships and spies needed to call send_spies. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -63238,82 +80288,21 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - /** @description Spy Pods hold 1 spy, Spy Shuttles hold 4, other cargo-hold ships hold 1 per 350 units of hold size. */ - ships: { - id?: number; - name?: string; - type?: string; - type_human?: string; - task?: string; - speed?: number; - fleet_speed?: number; - stealth?: number; - combat?: number; - hold_size?: number; - max_occupants?: number; - berth_level?: number; - date_started?: string; - date_available?: string; - date_arrives?: string; - estimated_travel_time?: number; - /** @enum {integer} */ - can_recall?: 1 | 0; - /** @enum {integer} */ - can_scuttle?: 1 | 0; - from?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - to?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - orbiting?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - details?: { - payload?: string[]; - }; - }[]; - spies: { - id?: number; - level?: number; - name?: string; - assigned_to?: { - body_id?: number; - name?: string; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; }; - }[]; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -63335,7 +80324,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/send_spies": { + "/v2/sslc/downgrade": { parameters: { query?: never; header?: never; @@ -63344,6 +80333,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -63354,15 +80347,13 @@ export interface paths { requestBody?: { content: { "application/json": { - on_body_id: number; - to_body_id: number; - ship_id: number; - spy_ids: number[]; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Sends spies from on_body_id to to_body_id using the chosen ship. See prepare_send_spies. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -63372,75 +80363,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - ship: { - id?: number; - name?: string; - type?: string; - type_human?: string; - task?: string; - speed?: number; - fleet_speed?: number; - stealth?: number; - combat?: number; - hold_size?: number; - max_occupants?: number; - berth_level?: number; - date_started?: string; - date_available?: string; - date_arrives?: string; - estimated_travel_time?: number; - /** @enum {integer} */ - can_recall?: 1 | 0; - /** @enum {integer} */ - can_scuttle?: 1 | 0; - from?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - to?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - orbiting?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - details?: { - payload?: string[]; - }; - }; - spies_sent: number[]; - /** @description Should only be non-empty in edge cases (e.g. a spy died between calls). */ - spies_not_sent: number[]; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -63462,7 +80391,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/prepare_fetch_spies": { + "/v2/sslc/demolish": { parameters: { query?: never; header?: never; @@ -63471,6 +80400,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -63481,15 +80414,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description The planet the spies are currently on. */ - on_body_id: number; - /** @description The planet the spies should be brought to, and the ship will be dispatched from. */ - to_body_id: number; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Gathers the ships and spies needed to call fetch_spies. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -63499,81 +80430,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - ships: { - id?: number; - name?: string; - type?: string; - type_human?: string; - task?: string; - speed?: number; - fleet_speed?: number; - stealth?: number; - combat?: number; - hold_size?: number; - max_occupants?: number; - berth_level?: number; - date_started?: string; - date_available?: string; - date_arrives?: string; - estimated_travel_time?: number; - /** @enum {integer} */ - can_recall?: 1 | 0; - /** @enum {integer} */ - can_scuttle?: 1 | 0; - from?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - to?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - orbiting?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - details?: { - payload?: string[]; - }; - }[]; - spies: { - id?: number; - level?: number; - name?: string; - assigned_to?: { - body_id?: number; - name?: string; - }; - }[]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -63595,7 +80457,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/fetch_spies": { + "/v2/sslc/repair": { parameters: { query?: never; header?: never; @@ -63604,6 +80466,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -63614,17 +80480,13 @@ export interface paths { requestBody?: { content: { "application/json": { - /** @description The planet the spies are currently on. */ - on_body_id: number; - /** @description The planet the spies should be brought to, and the ship will be dispatched from. */ - to_body_id: number; - ship_id: number; - spy_ids: number[]; + /** @description The unique id of the building. */ + building_id: number; }; }; }; responses: { - /** @description Sends a ship to fetch spies from on_body_id and bring them to to_body_id. Spies not Idle on arrival are not picked up. See prepare_fetch_spies. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -63634,72 +80496,13 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - ship: { - id?: number; - name?: string; - type?: string; - type_human?: string; - task?: string; - speed?: number; - fleet_speed?: number; - stealth?: number; - combat?: number; - hold_size?: number; - max_occupants?: number; - berth_level?: number; - date_started?: string; - date_available?: string; - date_arrives?: string; - estimated_travel_time?: number; - /** @enum {integer} */ - can_recall?: 1 | 0; - /** @enum {integer} */ - can_scuttle?: 1 | 0; - from?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - to?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - orbiting?: { - id?: number; - /** @enum {string} */ - type?: "body" | "star"; - name?: string; - x?: number; - y?: number; - empire?: { - id?: number; - name?: string; - }; - }; - details?: { - payload?: string[]; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -63721,7 +80524,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spaceport/view_battle_logs": { + "/v2/sslc/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -63730,6 +80533,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -63740,14 +80547,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; - /** @description Defaults to 1. 25 per page. */ - page_number?: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ + level: number; }; }; }; responses: { - /** @description Lists this empire's battle logs, most recent first. Cleared out every seven days. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -63757,18 +80565,28 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - battle_log: { - date?: string; - attacking_body?: string; - attacking_empire?: string; - attacking_unit?: string; - defending_body?: string; - defending_empire?: string; - defending_unit?: string; - /** @enum {string} */ - victory_to?: "attacker" | "defender"; - }[]; - number_of_logs: number; + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -63795,7 +80613,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spacestationlab/build": { + "/v2/sslc/view": { parameters: { query?: never; header?: never; @@ -63804,6 +80622,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -63814,14 +80636,13 @@ export interface paths { requestBody?: { content: { "application/json": { - body_id: number; - x: number; - y: number; + /** @description The id of the building you wish to retrieve. */ + building_id: number; }; }; }; responses: { - /** @description Adds this building to the planet's build queue. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -63831,21 +80652,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - level: number; - pending_build: { - seconds_remaining: number; - start: string; - end: string; - }; - }; + building: components["schemas"]["building"]; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -63867,7 +80679,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spacestationlab/upgrade": { + "/v2/ssld/build": { parameters: { query?: never; header?: never; @@ -63876,6 +80688,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -63886,12 +80702,17 @@ export interface paths { requestBody?: { content: { "application/json": { - building_id: number; + /** @description The id of the planet you wish to build on. */ + body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ + y: number; }; }; }; responses: { - /** @description Adds the requested upgrade to the build queue. */ + /** @description Adds this building to the planet's build queue. */ 200: { headers: { [name: string]: unknown; @@ -63937,7 +80758,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spacestationlab/downgrade": { + "/v2/ssld/upgrade": { parameters: { query?: never; header?: never; @@ -63946,6 +80767,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -63956,12 +80781,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Downgrades a building by one level and then returns the building's view. */ + /** @description Adds the requested upgrade to the build queue. */ 200: { headers: { [name: string]: unknown; @@ -63971,68 +80797,15 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; - status: { - server: components["schemas"]["server_status"]; - empire?: components["schemas"]["empire_status"]; - body?: components["schemas"]["body_status"]; + building: { + id: number; + level: number; + pending_build: { + seconds_remaining: number; + start: string; + end: string; + }; }; - buildings: components["schemas"]["buildings_list"]; - }; - }; - }; - }; - /** @description RPC Error */ - 500: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["rpc_error"]; - }; - }; - }; - }; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v2/spacestationlab/demolish": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - building_id: number; - }; - }; - }; - responses: { - /** @description Instantly destroys a building. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - id?: number; - jsonrpc?: string; - result?: { status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; @@ -64060,7 +80833,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spacestationlab/repair": { + "/v2/ssld/downgrade": { parameters: { query?: never; header?: never; @@ -64069,6 +80842,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -64079,12 +80856,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Restores a building's efficiency to 100%, then returns the building's view. */ + /** @description Downgrades a building by one level and then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -64122,7 +80900,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spacestationlab/get_stats_for_level": { + "/v2/ssld/demolish": { parameters: { query?: never; header?: never; @@ -64131,6 +80909,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -64141,13 +80923,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; - level: number; }; }; }; responses: { - /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ + /** @description Instantly destroys a building. */ 200: { headers: { [name: string]: unknown; @@ -64157,33 +80939,12 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: { - id: number; - name: string; - image: string; - level: number; - food_hour?: number; - food_capacity?: number; - energy_hour?: number; - energy_capacity?: number; - ore_hour?: number; - ore_capacity?: number; - water_hour?: number; - water_capacity?: number; - waste_hour?: number; - waste_capacity?: number; - happiness_hour?: number; - upgrade?: { - cost: components["schemas"]["building_cost"]; - production: components["schemas"]["building_production"]; - image: string; - }; - }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -64205,7 +80966,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spacestationlab/view": { + "/v2/ssld/repair": { parameters: { query?: never; header?: never; @@ -64214,6 +80975,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -64224,12 +80989,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; }; responses: { - /** @description Retrieves the properties of the building. */ + /** @description Restores a building's efficiency to 100%, then returns the building's view. */ 200: { headers: { [name: string]: unknown; @@ -64245,26 +81011,7 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - make_plan?: { - types?: { - type?: string; - name?: string; - image?: string; - url?: string; - }[]; - level_costs?: { - level?: number; - food?: number; - ore?: number; - water?: number; - energy?: number; - waste?: number; - time?: number; - }[]; - subsidy_cost?: number; - /** @description Only present if a plan is currently being made. */ - making?: string; - }; + buildings: components["schemas"]["buildings_list"]; }; }; }; @@ -64286,7 +81033,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spacestationlab/make_plan": { + "/v2/ssld/get_stats_for_level": { parameters: { query?: never; header?: never; @@ -64295,6 +81042,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -64305,15 +81056,15 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; - /** @description Key from view's make_plan > types, e.g. 'ibs'. */ - type: string; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; }; responses: { - /** @description Starts the plan creation process. Returns the building view. */ + /** @description Returns the projected stats of a building at a given level. The building must already exist, since where it exists and who owns it affects the stats. */ 200: { headers: { [name: string]: unknown; @@ -64323,32 +81074,33 @@ export interface paths { id?: number; jsonrpc?: string; result?: { - building: components["schemas"]["building"]; + building: { + id: number; + name: string; + image: string; + level: number; + food_hour?: number; + food_capacity?: number; + energy_hour?: number; + energy_capacity?: number; + ore_hour?: number; + ore_capacity?: number; + water_hour?: number; + water_capacity?: number; + waste_hour?: number; + waste_capacity?: number; + happiness_hour?: number; + upgrade?: { + cost: components["schemas"]["building_cost"]; + production: components["schemas"]["building_production"]; + image: string; + }; + }; status: { server: components["schemas"]["server_status"]; empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - make_plan?: { - types?: { - type?: string; - name?: string; - image?: string; - url?: string; - }[]; - level_costs?: { - level?: number; - food?: number; - ore?: number; - water?: number; - energy?: number; - waste?: number; - time?: number; - }[]; - subsidy_cost?: number; - /** @description Only present if a plan is currently being made. */ - making?: string; - }; }; }; }; @@ -64370,7 +81122,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/spacestationlab/subsidize_plan": { + "/v2/ssld/view": { parameters: { query?: never; header?: never; @@ -64379,6 +81131,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -64389,12 +81145,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; }; responses: { - /** @description Spends essentia equal to view's subsidy_cost to complete the current plan immediately. Returns the building view. Throws 1011. */ + /** @description Retrieves the properties of the building. */ 200: { headers: { [name: string]: unknown; @@ -64410,26 +81167,6 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; - make_plan?: { - types?: { - type?: string; - name?: string; - image?: string; - url?: string; - }[]; - level_costs?: { - level?: number; - food?: number; - ore?: number; - water?: number; - energy?: number; - waste?: number; - time?: number; - }[]; - subsidy_cost?: number; - /** @description Only present if a plan is currently being made. */ - making?: string; - }; }; }; }; @@ -64460,6 +81197,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this module's properties and planet data. + * @description Retrieves the properties of this module, plus the station's own planet data. + */ post: { parameters: { query?: never; @@ -64470,6 +81211,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -64532,6 +81274,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View plans. + * @description Returns a list of all the plans this empire has collected. + */ post: { parameters: { query?: never; @@ -64542,6 +81288,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -64598,6 +81345,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View incoming supply chains. + * @description Returns a list of all incoming supply chains feeding this planet. + */ post: { parameters: { query?: never; @@ -64608,6 +81359,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -64673,6 +81425,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get the game credits. + * @description Retrieves the list of game credits. Each entry names a single contribution category and the people who worked on it. + */ post: { parameters: { query?: never; @@ -64723,6 +81479,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Rank alliances by statistic. + * @description Returns a sorted list of alliances ranked according to various stats. + */ post: { parameters: { query?: never; @@ -64806,6 +81566,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Find an alliance in the rankings. + * @description Searches for a particular alliance within the alliance rankings, returning the page of the alliance_rank listing each match appears on. + */ post: { parameters: { query?: never; @@ -64877,6 +81641,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Rank empires by statistic. + * @description Returns a sorted list of empires ranked according to various stats. + */ post: { parameters: { query?: never; @@ -64911,7 +81679,9 @@ export interface paths { empires: { empire_id: number; empire_name: string; + /** @description Always present, but null when the empire is not in an alliance. */ alliance_id: number | null; + /** @description Always present, but null when the empire is not in an alliance. */ alliance_name: string | null; colony_count: number; population: number; @@ -64959,6 +81729,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Find an empire in the rankings. + * @description Searches for a particular empire within the empire rankings, returning the page of the empire_rank listing each match appears on. + */ post: { parameters: { query?: never; @@ -65030,6 +81804,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Rank colonies by statistic. + * @description Returns a sorted list of planets ranked according to various stats. + */ post: { parameters: { query?: never; @@ -65104,6 +81882,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Rank the top spies by statistic. + * @description Returns a sorted list of the top spies in the game ranked according to various stats. + */ post: { parameters: { query?: never; @@ -65178,6 +81960,10 @@ export interface paths { }; get?: never; put?: never; + /** + * List this week's medal winners. + * @description Returns the list of empires who won this week's weekly medals. + */ post: { parameters: { query?: never; @@ -65239,6 +82025,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -65249,8 +82039,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -65311,6 +82104,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -65321,6 +82118,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -65381,6 +82179,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -65391,6 +82193,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -65443,6 +82246,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -65453,6 +82260,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -65504,6 +82312,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -65514,6 +82326,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -65566,6 +82379,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -65576,7 +82393,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -65649,6 +82468,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -65659,6 +82482,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -65710,6 +82534,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -65720,8 +82548,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -65782,6 +82613,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -65792,6 +82627,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -65852,6 +82688,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -65862,6 +82702,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -65914,6 +82755,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -65924,6 +82769,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -65975,6 +82821,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -65985,6 +82835,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -66037,6 +82888,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -66047,7 +82902,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -66120,6 +82977,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -66130,6 +82991,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -66181,6 +83043,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Transmit food. + * @description Converts 3600 seconds into 3600 food. + */ post: { parameters: { query?: never; @@ -66191,6 +83057,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -66248,6 +83115,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Transmit energy. + * @description Converts 3600 seconds into 3600 energy. + */ post: { parameters: { query?: never; @@ -66258,6 +83129,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -66315,6 +83187,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Transmit ore. + * @description Converts 3600 seconds into 3600 ore. + */ post: { parameters: { query?: never; @@ -66325,6 +83201,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -66382,6 +83259,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Transmit water. + * @description Converts 3600 seconds into 3600 water. + */ post: { parameters: { query?: never; @@ -66392,6 +83273,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -66449,6 +83331,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Complete build queue. + * @description Trades seconds for the planet's build queue time. + */ post: { parameters: { query?: never; @@ -66459,6 +83345,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -66516,6 +83403,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -66526,8 +83417,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -66588,6 +83482,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -66598,6 +83496,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -66658,6 +83557,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -66668,6 +83571,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -66720,6 +83624,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -66730,6 +83638,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -66781,6 +83690,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -66791,6 +83704,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -66843,6 +83757,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -66853,7 +83771,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -66926,6 +83846,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -66936,6 +83860,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -66987,6 +83912,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -66997,8 +83926,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -67059,6 +83991,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -67069,6 +84005,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -67129,6 +84066,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -67139,6 +84080,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -67191,6 +84133,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -67201,6 +84147,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -67252,6 +84199,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -67262,6 +84213,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -67314,6 +84266,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -67324,7 +84280,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -67397,6 +84355,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -67407,6 +84369,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -67458,6 +84421,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -67468,8 +84435,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -67530,6 +84500,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -67540,6 +84514,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -67600,6 +84575,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -67610,6 +84589,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -67662,6 +84642,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -67672,6 +84656,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -67723,6 +84708,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -67733,6 +84722,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -67785,6 +84775,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -67795,7 +84789,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -67868,6 +84864,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -67878,6 +84878,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -67929,6 +84930,10 @@ export interface paths { }; get?: never; put?: never; + /** + * List planets. + * @description Lists the planets around a given star. + */ post: { parameters: { query?: never; @@ -67939,6 +84944,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; /** @description Defaults to the star the Temple is built on. */ star_id?: number; @@ -67995,6 +85001,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View planet. + * @description Returns a surface map identical in format to an Inbox attachment map. + */ post: { parameters: { query?: never; @@ -68005,6 +85015,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; /** @description Must be a planet id, not a body id (e.g. asteroids are not valid). Must be within range — 10 star map units per level of the Temple. */ planet_id: number; @@ -68065,6 +85076,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -68075,8 +85090,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -68137,6 +85155,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -68147,6 +85169,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -68207,6 +85230,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -68217,6 +85244,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -68269,6 +85297,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -68279,6 +85311,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -68330,6 +85363,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -68340,6 +85377,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -68392,6 +85430,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -68402,7 +85444,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -68475,6 +85519,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -68485,6 +85533,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -68536,6 +85585,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -68546,8 +85599,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -68608,6 +85664,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -68618,6 +85678,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -68678,6 +85739,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -68688,6 +85753,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -68740,6 +85806,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -68750,6 +85820,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -68801,6 +85872,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -68811,6 +85886,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -68863,6 +85939,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -68873,7 +85953,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -68946,6 +86028,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -68956,6 +86042,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -69007,6 +86094,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -69017,8 +86108,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -69079,6 +86173,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -69089,6 +86187,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -69149,6 +86248,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -69159,6 +86262,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -69211,6 +86315,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -69221,6 +86329,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -69272,6 +86381,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -69282,6 +86395,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -69334,6 +86448,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -69344,7 +86462,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -69417,6 +86537,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -69427,6 +86551,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -69500,6 +86625,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Make plan. + * @description Starts making a plan. Returns the building view. + */ post: { parameters: { query?: never; @@ -69510,6 +86639,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; /** @description The plan's class, as returned by view's tasks > make_plan. */ plan_class: string; @@ -69565,6 +86695,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Split plan. + * @description Splits a plan into its constituent glyphs. Returns the building view. + */ post: { parameters: { query?: never; @@ -69575,6 +86709,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; /** @description The plan's class, as returned by view's tasks > split_plan. */ plan_class: string; @@ -69634,6 +86769,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Subsidize the current forge task. + * @description Spends essentia to complete the current task immediately (2e, unless splitting multiple plans). Returns the building view. Throws 1011. + */ post: { parameters: { query?: never; @@ -69644,6 +86783,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -69695,6 +86835,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -69705,8 +86849,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -69767,6 +86914,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -69777,6 +86928,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -69837,6 +86989,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -69847,6 +87003,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -69899,6 +87056,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -69909,6 +87070,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -69960,6 +87122,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -69970,6 +87136,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -70022,6 +87189,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -70032,7 +87203,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -70105,6 +87278,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -70115,6 +87292,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -70136,9 +87314,13 @@ export interface paths { empire?: components["schemas"]["empire_status"]; body?: components["schemas"]["body_status"]; }; + /** @description Spy training capacity for this facility. */ spies?: { + /** @description The maximum training points a spy can hold. */ max_points?: number; + /** @description Training points added per training cycle. */ points_per?: number; + /** @description The number of spies currently training here. */ in_training?: number; }; }; @@ -70171,6 +87353,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -70181,8 +87367,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -70243,6 +87432,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -70253,6 +87446,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -70313,6 +87507,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -70323,6 +87521,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -70375,6 +87574,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -70385,6 +87588,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -70436,6 +87640,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -70446,6 +87654,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -70498,6 +87707,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -70508,7 +87721,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -70581,6 +87796,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -70591,6 +87810,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -70648,6 +87868,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Start or extend Theme Park operation. + * @description Starts (or extends) operation of the Theme Park. Requires at least 1,000 of each of 5 food types to start; while operating, subsequent calls must spend at least as much food as the last call. Happiness output scales with the number of food types used and the level of the Theme Park. Returns the building view. Throws 1002, 1006, 1010, 1011. + */ post: { parameters: { query?: never; @@ -70658,6 +87882,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -70709,6 +87934,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -70719,8 +87948,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -70781,6 +88013,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -70791,6 +88027,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -70851,6 +88088,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -70861,6 +88102,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -70913,6 +88155,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -70923,6 +88169,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -70974,6 +88221,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -70984,6 +88235,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -71036,6 +88288,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -71046,7 +88302,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -71119,6 +88377,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -71129,6 +88391,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -71180,6 +88443,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Add to market. + * @description Posts a trade offer for other players to accept. + */ post: { parameters: { query?: never; @@ -71190,7 +88457,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The items to trade (resources, glyphs, plans, prisoners, or ships). */ offer: { /** @enum {string} */ type?: "glyph" | "plan" | "prisoner" | "ship"; @@ -71204,7 +88473,9 @@ export interface paths { }[]; /** @description Essentia amount requested. */ ask: number; + /** @description Optional trade options. */ options?: { + /** @description The unique id of the ship. */ ship_id?: number; }; }; @@ -71257,6 +88528,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View market. + * @description Lists other players' posted trades. + */ post: { parameters: { query?: never; @@ -71267,10 +88542,14 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; /** @description Defaults to 1. 25 items per page. */ page_number?: number; - /** @enum {string} */ + /** + * @description Optional. Narrows the list to trades offering one kind of object. + * @enum {string} + */ filter?: "food" | "ore" | "water" | "waste" | "energy" | "glyph" | "prisoner" | "ship" | "plan"; }; }; @@ -71339,6 +88618,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View my market. + * @description Lists trades posted by this empire. + */ post: { parameters: { query?: never; @@ -71349,6 +88632,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; /** @description Defaults to 1. */ page_number?: number; @@ -71419,6 +88703,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Accept from market. + * @description Accepts another player's trade. Throws 1016 if the trade is no longer valid. + */ post: { parameters: { query?: never; @@ -71429,7 +88717,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the trade. */ trade_id: number; }; }; @@ -71480,6 +88770,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Withdraw from market. + * @description Cancels a trade this empire posted and retrieves the offered items. + */ post: { parameters: { query?: never; @@ -71490,7 +88784,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the trade. */ trade_id: number; }; }; @@ -71541,6 +88837,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Push items. + * @description Transfers resources/items between planets this empire owns. + */ post: { parameters: { query?: never; @@ -71551,9 +88851,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; /** @description The destination planet, which must be owned by this empire. */ target_id: number; + /** @description The items to ship to the target planet (resources, glyphs, plans, prisoners, or ships). */ items: { /** @enum {string} */ type?: "glyph" | "plan" | "prisoner" | "ship"; @@ -71565,7 +88867,9 @@ export interface paths { prisoner_id?: number; ship_id?: number; }[]; + /** @description Optional push options. */ options?: { + /** @description The unique id of the ship. */ ship_id?: number; /** * @description Leave the ship at the destination (requires a dock there). @@ -71627,6 +88931,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get stored resources. + * @description Lists resources available in storage, by type and quantity. + */ post: { parameters: { query?: never; @@ -71637,6 +88945,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -71690,6 +88999,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get trade ships. + * @description Lists cargo vessels available for trading, with estimated travel time. + */ post: { parameters: { query?: never; @@ -71700,7 +89013,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the body being shipped to. If given, travel time is estimated. */ target_body_id?: number; }; }; @@ -71759,6 +89074,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get ships. + * @description Lists tradeable ships, with hold size and speed. + */ post: { parameters: { query?: never; @@ -71769,6 +89088,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -71826,6 +89146,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get waste ships. + * @description Lists scow vessels available for waste transport. + */ post: { parameters: { query?: never; @@ -71836,6 +89160,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -71893,6 +89218,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get supply ships. + * @description Lists hulk vessels available for resource supply chains. + */ post: { parameters: { query?: never; @@ -71903,6 +89232,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -71960,6 +89290,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View supply chains. + * @description Lists this ministry's active resource supply chains. + */ post: { parameters: { query?: never; @@ -71970,6 +89304,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -72029,6 +89364,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Create supply chain. + * @description Establishes a new resource supply chain to a target planet. + */ post: { parameters: { query?: never; @@ -72039,9 +89378,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of a planet you control to send the items to. */ target_id: number; + /** @description The resource to transfer, e.g. "water", "gold", "apple". */ resource_type: string; + /** @description The amount of the resource to transfer each hour. Set to 0 to suspend the chain. */ resource_hour: number; }; }; @@ -72092,6 +89435,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Update supply chain. + * @description Modifies an existing supply chain. + */ post: { parameters: { query?: never; @@ -72102,8 +89449,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the supply chain. */ supply_chain_id: number; + /** @description The resource to transfer, e.g. "water", "gold", "apple". */ resource_type: string; /** @description Set to 0 to suspend the chain. */ resource_hour: number; @@ -72156,6 +89506,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Delete supply chain. + * @description Removes a supply chain. + */ post: { parameters: { query?: never; @@ -72166,7 +89520,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the supply chain. */ supply_chain_id: number; }; }; @@ -72217,6 +89573,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Add supply ship to fleet. + * @description Assigns a hulk to supply chain service. Throws 1009 on failure. + */ post: { parameters: { query?: never; @@ -72227,7 +89587,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the ship. */ ship_id: number; }; }; @@ -72278,6 +89640,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Remove supply ship from fleet. + * @description Returns a hulk to the spaceport from supply chain duty. + */ post: { parameters: { query?: never; @@ -72288,7 +89654,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the ship. */ ship_id: number; }; }; @@ -72339,6 +89707,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View waste chains. + * @description Lists waste chains (a default chain exists for the local star). + */ post: { parameters: { query?: never; @@ -72349,6 +89721,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -72404,6 +89777,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Update waste chain. + * @description Adjusts the transfer rate of a waste chain. + */ post: { parameters: { query?: never; @@ -72414,8 +89791,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the waste chain. */ waste_chain_id: number; + /** @description The amount of waste to transfer each hour. Set to 0 to stop. */ waste_hour: number; }; }; @@ -72466,6 +89846,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Add waste ship to fleet. + * @description Assigns a scow to waste transport duty. Throws 1009 on failure. + */ post: { parameters: { query?: never; @@ -72476,7 +89860,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the ship. */ ship_id: number; }; }; @@ -72527,6 +89913,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Remove waste ship from fleet. + * @description Returns a scow to the spaceport from waste transport duty. + */ post: { parameters: { query?: never; @@ -72537,7 +89927,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the ship. */ ship_id: number; }; }; @@ -72588,6 +89980,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get prisoners. + * @description Lists tradeable spies, with level and sentence expiration. + */ post: { parameters: { query?: never; @@ -72598,6 +89994,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -72654,6 +90051,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get plan summary. + * @description Summarizes owned plans by type, level, and quantity. + */ post: { parameters: { query?: never; @@ -72664,6 +90065,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -72720,6 +90122,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get glyph summary. + * @description Summarizes owned glyphs by type and quantity. + */ post: { parameters: { query?: never; @@ -72730,6 +90136,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -72784,6 +90191,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Report abuse. + * @description Flags a suspicious trade for moderation review. + */ post: { parameters: { query?: never; @@ -72794,7 +90205,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the trade. */ trade_id: number; }; }; @@ -72845,6 +90258,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -72855,8 +90272,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -72917,6 +90337,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -72927,6 +90351,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -72987,6 +90412,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -72997,6 +90426,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -73049,6 +90479,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -73059,6 +90493,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -73110,6 +90545,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -73120,6 +90559,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -73172,6 +90612,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -73182,7 +90626,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -73255,6 +90701,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -73265,6 +90715,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -73327,6 +90778,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Add to market. + * @description Queues a trade for other players to see. Costs 1 essentia in addition to whatever is offered. + */ post: { parameters: { query?: never; @@ -73337,6 +90792,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; /** @description Resources, glyphs, plans, prisoners, or ships to offer. */ offer: { @@ -73401,6 +90857,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get ships. + * @description Lists ships that may be traded. Used with add_to_market. + */ post: { parameters: { query?: never; @@ -73411,6 +90871,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -73469,6 +90930,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get prisoners. + * @description Lists prisoners that may be traded. Used with add_to_market. + */ post: { parameters: { query?: never; @@ -73479,6 +90944,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -73536,6 +91002,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get plan summary. + * @description Lists plans that may be traded, in summary form. Used with add_to_market. + */ post: { parameters: { query?: never; @@ -73546,6 +91016,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -73603,6 +91074,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get glyph summary. + * @description Summarizes glyphs that may be traded. Used with add_to_market. + */ post: { parameters: { query?: never; @@ -73613,6 +91088,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -73668,6 +91144,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Withdraw from market. + * @description Removes a trade this empire posted and retrieves the offered items. + */ post: { parameters: { query?: never; @@ -73678,7 +91158,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the trade. */ trade_id: number; }; }; @@ -73729,6 +91211,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Accept from market. + * @description Accepts a trade offer from view_market. Costs the asking price plus 1 essentia. Throws 1016. + */ post: { parameters: { query?: never; @@ -73739,7 +91225,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the trade. */ trade_id: number; }; }; @@ -73790,6 +91278,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View market. + * @description Lists trades currently available to accept. + */ post: { parameters: { query?: never; @@ -73800,10 +91292,14 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; /** @description Defaults to 1. 25 items per page. */ page_number?: number; - /** @enum {string} */ + /** + * @description Optional. Narrows the list to trades offering one kind of object. + * @enum {string} + */ filter?: "food" | "ore" | "water" | "waste" | "energy" | "glyph" | "prisoner" | "ship" | "plan"; }; }; @@ -73868,6 +91364,10 @@ export interface paths { }; get?: never; put?: never; + /** + * View my market. + * @description Lists trades this empire has posted. + */ post: { parameters: { query?: never; @@ -73878,6 +91378,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; /** @description Defaults to 1. 25 items per page. */ page_number?: number; @@ -73944,6 +91445,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Get stored resources. + * @description Lists resources in storage, to make it easier to decide what to trade. + */ post: { parameters: { query?: never; @@ -73954,6 +91459,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -74008,6 +91514,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Push items. + * @description Instantly sends resources/items to another planet this empire owns. + */ post: { parameters: { query?: never; @@ -74018,6 +91528,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; /** @description A planet controlled by this empire. */ target_id: number; @@ -74081,6 +91592,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Trade one for one. + * @description Trades any resource for another one-for-one, in exchange for 3 essentia. + */ post: { parameters: { query?: never; @@ -74091,11 +91606,13 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; /** @description The resource type this empire has. See get_stored_resources. */ have: string; /** @description The resource type this empire wants. */ want: string; + /** @description How many to process. Defaults to 1. */ quantity: number; }; }; @@ -74146,6 +91663,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Report abuse. + * @description Reports a trade suspected of abusing the trade system. + */ post: { parameters: { query?: never; @@ -74156,7 +91677,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; + /** @description The unique id of the trade. */ trade_id: number; }; }; @@ -74207,6 +91730,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -74217,8 +91744,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -74279,6 +91809,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -74289,6 +91823,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -74349,6 +91884,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -74359,6 +91898,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -74411,6 +91951,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -74421,6 +91965,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -74472,6 +92017,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -74482,6 +92031,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -74534,6 +92084,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -74544,7 +92098,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -74617,6 +92173,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -74627,6 +92187,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -74678,6 +92239,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -74688,8 +92253,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -74750,6 +92318,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -74760,6 +92332,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -74820,6 +92393,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -74830,6 +92407,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -74882,6 +92460,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -74892,6 +92474,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -74943,6 +92526,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -74953,6 +92540,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -75005,6 +92593,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -75015,7 +92607,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -75088,6 +92682,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -75098,6 +92696,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -75149,6 +92748,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this module's properties. + * @description Retrieves the properties of this module. + */ post: { parameters: { query?: never; @@ -75159,6 +92762,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -75218,6 +92822,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -75228,8 +92836,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -75290,6 +92901,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -75300,6 +92915,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -75360,6 +92976,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -75370,6 +92990,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -75422,6 +93043,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -75432,6 +93057,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -75483,6 +93109,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -75493,6 +93123,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -75545,6 +93176,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -75555,7 +93190,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -75628,6 +93265,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -75638,6 +93279,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -75689,6 +93331,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -75699,8 +93345,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -75761,6 +93410,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -75771,6 +93424,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -75831,6 +93485,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -75841,6 +93499,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -75893,6 +93552,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -75903,6 +93566,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -75954,6 +93618,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -75964,6 +93632,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -76016,6 +93685,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -76026,7 +93699,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -76099,6 +93774,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -76109,6 +93788,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -76160,6 +93840,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -76170,8 +93854,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -76232,6 +93919,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -76242,6 +93933,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -76302,6 +93994,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -76312,6 +94008,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -76364,6 +94061,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -76374,6 +94075,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -76425,6 +94127,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -76435,6 +94141,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -76487,6 +94194,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -76497,7 +94208,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -76570,6 +94283,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -76580,6 +94297,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -76643,6 +94361,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Recycle. + * @description Converts waste into water, ore, and energy. The total requested must not exceed the waste in storage. Returns the building's view. + */ post: { parameters: { query?: never; @@ -76653,6 +94375,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; /** @description Amount of water to produce from waste. */ water: number; @@ -76727,6 +94450,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Subsidize recycling. + * @description Spends 2 essentia to complete the current recycling job immediately. Returns the building's view. + */ post: { parameters: { query?: never; @@ -76737,6 +94464,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -76800,6 +94528,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -76810,8 +94542,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -76872,6 +94607,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -76882,6 +94621,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -76942,6 +94682,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -76952,6 +94696,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -77004,6 +94749,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -77014,6 +94763,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -77065,6 +94815,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -77075,6 +94829,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -77127,6 +94882,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -77137,7 +94896,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -77210,6 +94971,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -77220,6 +94985,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -77283,6 +95049,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Recycle. + * @description Converts waste into water, ore, and energy. The total requested must not exceed the waste in storage. Returns the building's view. + */ post: { parameters: { query?: never; @@ -77293,6 +95063,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; /** @description Amount of water to produce from waste. */ water: number; @@ -77367,6 +95138,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Subsidize recycling. + * @description Spends 2 essentia to complete the current recycling job immediately. Returns the building's view. + */ post: { parameters: { query?: never; @@ -77377,6 +95152,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -77440,6 +95216,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -77450,8 +95230,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -77512,6 +95295,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -77522,6 +95309,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -77582,6 +95370,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -77592,6 +95384,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -77644,6 +95437,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -77654,6 +95451,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -77705,6 +95503,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -77715,6 +95517,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -77767,6 +95570,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -77777,7 +95584,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -77850,6 +95659,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -77860,6 +95673,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -77911,6 +95725,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -77921,8 +95739,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -77983,6 +95804,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -77993,6 +95818,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -78053,6 +95879,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -78063,6 +95893,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -78115,6 +95946,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -78125,6 +95960,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -78176,6 +96012,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -78186,6 +96026,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -78238,6 +96079,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -78248,7 +96093,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -78321,6 +96168,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -78331,6 +96182,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -78382,6 +96234,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -78392,8 +96248,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -78454,6 +96313,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -78464,6 +96327,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -78524,6 +96388,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -78534,6 +96402,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -78586,6 +96455,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -78596,6 +96469,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -78647,6 +96521,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -78657,6 +96535,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -78709,6 +96588,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -78719,7 +96602,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -78792,6 +96677,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -78802,6 +96691,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -78853,6 +96743,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -78863,8 +96757,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -78925,6 +96822,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -78935,6 +96836,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -78995,6 +96897,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -79005,6 +96911,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -79057,6 +96964,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -79067,6 +96978,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -79118,6 +97030,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -79128,6 +97044,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -79180,6 +97097,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -79190,7 +97111,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -79263,6 +97186,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -79273,6 +97200,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -79324,6 +97252,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -79334,8 +97266,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -79396,6 +97331,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -79406,6 +97345,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -79466,6 +97406,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -79476,6 +97420,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -79528,6 +97473,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -79538,6 +97487,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -79589,6 +97539,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -79599,6 +97553,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -79651,6 +97606,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -79661,7 +97620,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -79734,6 +97695,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -79744,6 +97709,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -79795,6 +97761,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -79805,8 +97775,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -79867,6 +97840,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -79877,6 +97854,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -79937,6 +97915,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -79947,6 +97929,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -79999,6 +97982,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -80009,6 +97996,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -80060,6 +98048,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -80070,6 +98062,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -80122,6 +98115,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -80132,7 +98129,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -80205,6 +98204,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -80215,6 +98218,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -80266,6 +98270,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Dump water as waste. + * @description Converts water into waste. + */ post: { parameters: { query?: never; @@ -80276,6 +98284,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; /** @description Amount of water to convert into waste. */ amount: number; @@ -80328,6 +98337,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue this building for construction. + * @description Adds this building to the planet's build queue at the given surface coordinates. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -80338,8 +98351,11 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the planet you wish to build on. */ body_id: number; + /** @description The x axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ x: number; + /** @description The y axis of the tile on the planet surface to place the building on. Valid values are between -5 and 5 inclusive. */ y: number; }; }; @@ -80400,6 +98416,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Queue an upgrade for this building. + * @description Adds the requested upgrade to the build queue. Throws 1002, 1010, 1011, 1012, and 1013. + */ post: { parameters: { query?: never; @@ -80410,6 +98430,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -80470,6 +98491,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Downgrade this building by one level. + * @description Downgrades a building by one level and then returns the building's view. Downgrading a level 1 building removes it, so the client must drop it from the display. Throws 1012. + */ post: { parameters: { query?: never; @@ -80480,6 +98505,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -80532,6 +98558,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Instantly destroy this building. + * @description Instantly destroys a building. Throws 1012. + */ post: { parameters: { query?: never; @@ -80542,6 +98572,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -80593,6 +98624,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Repair this building to full efficiency. + * @description Restores a building's efficiency to 100%, spending the resources listed in the view's repair_costs, then returns the building's view. + */ post: { parameters: { query?: never; @@ -80603,6 +98638,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building. */ building_id: number; }; }; @@ -80655,6 +98691,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Project this building's stats at a given level. + * @description Returns the projected stats of an existing building at a certain level. The building must already exist, because where it is and who owns it affects its stats. Intended for power users and script writers. Throws 1009. + */ post: { parameters: { query?: never; @@ -80665,7 +98705,9 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The unique id of the building you want to get the stats for. */ building_id: number; + /** @description An integer between 1 and 100 representing the level you want to see the stats for. */ level: number; }; }; @@ -80738,6 +98780,10 @@ export interface paths { }; get?: never; put?: never; + /** + * Retrieve this building's properties. + * @description Retrieves the properties of the building: its production, capacity, efficiency, repair costs, upgrade and downgrade options, and any pending build or work state. Throws 1002 and 1010. + */ post: { parameters: { query?: never; @@ -80748,6 +98794,7 @@ export interface paths { requestBody?: { content: { "application/json": { + /** @description The id of the building you wish to retrieve. */ building_id: number; }; }; @@ -80794,19 +98841,33 @@ export interface paths { export type webhooks = Record; export interface components { schemas: { + /** @description Public information about a stellar body, returned in the `body` part of the status block and used to populate the Star Map. */ body_status: { + /** @description The unique id of the body. */ id: number; + /** @description The x coordinate of the body on the star map. */ x: number; + /** @description The y coordinate of the body on the star map. */ y: number; + /** @description The id of the star this body orbits. */ star_id: number; + /** @description The name of the star this body orbits. */ star_name: string; + /** @description The star map zone the body sits in, e.g. "0|0". */ zone?: string; + /** @description Which orbit of the star the body occupies, where 1 is closest to the star. */ orbit: number; + /** @description The kind of body, e.g. "habitable planet", "gas giant", "asteroid", or "space station". */ type: string; + /** @description The name of the body. */ name: string; + /** @description The image key used to render the body. */ image: string; + /** @description The size of the body. On a planet this is the number of building plots. */ size: number; + /** @description The amount of water present on the body. */ water?: number; + /** @description The ore concentrations present on the body, keyed by ore type. */ ore: { anthracite: number; bauxite: number; @@ -80829,95 +98890,176 @@ export interface components { uraninite: number; zircon: number; }; + /** @description The empire occupying this body. Only present when an empire occupies it. */ empire?: { + /** @description The id of the occupying empire. */ id: number; + /** @description The name of the occupying empire. */ name: string; - /** @enum {string} */ + /** + * @description The occupying empire's alignment relative to you. + * @enum {string} + */ alignment: "ally" | "self" | "hostile"; - /** @enum {integer} */ + /** + * @description 1 if the occupying empire has not sent out any probes or colony ships. + * @enum {integer} + */ is_isolationist: 1 | 0; }; + /** @description The space station whose influence this body is under. Only present when the body is within a station's jurisdiction. */ station?: { + /** @description The id of the space station. */ id: number; + /** @description The x coordinate of the space station. */ x: number; + /** @description The y coordinate of the space station. */ y: number; + /** @description The name of the space station. */ name: string; }; }; + /** @description The comprehensive "own body" shape returned as the `planet` block on the Planetary Command / Station Command `view` — a body_status plus population, happiness, and per-resource stored/hour/capacity figures. Only returned for a body you own. */ planet_status: { + /** @description The unique id of the body. */ id?: number; + /** @description The x coordinate of the body on the star map. */ x?: number; + /** @description The y coordinate of the body on the star map. */ y?: number; + /** @description The id of the star this body orbits. */ star_id?: number; + /** @description The name of the star this body orbits. */ star_name?: string; + /** @description The star map zone the body sits in, e.g. "0|0". */ zone?: string; + /** @description Which orbit of the star the body occupies, where 1 is closest to the star. */ orbit?: number; + /** @description The kind of body, e.g. "habitable planet", "gas giant", "asteroid", or "space station". */ type?: string; + /** @description The name of the body. */ name?: string; + /** @description The image key used to render the body. */ image?: string; + /** @description The size of the body. On a planet this is the number of building plots. */ size?: number; + /** @description The amount of water stored on the body. */ water?: number; + /** @description The ore concentrations present on the body, keyed by ore type. */ ore?: { [key: string]: number; }; + /** @description The per-colony notes set for this body. */ notes?: string; + /** @description The earliest time the body may enter the neutral area. */ neutral_entry?: string; + /** @description The empire occupying this body. Only present when an empire occupies it. */ empire?: { + /** @description The id of the occupying empire. */ id?: number; + /** @description The name of the occupying empire. */ name?: string; - /** @enum {string} */ + /** + * @description The occupying empire's alignment relative to you. + * @enum {string} + */ alignment?: "ally" | "self" | "hostile"; - /** @enum {integer} */ + /** + * @description 1 if the occupying empire has not sent out any probes or colony ships. + * @enum {integer} + */ is_isolationist?: 1 | 0; }; + /** @description The number of buildings currently on the body. */ building_count?: number; + /** @description The current population of the body. */ population?: number; + /** @description The current happiness stored on the body. */ happiness?: number; + /** @description The net happiness produced per hour on the body. */ happiness_hour?: number; + /** @description The amount of food currently in storage. */ food_stored?: number; + /** @description The total food storage capacity. */ food_capacity?: number; + /** @description The net food produced per hour. */ food_hour?: number; + /** @description The amount of energy currently in storage. */ energy_stored?: number; + /** @description The total energy storage capacity. */ energy_capacity?: number; + /** @description The net energy produced per hour. */ energy_hour?: number; + /** @description The net ore produced per hour. */ ore_hour?: number; + /** @description The total ore storage capacity. */ ore_capacity?: number; + /** @description The amount of ore currently in storage. */ ore_stored?: number; + /** @description The net waste produced per hour. */ waste_hour?: number; + /** @description The amount of waste currently in storage. */ waste_stored?: number; + /** @description The total waste storage capacity. */ waste_capacity?: number; + /** @description The amount of water currently in storage. */ water_stored?: number; + /** @description The net water produced per hour. */ water_hour?: number; + /** @description The total water storage capacity. */ water_capacity?: number; + /** @description The number of incoming ships from your own colonies. */ num_incoming_own?: number; + /** @description The number of incoming ships from within your alliance. */ num_incoming_ally?: number; + /** @description The total number of incoming foreign ships. */ num_incoming_enemy?: number; }; + /** @description Information about the current state of the empire, returned in the `empire` part of the status block of every relevant request. */ empire_status: { + /** @description The empire's current essentia balance. */ essentia: number; + /** @description Keyed by body id (a stringified integer), value is the colony name. */ colonies: { [key: string]: string; }; + /** @description The number of calls made to the server so far in the current RPC period. */ rpc_count: number; + /** @description 1 if the empire hasn't sent out any probes or colony ships. */ is_isolationist: number; + /** @description The unique id of the empire. */ id: number; + /** @description Keyed by body id (a stringified integer), value is the planet name. */ planets: { [key: string]: string; }; + /** @description The number of unread messages in the inbox. */ has_new_messages: number; + /** @description The name of the empire. */ name: string; + /** @description The id of the empire's home planet. */ home_planet_id: number; + /** @description The current insurrection value. */ insurrect_value: number; + /** @description The empire's status message. */ status_message: string; + /** @description 1 if the self destruct countdown is currently running. */ self_destruct_active: number; + /** @description The resource cost of the next colony. */ next_colony_srcs: number; + /** @description Keyed by space station id (a stringified integer), value is the station name. */ stations: { [key: string]: string; }; + /** @description The date the empire will self destruct, when a countdown is active. */ self_destruct_date: string; + /** @description The happiness cost of founding the next colony. */ next_colony_cost: number; + /** @description The id of the most recent message. */ latest_message_id: number; + /** @description The bodies known to the empire, grouped by relationship. */ bodies: { + /** @description The colonies owned by the empire. */ colonies: { empire_name: string; x: number; @@ -80931,40 +99073,62 @@ export interface components { zone: string; }[]; }; + /** @description The resource cost of the next space station. */ next_station_cost: number; + /** @description The highest level the University has reached. */ tech_level: number; }; + /** @description The resource and time cost of a build or upgrade. */ building_cost: { + /** @description Food spent from storage. */ food?: number; + /** @description Water spent from storage. */ water?: number; + /** @description Energy spent from storage. */ energy?: number; + /** @description Waste added to storage (not spent like the other resources). */ waste?: number; + /** @description Ore spent from storage. */ ore?: number; + /** @description Build time in seconds. */ time: number; + /** @description Number of Halls of Vrbansk required, for buildings built from glyphs. */ halls?: number; }; + /** @description The lightweight per-building shape returned by get_buildings / repair_list. Place these on the planet's 11x11 grid and fill the rest with blank ground tiles. Not the full `building` schema, since this is a list/grid view rather than a single-building detail view. */ buildings_list: { /** @description Keyed by building id (a stringified integer). */ buildings: { [key: string]: { + /** @description The building id. Same value as the map key, repeated for convenience. */ id: number; + /** @description The building name. */ name: string; + /** @description The x coordinate of the building on the surface grid. */ x: number; + /** @description The y coordinate of the building on the surface grid. */ y: number; + /** @description The building type's API URL, e.g. "/apple". */ url: string; + /** @description The current level of the building. */ level: number; + /** @description The image key used to render the building. */ image: string; + /** @description The current efficiency of the building, from 0 to 100. */ efficiency: number; + /** @description Only included when the building is being built or upgraded. */ pending_build?: { seconds_remaining: number; start: string; end: string; }; + /** @description Only included when the building is working (Parks, Waste Recycling, etc). */ work?: { seconds_remaining: number; start: string; end: string; }; + /** @description Only included when the building is damaged (efficiency below 100). */ repair_costs?: { food: number; water: number; @@ -80974,62 +99138,97 @@ export interface components { }; }; }; + /** @description A building's hourly production and storage capacity for each resource. */ building_production: { + /** @description Net food produced per hour. */ food_hour: number; + /** @description Food storage capacity added. */ food_capacity: number; + /** @description Net energy produced per hour. */ energy_hour: number; + /** @description Energy storage capacity added. */ energy_capacity: number; + /** @description Net ore produced per hour. */ ore_hour: number; + /** @description Ore storage capacity added. */ ore_capacity: number; + /** @description Net water produced per hour. */ water_hour: number; + /** @description Water storage capacity added. */ water_capacity: number; + /** @description Net waste produced per hour. */ waste_hour: number; + /** @description Waste storage capacity added. */ waste_capacity: number; + /** @description Net happiness produced per hour. */ happiness_hour: number; }; + /** @description A single building's contribution to the planet economy, as returned by get_buildings_resources: the same aggregate figures as `building_production` plus a per-food-type and per-ore-type production breakdown. `ore_hour`, `ore_capacity` and `ore` are all omitted for the Mining Ministry, whose ore output is driven by its deployed mining platforms rather than the building itself. */ building_resources: { + /** @description Net food produced per hour. */ food_hour: number; + /** @description Food storage capacity added. */ food_capacity: number; + /** @description Net energy produced per hour. */ energy_hour: number; + /** @description Energy storage capacity added. */ energy_capacity: number; + /** @description Net water produced per hour. */ water_hour: number; + /** @description Water storage capacity added. */ water_capacity: number; + /** @description Net waste produced per hour. */ waste_hour: number; + /** @description Waste storage capacity added. */ waste_capacity: number; + /** @description Net happiness produced per hour. */ happiness_hour: number; + /** @description Net ore produced per hour. Omitted for the Mining Ministry. */ ore_hour?: number; + /** @description Ore storage capacity added. Omitted for the Mining Ministry. */ ore_capacity?: number; - /** @description Hourly production keyed by food type. */ + /** @description Hourly production keyed by food type. Only included when the building produces food. */ food?: { [key: string]: number; }; - /** @description Hourly production keyed by ore type. */ + /** @description Hourly production keyed by ore type. Only included when the building produces ore. */ ore?: { [key: string]: number; }; }; - /** @description Keyed by building id (a stringified integer). */ + /** @description The per-building shape returned by get_buildings_resources — the lightweight grid shape (as in buildings_list) with a `resources` object added. Keyed by building id (a stringified integer), one level deep (no extra `buildings` wrapper). */ buildings_resources_list: { [key: string]: { + /** @description The building id. Same value as the map key, repeated for convenience. */ id: number; + /** @description The building name. */ name: string; + /** @description The x coordinate of the building on the surface grid. */ x: number; + /** @description The y coordinate of the building on the surface grid. */ y: number; + /** @description The building type's API URL, e.g. "/apple". */ url: string; + /** @description The current level of the building. */ level: number; + /** @description The image key used to render the building. */ image: string; + /** @description The current efficiency of the building, from 0 to 100. */ efficiency: number; resources: components["schemas"]["building_resources"]; + /** @description Only included when the building is being built or upgraded. */ pending_build?: { seconds_remaining: number; start: string; end: string; }; + /** @description Only included when the building is working (Parks, Waste Recycling, etc). */ work?: { seconds_remaining: number; start: string; end: string; }; + /** @description Only included when the building is damaged (efficiency below 100). */ repair_costs?: { food: number; water: number; @@ -81038,79 +99237,132 @@ export interface components { }; }; }; + /** @description The fields common to every building's `view` response. Building-type-specific endpoints (see src/spec/paths/buildings/*.ts) add extra sibling fields alongside this on `view`. */ building: { + /** @description The unique id of the building. */ id: number; + /** @description The building name. */ name: string; + /** @description The image key used to render the building. */ image: string; + /** @description The building type's API URL, e.g. "/apple". */ url?: string; + /** @description The current level of the building. */ level: number; + /** @description The x coordinate of the building on the surface grid. */ x: number; + /** @description The y coordinate of the building on the surface grid. */ y: number; + /** @description The current efficiency of the building, from 0 to 100. */ efficiency: number; + /** @description Net food produced per hour. */ food_hour: number; + /** @description Food storage capacity added. */ food_capacity: number; + /** @description Net energy produced per hour. */ energy_hour: number; + /** @description Energy storage capacity added. */ energy_capacity: number; + /** @description Net ore produced per hour. */ ore_hour: number; + /** @description Ore storage capacity added. */ ore_capacity: number; + /** @description Net water produced per hour. */ water_hour: number; + /** @description Water storage capacity added. */ water_capacity: number; + /** @description Net waste produced per hour. */ waste_hour: number; + /** @description Waste storage capacity added. */ waste_capacity: number; + /** @description Net happiness produced per hour. */ happiness_hour: number; + /** @description The resources it would cost to repair the building to full efficiency. See the repair method. */ repair_costs: { food: number; water: number; energy: number; ore: number; }; + /** @description Only present while the building is being built or upgraded. */ pending_build?: { seconds_remaining: number; start: string; end: string; }; + /** @description Only present while the building is doing work (e.g. Parks, Waste Recycling). */ work?: { seconds_remaining: number; start: string; end: string; + /** @description Present for an Archaeology Ministry that is searching for a glyph — the ore being searched. */ searching?: string; }; + /** @description Whether the building can be downgraded, and why not. */ downgrade: { - /** @enum {integer} */ + /** + * @description 1 if the building can be downgraded. + * @enum {integer} + */ can: 1 | 0; + /** @description A [code, message] pair; [0, ""] when there is no reason. */ reason: unknown[]; + /** @description The image key for the downgraded building. */ image: string; }; + /** @description Whether the building can be upgraded, its cost, and its projected stats. */ upgrade: { - /** @enum {integer} */ + /** + * @description 1 if the building can be upgraded. + * @enum {integer} + */ can: 1 | 0; + /** @description A [code, message] pair; [0, ""] when there is no reason. */ reason: unknown[]; cost: components["schemas"]["building_cost"]; production: components["schemas"]["building_production"]; + /** @description The image key for the upgraded building. */ image: string; }; }; + /** @description A JSON-RPC error response. The game returns these with an HTTP 500 status code whenever a method throws. */ rpc_error: { + /** @description The id echoed back from the request. */ id: number; + /** @description The JSON-RPC version, always "2.0". */ jsonrpc: string; error: { - /** @enum {integer} */ + /** + * @description The error code. 1000-1018 are general game errors, 1100-1101 concern un-founded empires, and 1200 is game over. See ErrorCodes in the original documentation. + * @enum {integer} + */ code: 1000 | 1001 | 1002 | 1003 | 1004 | 1005 | 1006 | 1007 | 1008 | 1009 | 1010 | 1011 | 1012 | 1013 | 1014 | 1015 | 1016 | 1017 | 1018 | 1100 | 1101 | 1200; + /** @description A human-readable description of the error. */ message: string; + /** @description Extra context for the error, when available — e.g. a fresh captcha for 1014, or an empire id for 1100. */ data?: Record; }; }; + /** @description Server-wide state, returned in the `server` part of the status block of every response. */ server_status: { + /** @description The running server version. */ version: number; + /** @description The current server time, e.g. "01 31 2010 13:09:05 +0600". */ time: string; + /** @description The inclusive [min, max] bounds of the star map on each axis. */ star_map_size: { y: number[]; x: number[]; }; + /** @description The number of RPC calls allowed per 24 hour period. */ rpc_limit: number; - /** @enum {integer} */ + /** + * @description 1 when a server announcement is active. Clients pop the announcement window on the 0 -> 1 transition. + * @enum {integer} + */ announcement?: 1 | 0; }; + /** @description The "General" tab of the in-game stats window is fed by a static `server_overview.json` snapshot on the server (not a JSON-RPC method), so it has no path in this spec. This schema documents that snapshot's shape. */ server_overview: { bodies?: { count?: number; diff --git a/package-lock.json b/package-lock.json index 514a6e7..6367776 100644 --- a/package-lock.json +++ b/package-lock.json @@ -16,7 +16,7 @@ "proper-url-join": "^2.1.2" }, "devDependencies": { - "@tlecommunity/api-spec": "^1.4.0", + "@tlecommunity/api-spec": "^1.6.2", "@types/jest": "^30.0.0", "@types/proper-url-join": "^2.1.5", "ajv": "^8.20.0", @@ -1541,9 +1541,9 @@ } }, "node_modules/@tlecommunity/api-spec": { - "version": "1.4.0", - "resolved": "https://gitea.allosaurus-chromatic.ts.net/api/packages/tlecommunity/npm/%40tlecommunity%2Fapi-spec/-/1.4.0/api-spec-1.4.0.tgz", - "integrity": "sha512-xieT9UDBOjaES1T/t+ZPMTVPrFyk6VckdK227MyJqXaUnamTT41u8wh0AextMdR+GiefTt9ktjdSV4hstkcXUQ==", + "version": "1.6.2", + "resolved": "https://gitea.allosaurus-chromatic.ts.net/api/packages/tlecommunity/npm/%40tlecommunity%2Fapi-spec/-/1.6.2/api-spec-1.6.2.tgz", + "integrity": "sha512-esIoLuLzh1E18HMcGLCZDxjGr4UpDJCI/4AXx3pzLJgWIg59aVklyRvcoKRJFA8RdiouCwfMJ5hTBh92aayKWQ==", "dev": true, "license": "MIT" }, @@ -7169,9 +7169,9 @@ } }, "@tlecommunity/api-spec": { - "version": "1.4.0", - "resolved": "https://gitea.allosaurus-chromatic.ts.net/api/packages/tlecommunity/npm/%40tlecommunity%2Fapi-spec/-/1.4.0/api-spec-1.4.0.tgz", - "integrity": "sha512-xieT9UDBOjaES1T/t+ZPMTVPrFyk6VckdK227MyJqXaUnamTT41u8wh0AextMdR+GiefTt9ktjdSV4hstkcXUQ==", + "version": "1.6.2", + "resolved": "https://gitea.allosaurus-chromatic.ts.net/api/packages/tlecommunity/npm/%40tlecommunity%2Fapi-spec/-/1.6.2/api-spec-1.6.2.tgz", + "integrity": "sha512-esIoLuLzh1E18HMcGLCZDxjGr4UpDJCI/4AXx3pzLJgWIg59aVklyRvcoKRJFA8RdiouCwfMJ5hTBh92aayKWQ==", "dev": true }, "@tybys/wasm-util": { diff --git a/package.json b/package.json index ef6d6b7..8c46c0a 100644 --- a/package.json +++ b/package.json @@ -33,7 +33,7 @@ "author": "Natalie Rose ", "license": "MIT", "devDependencies": { - "@tlecommunity/api-spec": "^1.4.0", + "@tlecommunity/api-spec": "^1.6.2", "@types/jest": "^30.0.0", "@types/proper-url-join": "^2.1.5", "ajv": "^8.20.0", -- 2.51.2