import { AxiosError, AxiosResponse } from 'axios';
import { EventEmitter } from 'node:events';
import { LoadConfigOptions, ScreepsClientConfig, ScreepsHttpConfig, ScreepsRawServerConfig, ScreepsServerConfig } from './ScreepsConfigManager';
import { RateLimit, ScreepsRateLimitTracker } from './ScreepsRateLimitTracker';
import { ScreepsSocketClient } from './ScreepsSocketClient';
import { BuildableStructureType, CpuShardLimits, FlagColor, MarketResource, RoomStat, RoomStatInterval, UserBadge, UserCodeModules } from './common';
import * as Http from './http';
import { ScreepsHttpMethod } from './http';
/**
 * Contains all information needed to submit an API request via
 * {@link ScreepsHttpClient.req}.
 *
 * This is included in {@link ScreepsApiError}, {@link RateLimitEvent},
 * and {@link ScreepsHttpResponse}. It allows response data to be matched to a
 * request, or for requests to be retried if needed.
 * @category HTTP API
 */
export interface ScreepsHttpRequest {
    method: ScreepsHttpMethod;
    path: string;
    params: unknown;
    retriesAttempted: number;
}
/**
 * Payload of {@link ScreepsHttpClient.RATE_LIMIT} events.
 * @category HTTP API
 */
export interface RateLimitEvent extends RateLimit, ScreepsHttpRequest {
}
/**
 * Payload of {@link ScreepsHttpClient.RESPONSE_RESULT} events.
 * @category HTTP API
 */
export interface ScreepsHttpResponse<T extends Http.ScreepsResponse | Http.ScreepsErrorResponse = Http.ScreepsResponse> extends ScreepsHttpRequest {
    /** The data field from the response body */
    data: T;
}
/**
 * Options to use with {@link ScreepsHttpClient.debug}
 * @category HTTP API
 */
export interface DebugOptions {
    /** Enable debug logs for ScreepsConfigManager */
    config?: boolean;
    /** Enable debug logs for HTTP API requests */
    http?: boolean;
    /** Enable debug logs for HTTP API rate limit state */
    ratelimit?: boolean;
    /** Enable debug logs for HTTP API rate limit exceeded events */
    ratelimitexceeded?: boolean;
    /** Enable debug logs for WebSocket API events and messages */
    socket?: boolean;
}
/**
 * The expected number of ticks in a {@link ScreepsRoomHistoryResponse} from an official server.
 *
 * **NOTE:** The actual number of ticks is returned by
 * {@link ScreepsVersionResponse | ScreepsVersionResponse.serverData.historyChunkSize}
 * @category HTTP API
 */
export declare const OFFICIAL_HISTORY_INTERVAL = 100;
/**
 * The expected number of ticks in a {@link ScreepsRoomHistoryResponse} from an unofficial server.
 *
 * **NOTE:** The actual number of ticks is returned by
 * {@link ScreepsVersionResponse | ScreepsVersionResponse.serverData.historyChunkSize}
 * @category HTTP API
 */
export declare const PRIVATE_HISTORY_INTERVAL = 20;
/**
 * Specifies the delay between retry attempts for API requests that are rejected due to the global rate limit.
 *
 * The delay for each retry attempt is calculated using the following formula:
 * ```ts
 * const delay = Math.floor(var * Math.random()) + min
 * ```
 * @see {@link ScreepsClientConfig.retry429Global} to enable/disable this behavior
 * @category HTTP API
 */
export declare const GLOBAL_RATE_LIMIT_DELAY: {
    /** The constant portion of the delay */
    readonly min: 200;
    /** The random variable portion of the delay */
    readonly var: 500;
};
/**
 * Provides access to the Screeps HTTP API.
 *
 * Please note that the Screeps HTTP API is not technically a public API; it
 * merely exists to power the game's official Steam and web clients.
 * While the game's developers {@link https://docs.screeps.com/auth-tokens.html | welcome its use},
 * the implicit caveat is that the API is subject to change without warning.
 *
 * All endpoint methods are asynchronous.
 *
 * Some of endpoints behave differently on official servers (i.e. any server
 * with the {@link https://screeps.com/ | screeps.com} hostname) than they do
 * on unofficial/private servers. Any known discrepancies are documented on
 * the relevant endpoint.
 *
 * Almost all endpoints require the user to be authenticated to use. Any known
 * exceptions to this rule are documented.
 *
 * All endpoint methods are backed by {@link req}, which provides shared
 * error handling logic, etc. If an endpoint does not have a corresponding
 * method defined here, {@link req} may be called to access that endpoint
 * directly (albeit without request parameter or response type annotations).
 * Please consider submitting a PR to add functions for any missing endpoints!
 *
 * Instances should typically be initialized via {@link ScreepsHttpClient.fromConfig},
 * but the constructor can also be called directly if you prefer to handle
 * loading the credentials and configuration options yourself.
 * @see {@link ScreepsSocketClient} for the WebSocket API client (accessible via {@link ScreepsHttpClient.socket})
 * @example
 * // To access the `GET /api/auth/me` endpoint:
 * const me = await api.authMe()
 * @category HTTP API
 * @categoryDescription Endpoints: /
 * Top-level API endpoints
 * @categoryDescription Endpoints: /auth
 * Endpoints for authenticating to the server or checking authentication status
 * @categoryDescription Endpoints: /experimental
 * Endpoints that are not yet considered stable. Their request parameters
 * and response formats are subject to change without warning (even more so than
 * the rest of the API), and they may not be available on all servers.
 *
 * Currently, all endpoints in this category are used to query for
 * current/recent PVP activity.
 *
 * See the `Endpoints: /warpath` category for similar endpoints
 * @categoryDescription Endpoints: /game
 * Endpoints used to read or modify game state
 * @categoryDescription Endpoints: /game/market
 * Endpoints for reading or modifying the state of the
 * {@link https://docs.screeps.com/market.html | in-game market}
 * @categoryDescription Endpoints: /game/shards
 * Endpoints for listing available shards and querying shard metadata
 * @categoryDescription Endpoints: /leaderboard
 * Endpoints for querying control/power leaderboards
 *
 * See the `Endpoints: /scoreboard` category for Seasonal World competition leaderboards
 * @categoryDescription Endpoints: /register
 * Endpoints for creating new user accounts
 * @categoryDescription Endpoints: /scoreboard
 * Endpoints for querying scoreboard results
 *
 * This appears to only be relevant to
 * {@link https://screeps.com/season/#!/seasons/chronicle | Seasonal World}
 * competitions/events.
 *
 * See also:
 * - `Endpoints: /seasons` category: Seasonal World metadata endpoints
 * - `Endpoints: /leaderboard` category: for non-seasonal leaderboard endpoints
 * @categoryDescription Endpoints: /seasons
 * Endpoints for {@link https://screeps.com/season/#!/seasons/chronicle | seasonal world} events.
 * See the `Endpoints: /scoreboard` category for Seasonal World scoreboard endpoints
 * @categoryDescription Endpoints: /servers
 * Endpoints that provide information about other servers
 * @categoryDescription Endpoints: /user
 * Endpoints for reading or modifying state about the authenticated user,
 * or for looking up information on other users
 * @categoryDescription Endpoints: /user/code
 * Endpoints for downloading or uploading code
 * @categoryDescription Endpoints: /user/decorations
 * Endpoints for managing {@link DecorationInstance | decorations}
 * @categoryDescription Endpoints: /user/memory
 * Endpoints for reading from or writing to
 * {@link https://docs.screeps.com/global-objects.html#Memory-object | Memory}.
 * @categoryDescription Endpoints: /user/memory/segment
 * Endpoints for reading from or writing to
 * {@link https://docs.screeps.com/api/#RawMemory.segments | RawMemory.segments}.
 * @categoryDescription Endpoints: /user/messages
 * Endpoints for reading or managing in-game messages
 * @categoryDescription Endpoints: /warpath
 * Endpoints for querying current/recent PVP activity by room.
 *
 * These may not be implemented on all servers. Most notably, they are not
 * available on official servers, but the third-party service
 * {@link https://voight-kampff.fly.dev/ | Voight-Kampff} provides these
 * and more for official servers and popular community servers.
 *
 * See the `Endpoints: /experimental` category for similar endpoints
 */
export declare class ScreepsHttpClient extends EventEmitter {
    /**
     * Fired immediately before authentication status changes.
     *
     * Payload:
     * @event boolean Whether or not the client is now authenticated
     * @category Events
     */
    static readonly AUTH = "auth";
    /**
     * Fired when a rate limit is exceeded
     *
     * Payload:
     * @event {@link RateLimitEvent} The latest rate limit state
     * @category Events
     */
    static readonly RATE_LIMIT = "rateLimit";
    /**
     * Fired when a response is received from the HTTP API.
     *
     * Payload:
     * @event {@link AxiosResponse} The HTTP response
     * @category Events
     */
    static readonly RESPONSE = "response";
    /**
     * Fired when a response is received from the HTTP API.
     *
     * Payload:
     * @event {@link ScreepsHttpResponse} The HTTP response, including params
     *  of the associated request
     * @category Events
     */
    static readonly RESPONSE_RESULT = "responseResult";
    /**
     * Fired immediately before {@link ScreepsHttpClient.token} is updated.
     *
     * Payload:
     * @event string The new API token
     * @category Events
     */
    static readonly TOKEN = "token";
    /**
     * Search for a config/credential file and initializes the client from the first file found.
     *
     * Authentication will occur automatically if email/password credentials
     * are provided in lieu of an API token.
     *
     * Alternatively, the client can be initialized by passing a configuration
     * object directly to the constructor.
     * @param serverName The property name of the server object to use from the config file
     * @param opts See {@link LoadConfigOptions}
     * @returns A configured and authenticated {@link ScreepsHttpClient} instance
     * @throws {@link node!Error | Error} if the selected config file is invalid or if no config files are found
     * @category none
     */
    static fromConfig(serverName: string, opts?: LoadConfigOptions): Promise<ScreepsHttpClient>;
    appConfig: ScreepsClientConfig;
    readonly rateLimits: ScreepsRateLimitTracker;
    readonly socket: ScreepsSocketClient;
    /**
     * The Screeps World server to which this client is currently configured to use.
     *
     * Use {@link setServer} to switch servers.
     */
    get server(): Readonly<ScreepsServerConfig>;
    /**
     * The API token that this client is currently using for authentication.
     * @see {@link ScreepsHttpClient.TOKEN}
     */
    get token(): string | undefined;
    private _authed;
    private _http;
    private _server;
    private _token?;
    private _tokenInfo?;
    private _user?;
    /**
     * @category none
     */
    constructor(config: ScreepsHttpConfig);
    constructor(serverConfig: ScreepsServerConfig | ScreepsRawServerConfig);
    /**
     * Fetch basic information about a server, including versioning info,
     * available shards, available features, and more.
     *
     * This endpoint does not require authentication.
     *
     * Endpoint: `GET /api/version`
     * @category Endpoints: /
     */
    version(): Promise<Http.ScreepsVersionResponse>;
    /**
     * Describes the server mod used for authentication on unofficial servers.
     *
     * For official servers, the name of the mod is always `'official'`.
     *
     * This endpoint does not require authentication.
     *
     * Endpoint: `GET /api/authmod`
     * @category Endpoints: /
     */
    authmod(): Promise<Http.ScreepsAuthModResponse>;
    /**
     * Fetch a chunk of history data for a single room.
     *
     * Official Endpoint: `GET /room-history/${shard}/${room}/${tick}.json`
     *
     * Unofficial Endpoint: `GET /room-history`
     * @param room Name of the room for which to fetch history
     * @param tick Tick for which history should be fetched
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @throws {@link ScreepsApiError} if history is unsupported or the requested chunk is missing
     * - HTTP 500: this is an unofficial server that does not record room history
     * - HTTP 404: the requested history chunk does not exist
     * @see {@link version} returns the history chunk size to expect
     * @category Endpoints: /
     */
    history(room: string, tick: number, shard?: string): Promise<Http.ScreepsRoomHistoryResponse>;
    /**
     * Fetch a curated list of
     * {@link https://docs.screeps.com/community-servers.html | community servers}.
     *
     * This endpoint does not require authentication.
     *
     * Endpoint: `POST /api/servers/list`
     * @throws {@link ScreepsApiError} HTTP 404 if used on an unofficial server
     * @category Endpoints: /servers
     */
    serversList(): Promise<Http.ServerListResponse>;
    /**
     * Authenticate to the server using email/password credentials.
     *
     * This authentication method has not worked on official servers
     * since 2018, but it is still used for unofficial servers.
     *
     * Endpoint: `POST /api/auth/signin`
     * @param email The email address used for registration
     * @param password The password used for registration
     * @category Endpoints: /auth
     */
    authSignin(email: string, password: string): Promise<Http.AuthSigninResponse>;
    /**
     * Authenticate via Steam SSO.
     *
     * Steam and Github SSO are the only permitted authentication methods
     * on official servers.
     *
     * Endpoint: `POST /api/auth/steam-ticket`
     * @param ticket Do you know what this does? If so, please submit a PR!
     * @param useNativeAuth Do you know what this does? If so, please submit a PR!
     * @category Endpoints: /auth
     */
    authSteamTicket(ticket: unknown, useNativeAuth?: boolean): Promise<Http.ScreepsUnknownResponse>;
    /**
     * Fetch information about the authenticated user.
     *
     * Endpoint: `GET /api/auth/me`
     * @category Endpoints: /auth
     */
    authMe(): Promise<Http.AuthMeResponse>;
    /**
     * Query the status/permissions of an API token.
     *
     * Endpoint: `GET /api/auth/query-token`
     * @param token The API token for which permissions should be queried
     * @throws {@link ScreepsApiError} if the token is invalid / not recognized.
     * @see {@link ScreepsHttpClient.token} for the API token currently in use by this client
     * @category Endpoints: /auth
     */
    authQueryToken(token: string): Promise<Http.AuthQueryTokenResponse>;
    /**
     * Checks the availability of an email address.
     *
     * This endpoint does not require authentication.
     *
     * Endpoint: `GET /api/register/check-email`
     * @param email The email address to check
     * @returns If the email is available, returns {@link Http.ScreepsResponse}.
     *  If the email is taken, returns {@link Http.ScreepsErrorResponse}
     *  (`{ error: 'exists' }`).
     * @category Endpoints: /register
     */
    registerCheckEmail(email: string): Promise<Http.ScreepsResponse | Http.ScreepsErrorResponse>;
    /**
     * Checks the availability of a username.
     *
     * This endpoint does not require authentication.
     *
     * Endpoint: `GET /api/register/check-username`
     * @param username The username to check
     * @returns If the username is available, returns {@link Http.ScreepsResponse}.
     *  If the username is taken, returns {@link Http.ScreepsErrorResponse}
     *  (`{ error: 'exists' }`).
     * @category Endpoints: /register
     */
    registerCheckUsername(username: string): Promise<Http.ScreepsResponse | Http.ScreepsErrorResponse>;
    /**
     * Endpoint: `POST /api/register/set-username`
     * @param username The username to associate with this account
     * @returns Please consider submitting a PR to document the success response.
     *  If used for an account that is already set up, returns
     *  {@link Http.ScreepsErrorResponse} (`{ error: 'username already set' }`).
     * @category Endpoints: /register
     */
    registerSetUsername(username: string): Promise<Http.ScreepsUnknownResponse | Http.ScreepsErrorResponse>;
    /**
     * Create a new user account.
     *
     * Endpoint: `POST /api/register/submit`
     * @param username The username to use for this new account
     * @param email The email address to associate with this new account
     * @param password The password to use for this new account.
     *  It is unclear whether or not this is accepted or even allowed on official servers.
     * @param modules Initial bot code to deploy for this user
     * @category Endpoints: /register
     */
    registerSubmit(username: string, email: string, password: string, modules?: UserCodeModules): Promise<Http.ScreepsUnknownResponse>;
    /**
     * Fetch statistics for one or more rooms along with
     * basic information like owner and RCL.
     *
     * Endpoint: `POST /api/game/map-stats`
     * @param rooms An array of one or more room names.
     * @param statName The type of stat to fetch. See {@link Http.MapStat}.
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game
     */
    gameMapStats<S extends Http.MapStat>(rooms: string[], statName: S, shard?: string): Promise<Http.GameMapStatsResponse<S>>;
    /**
     * Generate a name for a new room object.
     *
     * The generated name will be unique across all other objects of that
     * type owned by the authenticated user on the specified shard.
     *
     * Endpoint: `POST /api/game/gen-unique-object-name`
     * @param type The type of object for which to generate the name (ex: "flag" or "spawn")
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game
     */
    gameGenUniqueObjectName(type: string, shard?: string): Promise<Http.GameGenUniqueNameResponse>;
    /**
     * Check whether or not a name for a room object is in use by any
     * other room object of the same type on the specified shard.
     *
     * Endpoint: `POST /api/game/check-unique-object-name`
     * @param type The type of object being named. `'spawn'` is the only known valid argument for this param.
     *  `'flag'` and `'creep'` will cause an error.
     * @param name The name to check
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server.
     * @throws {@link ScreepsApiError} if the object name is already in use.
     * @category Endpoints: /game
     */
    gameCheckUniqueObjectName(type: string, name: string, shard?: string): Promise<Http.ScreepsResponse>;
    /**
     * Place the authenticated user's first {@link StructureSpawn | spawn} structure.
     *
     * This operation is only permitted when the user's
     * {@link Http.UserWorldStatusResponse.status | world status}
     * is equal to `'empty'`.
     *
     * Endpoint: `POST /api/game/place-spawn`
     * @param room Name of the room in which the spawn should be placed
     * @param x X-coordinate of the spawn's room position
     * @param y Y-coordinate of the spawn's room position
     * @param name An optional name to assign to the placed spawn
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game
     */
    gamePlaceSpawn(room: string, x: number, y: number, name?: string, shard?: string): Promise<Http.ScreepsUnknownResponse>;
    /**
     * Create a new flag or move an existing one with the specified name.
     *
     * Unlike the runtime API equivalent of this endpoint, room visibility
     * is not required here.
     *
     * Endpoint: `POST /api/game/create-flag`
     * @param room Name of the room in which the flag should be placed
     * @param x X-coordinate of the flag's room position
     * @param y Y-coordinate of the flag's room position
     * @param name The name of the flag. If the name is already in use, the
     *  current flag with this name will be moved to the specified position.
     * @param color The color of the left side of the flag
     * @param secondaryColor The color of the right side of the flag
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @returns A generic MongoDB upsert response:
     * - If the name is new, `result.upserted[0]._id` is the game id of the created flag
     * - If not, this moves the flag and the response does not contain the ID (but the ID doesn't change)
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game
     */
    gameCreateFlag(room: string, x: number, y: number, name: string, color?: FlagColor, secondaryColor?: FlagColor, shard?: string): Promise<Http.ScreepsDbUpsertResponse>;
    /**
     * Generate a name for a new flag.
     *
     * The generated name will be unique across all other flags
     * owned by the authenticated user on the specified shard.
     *
     * Endpoint: `POST /api/game/gen-unique-flag-name`
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game
     */
    gameGenUniqueFlagName(shard?: string): Promise<Http.GameGenUniqueNameResponse>;
    /**
     * Check whether or not a flag name is in use.
     *
     * Checks all existing flags owned by the authenticated user on
     * the specified shard for one with the specified name.
     *
     * Endpoint: `POST /api/game/check-unique-flag-name`
     * @param name The name to check
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server.
     *  Also throws an error if the flag name is already in use.
     * @category Endpoints: /game
     */
    gameCheckUniqueFlagName(name: string, shard?: string): Promise<Http.ScreepsResponse>;
    /**
     * Change the color of an existing flag.
     *
     * Endpoint: `POST /api/game/change-flag-color`
     * @param name The name of the flag to update
     * @param color The color of the left side of the flag
     * @param secondaryColor The color of the right side of the flag
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game
     */
    gameChangeFlagColor(name: string, color?: FlagColor, secondaryColor?: FlagColor, shard?: string): Promise<Http.ScreepsDbUpdateResponse>;
    /**
     * Delete a flag by name.
     *
     * Endpoint: `POST /api/game/remove-flag`
     * @param room The name of the room in which the flag is placed
     * @param name The name of the flag to remove
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game
     */
    gameRemoveFlag(room: string, name: string, shard?: string): Promise<Http.ScreepsDbUpdateResponse>;
    /**
     * Trigger an action on one or more objects.
     *
     * This endpoint is used for a variety of actions, depending on the `name` and `intent` parameters.
     *
     * Endpoint: `POST /api/game/add-object-intent`
     * @param _id the ID of the object that should perform the intent
     * @param room the name of the room the object is in
     * @param name name of the intent (ex: 'move')
     * @param intent JSON string describing the target(s) of the intent (for actions like 'heal' or 'build')
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @example
     * // Remove flag:
     * // name = "remove", intent = {}
     * @example
     * // Destroy structure (can destroy multiple structures at once):
     * declare user: string // current user's ID
     * const room = 'W1N1'
     * const structureIds = ['6a30501195516b79c5e846da'] // IDs of structures to destroy
     * api.gameAddObjectIntent('room', room, 'destroyStructure', structureIds.map((id) => {
     *   return { id, roomName: room, user }
     * }))
     * @example
     * // Suicide creep:
     * const id = '6a30501195516b79c5e846da' // ID of creep to suicide
     * api.gameAddObjectIntent(id, 'W1N1', 'suicide', {})
     * // Intent can be an empty object, but the web client sends:
     * // `{ id }`
     * @example
     * // Unclaim controller:
     * const id = '6a30501195516b79c5e846da' // ID of room controller to unclaim
     * api.gameAddObjectIntent('room', 'W1N1', 'unclaim', {})
     * // Intent can be an empty object, but the web client sends:
     * // `{ id }`
     * @example
     * // Remove construction site:
     * const room = 'W1N1' // name of the room containing the contruction site
     * api.gameAddObjectIntent('room', room, 'removeConstructionSite', { id: '6a30501195516b79c5e846da', roomName: room })
     * @category Endpoints: /game
     */
    gameAddObjectIntent(_id: string, room: string, name: string, intent?: string, shard?: string): Promise<Http.ScreepsDbUpsertResponse>;
    /**
     * Create a {@link ConstructionSite | construction site} for a new
     * {@link Structure | structure}.
     *
     * Unlike the runtime API equivalent of this endpoint, room visibility
     * is not required here.
     *
     * Endpoint: `POST /api/game/create-construction`
     * @param room Name of the room in which to place the site
     * @param x X-coordinate of the site's room position
     * @param y Y-coordinate of the site's room position
     * @param structureType The type of structure to build (ex: 'road', 'powerSpawn')
     * @param name An optional name to assign to the placed structure.
     *  This should be undefined unless `structureType` is 'spawn'.
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game
     */
    gameCreateConstruction(room: string, x: number, y: number, structureType: BuildableStructureType, name?: string, shard?: string): Promise<Http.GameCreateConstructionResponse>;
    /**
     * Enable or disable attack notifications on a single {@link RoomObject | room object}.
     *
     * Endpoint: `POST /api/game/set-notify-when-attacked`
     * @param _id ID of the room object
     * @param enabled `true` to enable notifications, or `false` to disable notifications
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game
     */
    gameSetNotifyWhenAttacked(_id: string, enabled?: boolean, shard?: string): Promise<Http.ScreepsDbUpdateResponse>;
    /**
     * Create an invader creep in a room claimed by the authenticated user.
     *
     * Create a single invader to test the defenses of one of your rooms.
     * This can be called multiple times in succession to simulate a raid group.
     *
     * Invaders created by this endpoint will not drop any resources on death.
     * They can be removed by {@link gameRemoveInvader}.
     *
     * This operation is only permitted on exit positions of rooms claimed
     * by the authenticated user.
     *
     * Endpoint: `POST /api/game/create-invader`
     * @param room Name of the room in which to spawn
     * @param x X-coordinate of the invader's room position
     * @param y Y-coordinate of the invader's room position
     * @param size The body size of the invader. In real invasions, the small size
     *  spawns in unclaimed and low-RCL rooms, while the large size spawns in
     *  high-RCL rooms.
     * @param type The role of the invader, which will determine its body
     *  part types, boost types, and behavior.
     * @param boosted If `true`, the invader will be spawned with boosted parts.
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game
     */
    gameCreateInvader(room: string, x: number, y: number, size: 'small' | 'big', type: 'Melee' | 'Ranged' | 'Healer', boosted?: boolean, shard?: string): Promise<Http.ScreepsUnknownResponse>;
    /**
     * Remove an invader creep created by {@link gameCreateInvader}.
     *
     * This operation is only permitted on invaders created by
     * the authenticated user via the {@link gameCreateInvader} endpoint.
     *
     * Endpoint: `POST /api/game/remove-invader`
     * @param _id The ID of the invader creep to remove
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game
     */
    gameRemoveInvader(_id: string, shard?: string): Promise<Http.ScreepsUnknownResponse>;
    /**
     * Fetch the current game time
     *
     * Endpoint: `GET /api/game/time`
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game
     */
    gameTime(shard?: string): Promise<Http.GameTimeResponse>;
    /**
     * Fetch the width and height (in rooms) of the specified shard's world map.
     *
     * Endpoint: `GET /api/game/world-size`
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game
     */
    gameWorldSize(shard?: string): Promise<Http.GameWorldSizeResponse>;
    /**
     * Fetch all active {@link DecorationInstance | decorations} for a specific room.
     *
     * Endpoint: `GET /api/game/room-decorations`
     * @param room The name of the room
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game
     */
    gameRoomDecorations(room: string, shard?: string): Promise<Http.GameRoomDecorationsResponse>;
    /**
     * Fetch all {@link RoomObject | room objects} present in a specific room.
     *
     * Endpoint: `GET /api/game/room-objects`
     * @param room The name of the room
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game
     */
    gameRoomObjects(room: string, shard?: string): Promise<Http.GameRoomObjectsResponse>;
    /**
     * Fetch terrain data for a specific room and return it in an "encoded" format.
     *
     * Endpoint: `GET /api/game/room-terrain`
     * @param room The name of the room
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @see {@link gameRoomTerrainUnencoded} for an alternative response format
     * @category Endpoints: /game
     */
    gameRoomTerrain(room: string, shard?: string): Promise<Http.GameRoomTerrainEncodedResponse>;
    /**
     * Fetch terrain data for a specific room and return it in an "unencoded" format.
     *
     * **Warning:** In rare circumstances (unofficial servers that are using maps
     * generated via the map.generateRoom CLI command), this endpoint will return
     * encoded terrain data instead of unencoded data.
     *
     * Endpoint: `GET /api/game/room-terrain`
     * @param room The name of the room
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @see {@link gameRoomTerrain} for an alternative response format
     * @category Endpoints: /game
     */
    gameRoomTerrainUnencoded(room: string, shard?: string): Promise<Http.GameRoomTerrainUnencodedResponse>;
    /**
     * Look up the {@link RoomStatus | status of a room}.
     *
     * Endpoint: `GET /api/game/room-status`
     * @param room The name of the room
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game
     */
    gameRoomStatus(room: string, shard?: string): Promise<Http.GameRoomStatusResponse>;
    /**
     * Get the authenticated user's stats for a room broken down by time.
     *
     * Endpoint: `GET /api/game/room-overview`
     * @param room The name of the room
     * @param interval Size of each time slot in minutes; only specific values are allowed:
     * - 8: 8 minutes each; 64 minutes total
     * - 180: 3 hours each; 24 hours total
     * - 1440: 24 hours each; 8 days total
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game
     */
    gameRoomOverview(room: string, interval?: RoomStatInterval, shard?: string): Promise<Http.GameRoomOverviewResponse>;
    /**
     * Get an overview of market data for a shard.
     *
     * Intershard market data is always included, if available.
     *
     * Endpoint: `GET /api/game/market/orders-index`
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game/market
     */
    gameMarketOrdersIndex(shard?: string): Promise<Http.GameMarketIndexResponse>;
    /**
     * Fetch all unexpired market orders created by the authenticated user.
     *
     * Endpoint: `GET /api/game/market/my-orders`
     * @category Endpoints: /game/market
     */
    gameMarketMyOrders(): Promise<Http.GameMarketMyOrdersResponse>;
    /**
     * Fetch all active market orders for a given resource type.
     *
     * Endpoint: `GET /api/game/market/orders`
     * @param resourceType Any {@link MarketResource | resource type}
     * @param shard If `resourceType` is an {@link IntershardResource}, this must be set to `undefined`.
     *  {@link ScreepsClientConfig.defaultShard} is ignored here for compatibility with intershard resources.
     * @category Endpoints: /game/market
     */
    gameMarketOrders(resourceType: MarketResource, shard?: string): Promise<Http.GameMarketOrdersResponse>;
    /**
     * Fetch market history data for a given resource type.
     *
     * Endpoint: `GET /api/game/market/stats`
     * @param resourceType Any {@link MarketResource | resource type}
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /game/market
     */
    gameMarketStats(resourceType: MarketResource, shard?: string): Promise<Http.GameMarketStatsResponse>;
    /**
     * Fetch high-level data about all available shards on this server.
     *
     * This endpoint does not require authentication.
     *
     * Endpoint: `GET /api/game/shards/info`
     * @category Endpoints: /game/shards
     */
    gameShardsInfo(): Promise<Http.GameShardsInfoResponse>;
    /**
     * Fetch the leaderboard rankings for a list of users.
     *
     * This endpoint does not require authentication.
     *
     * Endpoint: `GET /api/leaderboard/list`
     * @param limit The number of user results to include per response
     * @param mode 'world' (control points) or 'power' (power processed)
     * @param offset The index (starting at zero) of the first leaderboard
     *  position that should be included in the response
     * @param season A date in the format `YYYY-MM`, NOT a Seasonal World name/number.
     *  Defaults to the current season.
     * @category Endpoints: /leaderboard
     */
    leaderboardList(limit?: number, mode?: Http.LeaderboardMode, offset?: number | null, season?: string): Promise<Http.LeaderboardListResponse>;
    /**
     * Fetch the leaderboard rankings for a specific user.
     *
     * This endpoint does not require authentication.
     *
     * Endpoint: `GET /api/leaderboard/find`
     * @param username The name of the user
     * @param mode 'world' (control points) or 'power' (power processed)
     * @param season An optional date in the format YYYY-MM.
     *  If undefined, the user's ranks for all seasons are returned.
     * @category Endpoints: /leaderboard
     */
    leaderboardFind(username: string, mode?: Http.LeaderboardMode, season?: string): Promise<Http.LeaderboardFindResponse>;
    /**
     * Fetch a list of all seasons for which leaderboard rankings exist.
     * Note that the "seasons" mentioned here are distinct from the official
     * {@link https://screeps.com/season/#!/seasons/chronicle | Seasonal World}
     * competitions.
     *
     * This endpoint does not require authentication.
     *
     * Endpoint: `GET /api/leaderboard/seasons`
     * @category Endpoints: /leaderboard
     */
    leaderboardSeasons(): Promise<Http.LeaderboardSeasonsResponse>;
    /**
     * Fetch metadata for the current season. Only works on official servers
     * when a Seasonal World competition is active or about to start.
     *
     * Endpoint: `GET /api/seasons/current`
     * @throws {@link ScreepsApiError} HTTP 404 if called on an unofficial server
     * @returns Metadata on the current season, or null if a Seasonal World
     *  competition is not active or about to start
     * @category Endpoints: /seasons
     */
    seasonsCurrent(): Promise<Http.SeasonsCurrentResponse | null>;
    /**
     * Unlock CPU on PTR for one week.
     *
     * Endpoint: `POST /api/user/activate-ptr`
     * @returns an {@link Http.ScreepsResponse} on PTR, or an {@link Http.ScreepsErrorResponse}
     *  (`{ error: 'not ptr' }`) on official servers that are not PTR.
     * @throws {@link ScreepsApiError} HTTP 404 on unofficial servers
     * @category Endpoints: /user
     */
    userActivatePtr(): Promise<Http.ScreepsResponse | Http.ScreepsErrorResponse>;
    /**
     * Update the authenticated user's {@link UserBadge | badge}.
     *
     * Endpoint: `POST /api/user/badge`
     * @param badge The user's new badge. See {@link UserBadge}
     * @category Endpoints: /user
     */
    userBadge(badge: UserBadge): Promise<Http.ScreepsDbUpdateResponse>;
    /**
     * Update the authenticated user's shard CPU limits.
     *
     * Endpoint: `POST /api/user/cpu-shards`
     * @param cpu The user's new shard CPU limits. See {@link CpuShardLimits}
     * @category Endpoints: /user
     */
    userCpuShards(cpu: CpuShardLimits): Promise<Http.ScreepsDbUpdateResponse>;
    /**
     * Abandon all of the authenticated user's rooms to allow them
     * to pick a new spawn room.
     *
     * Endpoint: `POST /api/user/respawn`
     * @category Endpoints: /user
     */
    userRespawn(): Promise<Http.ScreepsUnknownResponse>;
    /**
     * Update the code branch that will be used by the server or the simulator.
     *
     * Endpoint: `POST /api/user/set-active-branch`
     * @param branch The name of the code branch to activate
     * @param activeName The environment for which this code branch should be activated:
     *  - 'activeWorld': activate branch on the server
     *  - 'activeSim': activate branch on the simulator
     * @see {@link userBranches} to list available branches
     * @category Endpoints: /user
     */
    userSetActiveBranch(branch: string, activeName: 'activeWorld' | 'activeSim'): Promise<Http.ScreepsUnknownResponse>;
    /**
     * Create a copy of a code branch.
     *
     * Endpoint: `POST /api/user/clone-branch`
     * @param branch The name of the code branch to clone
     * @param newName The name of the new code branch
     * @param defaultModules Do you know what this does? If so, please submit a PR!
     * @see {@link userBranches} to list available branches
     * @category Endpoints: /user
     */
    userCloneBranch(branch: string, newName: string, defaultModules: unknown): Promise<Http.ScreepsUnknownResponse>;
    /**
     * Delete a code branch.
     *
     * Endpoint: `POST /api/user/delete-branch`
     * @param branch The name of the code branch to delete
     * @category Endpoints: /user
     */
    userDeleteBranch(branch: string): Promise<Http.ScreepsUnknownResponse>;
    /**
     * Update the authenticated user's notification preferences.
     *
     * Endpoint: `POST /api/user/notify-prefs`
     * @param prefs See {@link Http.UserNotifyPrefsRequest}
     * @category Endpoints: /user
     */
    userNotifyPrefs(prefs: Http.UserNotifyPrefsRequest): Promise<Http.ScreepsDbUpdateResponse>;
    /**
     * Mark tutorial as completed for the authenticated user.
     *
     * Endpoint: `POST /api/user/tutorial-done`
     * @category Endpoints: /user
     */
    userTutorialDone(): Promise<Http.ScreepsResponse>;
    /**
     * Update the authenticated user's email address.
     *
     * Endpoint: `POST /api/user/email`
     * @param email The user's new email address
     * @category Endpoints: /user
     */
    userEmail(email: string): Promise<Http.ScreepsUnknownResponse>;
    /**
     * Get the name of a room that should be centered on the
     * authenticated user's map when opening the map view on the client
     * with no coordinates.
     *
     * Endpoint: `GET /api/user/world-start-room`
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @category Endpoints: /user
     */
    userWorldStartRoom(shard?: string): Promise<Http.UserWorldStartRoomResponse>;
    /**
     * Get the authenticated user's status on the server.
     *
     * Endpoint: `GET /api/user/world-status`
     * @category Endpoints: /user
     */
    userWorldStatus(): Promise<Http.UserWorldStatusResponse>;
    /**
     * Fetch a list of all code branches the authenticated user has
     * on the server.
     *
     * Endpoint: `GET /api/user/branches`
     * @category Endpoints: /user
     */
    userBranches(): Promise<Http.UserBranchesResponse>;
    /**
     * Pull the authenticated user's code and WASM binaries for a
     * specific branch.
     *
     * Endpoint: `GET /api/user/code`
     * @param branch the name of the branch from which to pull code
     * @see https://docs.screeps.com/commit.html
     * @see {@link userBranches} to list available branches
     * @category Endpoints: /user/code
     */
    userCodeGet(branch: string): Promise<Http.UserCodeGetResponse>;
    /**
     * Push code and WASM binaries to a branch for the authenticated user.
     *
     * Endpoint: `POST /api/user/code`
     * @param params the code/binaries and target branch
     * @param params.branch the name of the branch for which to upload code
     * @param params.modules JavScript code and WASM binaries to upload keyed by module name
     * @see https://docs.screeps.com/commit.html
     * @category Endpoints: /user/code
     */
    userCodeSet(params: Http.UserCodeSetRequest): Promise<Http.ScreepsUnknownResponse>;
    /**
     * Fetch all of the authenticated user's {@link DecorationInstance | decorations}.
     *
     * Endpoint: `GET /api/user/decorations/inventory`
     * @category Endpoints: /user/decorations
     */
    userDecorationsInventory(): Promise<Http.UserDecorationInventoryResponse>;
    /**
     * Fetch all themes under which the user's {@link DecorationInstance | decorations}
     * can be grouped.
     *
     * Endpoint: `GET /api/user/decorations/themes`
     * @category Endpoints: /user/decorations
     */
    userDecorationsThemes(): Promise<Http.UserDecorationThemesResponse>;
    /**
     * Destroy one or more owned {@link DecorationInstance | decorations}
     * to refund a fraction of their pixelization cost.
     *
     * Endpoint: `POST /api/user/decorations/convert`
     * @param decorations The IDs of one or more owned decorations
     * @category Endpoints: /user/decorations
     */
    userDecorationsConvert(decorations: string[]): Promise<Http.ScreepsUnknownResponse>;
    /**
     * Spend pixels to create one or more
     * {@link DecorationInstance | decorations}.
     *
     * Endpoint: `POST /api/user/decorations/pixelize`
     * @param count The number of decorations to generate.
     * @param theme The theme from which to generate decorations.
     *  Note that specifying a theme increases the pixelization cost.
     *  Set to an empty string to create decorations from any theme.
     * @category Endpoints: /user/decorations
     */
    userDecorationsPixelize(count: number, theme?: string): Promise<Http.ScreepsUnknownResponse>;
    /**
     * Apply / activate a {@link DecorationInstance | decoration} to a creep/object/room.
     *
     * Endpoint: `POST /api/user/decorations/activate`
     * @param _id the ID of the decoration to activate
     * @param active values to assign to configurable {@link Decoration.props | properties}
     * @category Endpoints: /user/decorations
     */
    userDecorationsActivate(_id: string, active: object): Promise<Http.ScreepsUnknownResponse>;
    /**
     * Remove / deactivate one or more active {@link DecorationInstance | decorations}.
     *
     * Endpoint: `POST /api/user/decorations/deactivate`
     * @param decorations The IDs of one or more active decorations
     * @category Endpoints: /user/decorations
     */
    userDecorationsDeactivate(decorations: string[]): Promise<Http.ScreepsUnknownResponse>;
    /**
     * Look up the name of the room in which this player may not respawn.
     *
     * Endpoint: `GET /api/user/respawn-prohibited-rooms`
     * @category Endpoints: /user
     */
    userRespawnProhibitedRooms(): Promise<Http.UserRespawnProhibitedRoomsResponse>;
    /**
     * Retrieves part or all of the authenticated user's
     * {@link https://docs.screeps.com/global-objects.html#Memory-object | Memory}.
     *
     * Endpoint: `GET /api/user/memory`
     * @param path The portion of the Memory JSON object to retrieve (ex: 'flags.Flag1').
     *  If undefined/empty, returns the entire Memory object.
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /user/memory
     */
    userMemoryGet(path?: string, shard?: string): Promise<Http.UserMemoryGetResponse>;
    /**
     * Updates part or all of the authenticated user's
     * {@link https://docs.screeps.com/global-objects.html#Memory-object | Memory}.
     *
     * Endpoint: `POST /api/user/memory`
     * @param path The portion of the Memory JSON object to write (ex: 'flags.Flag1').
     *  **WARNING: If undefined/empty, overwrites the entire Memory object.**
     * @param value The value to write to the specified Memory path. This will
     *  completely replace the previous value.
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /user/memory
     */
    userMemorySet(path: string | undefined, value: unknown, shard?: string): Promise<Http.UserMemorySetResponse>;
    /**
     * Fetch the contents of one or more
     * {@link https://docs.screeps.com/api/#RawMemory.segments | RawMemory.segments}.
     *
     * Endpoint: `GET /api/user/memory-segment`
     * @param segment One or more segment IDs to read. Multiple IDs can be
     *  specified in a single string by separating the IDs with commas.
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @example
     * // Fetch a single segment
     * api.user.memory.segment.get(7, 'shard3')
     * @example
     * // Fetch a multiple segments with an ID array
     * api.user.memory.segment.get([7, '13'], 'shard3')
     * @example
     * // Fetch a multiple segments with a comma-delimited ID list
     * api.user.memory.segment.get('7,13,30', 'shard3')
     * @category Endpoints: /user/memory/segment
     */
    userMemorySegmentGet(segment: number | string | (number | string)[], shard?: string): Promise<Http.UserMemorySegmentGetResponse>;
    /**
     * Update the contents of a single
     * {@link https://docs.screeps.com/api/#RawMemory.segments | RawMemory.segments}.
     *
     * Endpoint: `POST /api/user/memory-segment`
     * @param segment A number from 0-99
     * @param data The data to write to the segment. Non-string values will be
     *  serialized on the server side.
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /user/memory/segment
     */
    userMemorySegmentSet(segment: number | string, data: unknown, shard?: string): Promise<Http.ScreepsResponse>;
    /**
     * Search for messages by user ID.
     *
     * Endpoint: `GET /api/user/messages/list`
     * @param respondent The long `_id` of the user, not the username
     * @category Endpoints: /user/messages
     */
    userMessagesList(respondent: string): Promise<Http.UserMessagesListResponse>;
    /**
     * Fetch the last message from every thread in the authenticated user's inbox.
     *
     * Endpoint: `GET /api/user/messages/index`
     * @category Endpoints: /user/messages
     */
    userMessagesIndex(): Promise<Http.UserMessagesIndexResponse>;
    /**
     * Fetch the authenticated user's number of unread messages.
     *
     * Endpoint: `GET /api/user/messages/unread-count`
     * @category Endpoints: /user/messages
     */
    userMessagesUnreadCount(): Promise<Http.UserMessagesUnreadCountResponse>;
    /**
     * Send a message on behalf of the authenticated user.
     *
     * Endpoint: `POST /api/user/messages/send`
     * @param respondent The long `_id` of the user, not the username
     * @param text The text of the message to send
     * @category Endpoints: /user/messages
     */
    userMessagesSend(respondent: string, text: string): Promise<Http.ScreepsUnknownResponse>;
    /**
     * Mark the authenticated user's copy of a message as read.
     *
     * Endpoint: `POST /api/user/messages/mark-read`
     * @param id The ID of the message to mark as read
     * @category Endpoints: /user/messages
     */
    userMessagesMarkRead(id: string): Promise<Http.UserMessagesMarkReadResponse>;
    /**
     * Find a user by name.
     *
     * Endpoint: `GET /api/user/find`
     * @param username The complete username of the user
     * @see {@link userFindById} to find a user by ID instead of username
     * @category Endpoints: /user
     */
    userFind(username: string): Promise<Http.UserFindResponse>;
    /**
     * Find a user by ID.
     *
     * Endpoint: `GET /api/user/find`
     * @param id The ID of the user
     * @see {@link userFind} to find a user by username instead of ID
     * @category Endpoints: /user
     */
    userFindById(id: string): Promise<Http.UserFindResponse>;
    /**
     * Look up stats for a user.
     *
     * Endpoint: `GET /api/user/stats`
     * @param id ID of the user
     * @param interval The time interval in minutes (divided by 8); only specific values are allowed:
     * - 8: Past hour (actually 64 minutes)
     * - 180: Past day
     * - 1440: Past week (actually 8 days)
     * @see {@link userOverview} for more detailed stats for the authenticated user
     * @category Endpoints: /user
     */
    userStats(id: string, interval: RoomStatInterval): Promise<Http.UserStatsResponse>;
    /**
     * Find all rooms claimed by the specified user.
     *
     * Endpoint: `GET /api/user/rooms`
     * @param id The ID of the user
     * @category Endpoints: /user
     */
    userRooms(id: string): Promise<Http.UserRoomsResponse>;
    /**
     * Get an overview of the authenticated user's stats broken down by room and time.
     *
     * Endpoint: `GET /api/user/overview`
     * @param interval Size of each time slot in minutes; only specific values are allowed:
     * - 8: 8 minutes each; 64 minutes total
     * - 180: 3 hours each; 24 hours total
     * - 1440: 24 hours each; 8 days total
     * @param statName The stat to view for this user
     * @category Endpoints: /user
     */
    userOverview(interval?: RoomStatInterval, statName?: RoomStat): Promise<Http.UserOverviewResponse>;
    /**
     * Fetch a list of the authenticated user's most recent market transactions.
     *
     * Endpoint: `GET /api/user/money-history`
     * @param page Used for pagination
     * @category Endpoints: /user
     */
    userMoneyHistory(page?: number): Promise<Http.UserMoneyHistoryResponse>;
    /**
     * Evaluate a JavaScript expression in the context of the authenticated
     * user's bot's runtime environment.
     *
     * This expression is evaluated after the user's loop function runs.
     * CPU costs and limits apply as they would to code in the loop function.
     *
     * Endpoint: `POST /api/user/console`
     * @param expression The JavaScript expression to evaluate.
     * @param shard The name of the shard to use (ignored by unofficial servers).
     *  Defaults to {@link ScreepsClientConfig.defaultShard} if undefined.
     * @throws {@link node!Error | Error} if shard and {@link ScreepsClientConfig.defaultShard} are undefined
     *  while using an official server
     * @category Endpoints: /user
     */
    userConsole(expression: string, shard?: string): Promise<Http.UserConsoleResponse>;
    /**
     * Fetch the authenticated user's username.
     *
     * Endpoint: `GET /api/user/name`
     * @category Endpoints: /user
     */
    userName(): Promise<Http.UserNameResponse>;
    /**
     * Find rooms where attack actions have recently occurred
     * (including combat actions against NPCs).
     *
     * Endpoint: `GET /api/experimental/pvp`
     * @param interval Minimum time (in ticks?) since last combat action
     * @category Endpoints: /experimental
     */
    experimentalPvp(interval?: number): Promise<Http.ExperimentalPvpResponse>;
    /**
     * Find all active nuclear launches.
     *
     * Endpoint: `GET /api/experimental/nukes`
     * @category Endpoints: /experimental
     */
    experimentalNukes(): Promise<Http.ExperimentalNukesResponse>;
    /**
     * Find active/recent battles by room and classified by conflict intensity.
     *
     * This endpoint is unavailable on official servers, but the same data
     * is available via {@link https://voight-kampff.fly.dev/ | Voight-Kampff}.
     *
     * Endpoint: `GET /api/warpath/battles`
     * @param interval Minimum time (in ticks?) since last observed PVP activity
     * @see {@link https://screepspl.us/warpath/classifications/ | Warpath Conflict Classifications} for
     *  the criteria used to assign conflict levels
     * @category Endpoints: /warpath
     */
    warpathBattles(interval?: number): Promise<Http.ScreepsUnknownResponse>;
    /**
     * Query scoreboard results. This appears to only be relevant to
     * {@link https://screeps.com/season/#!/seasons/chronicle | Seasonal World}
     * competitions/events.
     *
     * Endpoint: `GET /api/scoreboard/list`
     * @param offset The index (starting at zero) of the first leaderboard
     *  position that should be included in the response
     * @param limit The number of users to return per request.
     *  The maximum valid value is 20.
     * @category Endpoints: /scoreboard
     */
    scoreboardList(offset?: number, limit?: number): Promise<Http.ScoreboardListResponse>;
    /**
     * Get the current leaderboard season (not the current Seasonal World season)
     * @see the `Endpoints: /leaderboard` category
     */
    get currentLeaderboardSeason(): string;
    /**
     * True if this client is configured for the official MMO, PTR,
     * or Seasonal World servers
     */
    get isOfficialServer(): boolean;
    /** True if this client is configured for the Seasonal World server */
    get isSeasonServer(): boolean;
    /** True if this client is configured for the Public Test Realm (PTR) server */
    get isPtrServer(): boolean;
    protected mapToShard<R extends Response>(this: void, res: R & {
        shards?: unknown;
        list?: unknown;
        rooms?: unknown;
    }): R;
    /**
     * Switch to a different server.
     *
     * If the new server is using email/password auth, the client will attempt
     * to authenticate automatically.
     *
     * This will also call {@link ScreepsSocketClient.disconnect}.
     * @param rawServer The config for the new server the client should use.
     *  This will be normalized by {@link ScreepsConfigManager} before
     *  being stored in {@link server}.
     * @throws {@link ScreepsApiError} if authentication fails
     */
    setServer(rawServer: ScreepsRawServerConfig): Promise<void>;
    /**
     * Authenticate to the server using the email and password from the provided
     * {@link ScreepsServerConfig}.
     *
     * Typically, this should not be called directly; it will be triggered
     * automatically when a request is made to an endpoint that requires
     * authentication.
     * @param cause if provided, will be attached to the error thrown when
     *  authentication credentials are missing
     * @throws {@link ScreepsApiError} if authentication fails
     */
    auth(cause?: unknown): Promise<Http.AuthSigninResponse | undefined>;
    /**
     * Send an API request to the server.
     *
     * Unless you are retrying a request using a {@link ScreepsHttpRequest}
     * instance, this should not be called directly. Instead, use the appropriate
     * endpoint method to apply the correct request parameter and response body types.
     *
     * If an endpoint you use does not have an associated method,
     * please consider submitting a PR to implement it.
     * @param method The HTTP method to use
     * @param path The URL path of the endpoint. This will be appeneded to
     *  {@link ScreepsServerConfig.url}.
     * @param params The request parameters
     * @param retriesAttempted The number of retries already attempted due to
     *  HTTP 429 errors. This argument should not be provided by consumers.
     * @returns The parsed response body
     */
    req(method: ScreepsHttpMethod, path: string, params?: unknown, retriesAttempted?: number): Promise<any>;
    protected gz(data: string): Promise<unknown>;
    private updateRateLimit;
    /**
     * Enable or disable debug logging via the
     * {@link https://www.npmjs.com/package/debug | debug} package.
     * @param opts If undefined, disables debug logs for all namespaces.
     *  Otherwise, enables the specified namespaces and disables all others.
     * @see {@link DebugOptions}
     */
    debug(opts?: DebugOptions): void;
    /**
     * Generate an URL that can be opened in a browser to reset rate limits
     * for all endpoints.
     *
     * The generated URL is specific to the API token currently in use.
     * @throws {@link node!Error | Error} if no API token is available.
     */
    get rateLimitResetUrl(): string;
    /**
     * Fetch and memoize information about the authenticated user.
     * @returns If using an API token with full permissions, {@link Http.AuthMeResponse}.
     *  Otherwise the result is {@link Http.UserInfo}.
     */
    me(): Promise<Http.AuthMeResponse | Http.UserInfo>;
    /**
     * Fetch and memoize permissions and other information about the API token
     * currently being used by this client.
     */
    tokenInfo(): Promise<Http.AuthQueryTokenResult>;
}
/**
 * Thrown by {@link ScreepsHttpClient} endpoint methods when an HTTP 4xx/5xx
 * response is received from an endpoint.
 *
 * **Warning:** This object is likely to contain auth credentials;
 * logging it may leak them. See the docs for individual fields for more details.
 * @category HTTP API
 */
export declare class ScreepsApiError extends Error {
    /**
     * All params sent to {@link ScreepsHttpClient.req} for the request
     * that triggered this error. It can be used to retry a request.
     *
     * **Warning:** The `params` field is likely to contain auth credentials
     * when `path` starts with `auth/`.
     */
    req: ScreepsHttpRequest;
    /**
     * The response body (usually an HTML document
     * with an error message in the body).
     */
    data?: string;
    /**
     * Response headers
     *
     * **Warning:** This may contain an `X-Token` field with an API auth token.
     */
    headers: {
        [headerName: string]: unknown;
    };
    /** HTTP error status code */
    status: number;
    /** Human-readable HTTP error status */
    statusText: string;
    constructor(err: AxiosError, res: AxiosResponse, req: ScreepsHttpRequest);
}
//# sourceMappingURL=ScreepsHttpClient.d.ts.map