@lgriffin/esi.ts 10.0.0 → 10.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +158 -0
- package/README.md +14 -5
- package/dist/EsiClient.d.mts +140 -0
- package/dist/EsiClientBuilder.d.mts +75 -0
- package/dist/auth/EsiTokenManager.d.mts +200 -0
- package/dist/auth/EveSsoClient.d.mts +88 -0
- package/dist/auth/errors.d.mts +42 -0
- package/dist/auth/index.d.mts +14 -0
- package/dist/auth/jwt.d.mts +43 -0
- package/dist/auth/pkce.d.mts +21 -0
- package/dist/auth/storage/FileTokenStorage.d.mts +44 -0
- package/dist/auth/storage/MemoryTokenStorage.d.mts +18 -0
- package/dist/auth/types.d.mts +42 -0
- package/dist/{chunk-7A72QFDF.mjs → chunk-4W66ONJI.mjs} +4 -7
- package/dist/chunk-4W66ONJI.mjs.map +1 -0
- package/dist/{chunk-HPSACXX3.js → chunk-N3B65VLB.js} +4 -7
- package/dist/chunk-N3B65VLB.js.map +1 -0
- package/dist/clients/AccessListsClient.d.mts +25 -0
- package/dist/clients/AllianceClient.d.mts +59 -0
- package/dist/clients/AssetsClient.d.mts +65 -0
- package/dist/clients/BaseEsiClient.d.mts +19 -0
- package/dist/clients/CalendarClient.d.mts +48 -0
- package/dist/clients/CharacterClient.d.mts +134 -0
- package/dist/clients/ClonesClient.d.mts +27 -0
- package/dist/clients/ContactsClient.d.mts +96 -0
- package/dist/clients/ContractsClient.d.mts +91 -0
- package/dist/clients/CorporationProjectsClient.d.mts +54 -0
- package/dist/clients/CorporationsClient.d.mts +219 -0
- package/dist/clients/CosmeticsClient.d.mts +11 -0
- package/dist/clients/DogmaClient.d.mts +42 -0
- package/dist/clients/FactionClient.d.mts +60 -0
- package/dist/clients/FittingsClient.d.mts +38 -0
- package/dist/clients/FleetClient.d.mts +134 -0
- package/dist/clients/FreelanceJobsClient.d.mts +61 -0
- package/dist/clients/IncursionsClient.d.mts +14 -0
- package/dist/clients/IndustryClient.d.mts +86 -0
- package/dist/clients/InsuranceClient.d.mts +14 -0
- package/dist/clients/KillmailsClient.d.mts +37 -0
- package/dist/clients/LocationClient.d.mts +32 -0
- package/dist/clients/LoyaltyClient.d.mts +28 -0
- package/dist/clients/MailClient.d.mts +104 -0
- package/dist/clients/MarketClient.d.mts +102 -0
- package/dist/clients/MercenaryClient.d.mts +42 -0
- package/dist/clients/MetaClient.d.mts +45 -0
- package/dist/clients/MilitaryCampaignsClient.d.mts +53 -0
- package/dist/clients/ParagonHubClient.d.mts +13 -0
- package/dist/clients/PiClient.d.mts +45 -0
- package/dist/clients/RouteClient.d.mts +25 -0
- package/dist/clients/SearchClient.d.mts +17 -0
- package/dist/clients/SkillsClient.d.mts +39 -0
- package/dist/clients/SkyhooksClient.d.mts +48 -0
- package/dist/clients/SovereigntyClient.d.mts +20 -0
- package/dist/clients/StatusClient.d.mts +14 -0
- package/dist/clients/UiClient.d.mts +44 -0
- package/dist/clients/UniverseClient.d.mts +212 -0
- package/dist/clients/WalletClient.d.mts +70 -0
- package/dist/clients/WarsClient.d.mts +33 -0
- package/dist/core/ApiClient.d.mts +73 -0
- package/dist/core/ApiClientBuilder.d.mts +24 -0
- package/dist/core/ApiRequestHandler.d.ts.map +1 -1
- package/dist/core/BatchRequestHandler.d.mts +12 -0
- package/dist/core/ClientRegistry.d.mts +45 -0
- package/dist/core/EsiDiagnostics.d.mts +35 -0
- package/dist/core/IDeduplicator.d.mts +22 -0
- package/dist/core/IDeduplicator.d.ts +16 -0
- package/dist/core/IDeduplicator.d.ts.map +1 -1
- package/dist/core/IRetryStrategy.d.mts +5 -0
- package/dist/core/RequestDeduplicator.d.mts +21 -0
- package/dist/core/RequestDeduplicator.d.ts +11 -0
- package/dist/core/RequestDeduplicator.d.ts.map +1 -1
- package/dist/core/RetryStrategy.d.mts +21 -0
- package/dist/core/cache/ETagCacheManager.d.mts +75 -0
- package/dist/core/cache/ICache.d.mts +27 -0
- package/dist/core/cache/cacheKey.d.ts +11 -0
- package/dist/core/cache/cacheKey.d.ts.map +1 -1
- package/dist/core/circuitBreaker/CircuitBreaker.d.mts +52 -0
- package/dist/core/circuitBreaker/CircuitBreaker.d.ts.map +1 -1
- package/dist/core/circuitBreaker/ICircuitBreaker.d.mts +23 -0
- package/dist/core/configureApiClient.d.mts +18 -0
- package/dist/core/constants.d.ts +2 -2
- package/dist/core/endpoints/EndpointDefinition.d.mts +63 -0
- package/dist/core/endpoints/accessListEndpoints.d.mts +34 -0
- package/dist/core/endpoints/allianceEndpoints.d.mts +43 -0
- package/dist/core/endpoints/assetEndpoints.d.mts +76 -0
- package/dist/core/endpoints/buildEndpointPath.d.mts +7 -0
- package/dist/core/endpoints/calendarEndpoints.d.mts +54 -0
- package/dist/core/endpoints/characterEndpoints.d.mts +185 -0
- package/dist/core/endpoints/cloneEndpoints.d.mts +32 -0
- package/dist/core/endpoints/contactEndpoints.d.mts +106 -0
- package/dist/core/endpoints/contractEndpoints.d.mts +168 -0
- package/dist/core/endpoints/corporationEndpoints.d.mts +324 -0
- package/dist/core/endpoints/corporationProjectEndpoints.d.mts +102 -0
- package/dist/core/endpoints/cosmeticsEndpoints.d.mts +52 -0
- package/dist/core/endpoints/createClient.d.mts +69 -0
- package/dist/core/endpoints/dogmaEndpoints.d.mts +89 -0
- package/dist/core/endpoints/esi-cache-ttls.generated.d.ts.map +1 -1
- package/dist/core/endpoints/esi-rate-limit-groups.generated.d.mts +7 -0
- package/dist/core/endpoints/esi-rate-limit-groups.generated.d.ts.map +1 -1
- package/dist/core/endpoints/esi-scopes.generated.d.mts +3 -0
- package/dist/core/endpoints/esi-scopes.generated.d.ts.map +1 -1
- package/dist/core/endpoints/factionEndpoints.d.mts +194 -0
- package/dist/core/endpoints/fittingEndpoints.d.mts +34 -0
- package/dist/core/endpoints/fleetEndpoints.d.mts +137 -0
- package/dist/core/endpoints/freelanceJobsEndpoints.d.mts +181 -0
- package/dist/core/endpoints/incursionEndpoints.d.mts +19 -0
- package/dist/core/endpoints/industryEndpoints.d.mts +138 -0
- package/dist/core/endpoints/insuranceEndpoints.d.mts +17 -0
- package/dist/core/endpoints/killmailEndpoints.d.mts +62 -0
- package/dist/core/endpoints/locationEndpoints.d.mts +37 -0
- package/dist/core/endpoints/loyaltyEndpoints.d.mts +32 -0
- package/dist/core/endpoints/mailEndpoints.d.mts +111 -0
- package/dist/core/endpoints/marketEndpoints.d.mts +191 -0
- package/dist/core/endpoints/mercenaryEndpoints.d.mts +79 -0
- package/dist/core/endpoints/metaEndpoints.d.mts +50 -0
- package/dist/core/endpoints/militaryCampaignEndpoints.d.mts +87 -0
- package/dist/core/endpoints/paragonHubEndpoints.d.mts +163 -0
- package/dist/core/endpoints/piEndpoints.d.mts +101 -0
- package/dist/core/endpoints/routeEndpoints.d.mts +14 -0
- package/dist/core/endpoints/searchEndpoints.d.mts +26 -0
- package/dist/core/endpoints/skillEndpoints.d.mts +52 -0
- package/dist/core/endpoints/skyhookEndpoints.d.mts +111 -0
- package/dist/core/endpoints/sovereigntyEndpoints.d.mts +59 -0
- package/dist/core/endpoints/statusEndpoints.d.mts +14 -0
- package/dist/core/endpoints/uiEndpoints.d.mts +43 -0
- package/dist/core/endpoints/universeEndpoints.d.mts +456 -0
- package/dist/core/endpoints/walletEndpoints.d.mts +98 -0
- package/dist/core/endpoints/warEndpoints.d.mts +51 -0
- package/dist/core/logger/DefaultLogger.d.mts +31 -0
- package/dist/core/logger/ILogger.d.mts +17 -0
- package/dist/core/logger/NoopLogger.d.mts +7 -0
- package/dist/core/logger/loggerUtil.d.mts +11 -0
- package/dist/core/logger/resolveLogger.d.ts +3 -3
- package/dist/core/logger/resolveLogger.d.ts.map +1 -1
- package/dist/core/middleware/Middleware.d.mts +30 -0
- package/dist/core/pagination/AsyncPaginationIterator.d.mts +12 -0
- package/dist/core/pagination/AsyncPaginationIterator.d.ts.map +1 -1
- package/dist/core/pagination/CursorPaginationHandler.d.mts +68 -0
- package/dist/core/pagination/CursorPaginationHandler.d.ts.map +1 -1
- package/dist/core/rateLimiter/IRateLimiter.d.mts +27 -0
- package/dist/core/rateLimiter/RateLimiter.d.mts +62 -0
- package/dist/core/rateLimiter/RateLimiter.d.ts.map +1 -1
- package/dist/core/requestPipeline/cachePolicy.d.ts +11 -1
- package/dist/core/requestPipeline/cachePolicy.d.ts.map +1 -1
- package/dist/core/requestPipeline/fetchExecution.d.ts.map +1 -1
- package/dist/core/requestPipeline/index.d.ts +1 -1
- package/dist/core/requestPipeline/index.d.ts.map +1 -1
- package/dist/core/requestPipeline/paginationOrchestration.d.ts +1 -1
- package/dist/core/requestPipeline/paginationOrchestration.d.ts.map +1 -1
- package/dist/core/requestPipeline/statusHandling.d.ts +6 -0
- package/dist/core/requestPipeline/statusHandling.d.ts.map +1 -1
- package/dist/core/util/concurrency.d.ts.map +1 -1
- package/dist/core/util/error.d.mts +37 -0
- package/dist/core/util/retry.d.mts +8 -0
- package/dist/core/util/retry.d.ts.map +1 -1
- package/dist/errors.d.mts +5 -0
- package/dist/errors.js +2 -2
- package/dist/errors.mjs +1 -1
- package/dist/index.d.mts +81 -0
- package/dist/index.js +374 -197
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +267 -90
- package/dist/index.mjs.map +1 -1
- package/dist/schemas/access-lists.d.mts +16 -0
- package/dist/schemas/alliance.d.mts +26 -0
- package/dist/schemas/assets.d.mts +24 -0
- package/dist/schemas/calendar.d.mts +27 -0
- package/dist/schemas/character.d.mts +109 -0
- package/dist/schemas/clones.d.mts +17 -0
- package/dist/schemas/common.d.mts +74 -0
- package/dist/schemas/contacts.d.mts +14 -0
- package/dist/schemas/contracts.d.mts +104 -0
- package/dist/schemas/corporation-projects.d.mts +104 -0
- package/dist/schemas/corporation.d.mts +193 -0
- package/dist/schemas/cosmetics.d.mts +58 -0
- package/dist/schemas/dogma.d.mts +57 -0
- package/dist/schemas/esiEnum.d.mts +3 -0
- package/dist/schemas/faction-warfare.d.mts +203 -0
- package/dist/schemas/fittings.d.mts +13 -0
- package/dist/schemas/fleet.d.mts +37 -0
- package/dist/schemas/freelance-jobs.d.mts +171 -0
- package/dist/schemas/incursions.d.mts +12 -0
- package/dist/schemas/index.d.mts +39 -0
- package/dist/schemas/industry.d.mts +99 -0
- package/dist/schemas/insurance.d.mts +10 -0
- package/dist/schemas/killmails.d.mts +38 -0
- package/dist/schemas/location.d.mts +18 -0
- package/dist/schemas/loyalty.d.mts +18 -0
- package/dist/schemas/mail.d.mts +53 -0
- package/dist/schemas/market.d.mts +123 -0
- package/dist/schemas/mercenary.d.mts +74 -0
- package/dist/schemas/meta.d.mts +36 -0
- package/dist/schemas/military-campaigns.d.mts +26 -0
- package/dist/schemas/paragon-hub.d.mts +96 -0
- package/dist/schemas/pi.d.mts +71 -0
- package/dist/schemas/skills.d.mts +28 -0
- package/dist/schemas/skyhooks.d.mts +129 -0
- package/dist/schemas/sovereignty.d.mts +56 -0
- package/dist/schemas/status.d.mts +8 -0
- package/dist/schemas/universe.d.mts +285 -0
- package/dist/schemas/wallet.d.mts +45 -0
- package/dist/schemas/wars.d.mts +27 -0
- package/dist/sde/IStaticDataProvider.d.mts +106 -0
- package/dist/sde/MemorySdeProvider.d.mts +167 -0
- package/dist/sde/SdeDataProvider.d.mts +119 -0
- package/dist/sde/SdeTestDataFactory.d.mts +33 -0
- package/dist/sde/errors.d.mts +23 -0
- package/dist/sde/index.d.mts +9 -0
- package/dist/sde/memory.d.mts +8 -0
- package/dist/sde/types.d.mts +1039 -0
- package/dist/sde/version.d.mts +7 -0
- package/dist/testing/TestDataFactory.d.mts +172 -0
- package/dist/testing/index.d.mts +2 -0
- package/dist/testing/index.js +2 -2
- package/dist/testing/index.mjs +1 -1
- package/dist/types/access-lists.d.mts +5 -0
- package/dist/types/alliance.d.mts +7 -0
- package/dist/types/api-responses.d.mts +40 -0
- package/dist/types/assets.d.mts +6 -0
- package/dist/types/branded.d.mts +23 -0
- package/dist/types/calendar.d.mts +6 -0
- package/dist/types/character.d.mts +17 -0
- package/dist/types/clones.d.mts +4 -0
- package/dist/types/common.d.mts +19 -0
- package/dist/types/contacts.d.mts +5 -0
- package/dist/types/contracts.d.mts +9 -0
- package/dist/types/corporation-projects.d.mts +10 -0
- package/dist/types/corporation.d.mts +19 -0
- package/dist/types/cosmetics.d.mts +8 -0
- package/dist/types/dogma.d.mts +6 -0
- package/dist/types/faction-warfare.d.mts +17 -0
- package/dist/types/fittings.d.mts +4 -0
- package/dist/types/fleet.d.mts +7 -0
- package/dist/types/freelance-jobs.d.mts +12 -0
- package/dist/types/generated/esi-spec.generated.d.mts +2136 -0
- package/dist/types/generated/esi-spec.generated.d.ts +164 -16
- package/dist/types/generated/esi-spec.generated.d.ts.map +1 -1
- package/dist/types/generated/spec-alignment.check.d.ts +2 -2
- package/dist/types/incursions.d.mts +4 -0
- package/dist/types/industry.d.mts +11 -0
- package/dist/types/insurance.d.mts +4 -0
- package/dist/types/killmails.d.mts +5 -0
- package/dist/types/location.d.mts +6 -0
- package/dist/types/loyalty.d.mts +5 -0
- package/dist/types/mail.d.mts +6 -0
- package/dist/types/market.d.mts +12 -0
- package/dist/types/mercenary.d.mts +7 -0
- package/dist/types/meta.d.mts +9 -0
- package/dist/types/military-campaigns.d.mts +6 -0
- package/dist/types/paragon-hub.d.mts +8 -0
- package/dist/types/pi.d.mts +6 -0
- package/dist/types/skills.d.mts +5 -0
- package/dist/types/skyhooks.d.mts +8 -0
- package/dist/types/sovereignty.d.mts +6 -0
- package/dist/types/status.d.mts +4 -0
- package/dist/types/universe.d.mts +27 -0
- package/dist/types/wallet.d.mts +6 -0
- package/dist/types/wars.d.mts +4 -0
- package/package.json +92 -24
- package/dist/chunk-7A72QFDF.mjs.map +0 -1
- package/dist/chunk-HPSACXX3.js.map +0 -1
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { ApiClient } from '../core/ApiClient.mjs';
|
|
2
|
+
import { BaseEsiClient } from './BaseEsiClient.mjs';
|
|
3
|
+
import { assetEndpoints } from '../core/endpoints/assetEndpoints.mjs';
|
|
4
|
+
import { CharacterAsset, AssetLocation, AssetName } from '../types/api-responses.mjs';
|
|
5
|
+
import { PageResult } from '../core/pagination/AsyncPaginationIterator.mjs';
|
|
6
|
+
export declare class AssetsClient extends BaseEsiClient<typeof assetEndpoints> {
|
|
7
|
+
constructor(client: ApiClient);
|
|
8
|
+
/**
|
|
9
|
+
* Retrieve a list of assets owned by a character.
|
|
10
|
+
*
|
|
11
|
+
* @param characterId - The ID of the character whose assets to retrieve
|
|
12
|
+
* @returns A list of the character's assets including type, quantity, and location
|
|
13
|
+
* @requires Authentication
|
|
14
|
+
*/
|
|
15
|
+
getCharacterAssets(characterId: number): Promise<CharacterAsset[]>;
|
|
16
|
+
/**
|
|
17
|
+
* Look up the locations of specific assets owned by a character via a bulk POST request.
|
|
18
|
+
*
|
|
19
|
+
* @param characterId - The ID of the character who owns the assets
|
|
20
|
+
* @param itemIds - An array of item IDs to look up locations for
|
|
21
|
+
* @returns Location information for each requested asset
|
|
22
|
+
* @requires Authentication
|
|
23
|
+
*/
|
|
24
|
+
postCharacterAssetLocations(characterId: number, itemIds: number[]): Promise<AssetLocation[]>;
|
|
25
|
+
/**
|
|
26
|
+
* Look up the names of specific assets owned by a character via a bulk POST request.
|
|
27
|
+
*
|
|
28
|
+
* @param characterId - The ID of the character who owns the assets
|
|
29
|
+
* @param itemIds - An array of item IDs to look up names for
|
|
30
|
+
* @returns The user-assigned names for each requested asset
|
|
31
|
+
* @requires Authentication
|
|
32
|
+
*/
|
|
33
|
+
postCharacterAssetNames(characterId: number, itemIds: number[]): Promise<AssetName[]>;
|
|
34
|
+
/**
|
|
35
|
+
* Retrieve a list of assets owned by a corporation.
|
|
36
|
+
*
|
|
37
|
+
* @param corporationId - The ID of the corporation whose assets to retrieve
|
|
38
|
+
* @returns A list of the corporation's assets including type, quantity, and location
|
|
39
|
+
* @requires Authentication
|
|
40
|
+
*/
|
|
41
|
+
getCorporationAssets(corporationId: number): Promise<CharacterAsset[]>;
|
|
42
|
+
/**
|
|
43
|
+
* Look up the locations of specific assets owned by a corporation via a bulk POST request.
|
|
44
|
+
*
|
|
45
|
+
* @param corporationId - The ID of the corporation that owns the assets
|
|
46
|
+
* @param itemIds - An array of item IDs to look up locations for
|
|
47
|
+
* @returns Location information for each requested asset
|
|
48
|
+
* @requires Authentication
|
|
49
|
+
*/
|
|
50
|
+
postCorporationAssetLocations(corporationId: number, itemIds: number[]): Promise<AssetLocation[]>;
|
|
51
|
+
/**
|
|
52
|
+
* Look up the names of specific assets owned by a corporation via a bulk POST request.
|
|
53
|
+
*
|
|
54
|
+
* @param corporationId - The ID of the corporation that owns the assets
|
|
55
|
+
* @param itemIds - An array of item IDs to look up names for
|
|
56
|
+
* @returns The user-assigned names for each requested asset
|
|
57
|
+
* @requires Authentication
|
|
58
|
+
*/
|
|
59
|
+
postCorporationAssetNames(corporationId: number, itemIds: number[]): Promise<AssetName[]>;
|
|
60
|
+
fetchAllCharacterAssets(characterId: number, concurrency?: number): Promise<CharacterAsset[]>;
|
|
61
|
+
fetchAllCorporationAssets(corporationId: number, concurrency?: number): Promise<CharacterAsset[]>;
|
|
62
|
+
streamCharacterAssets(characterId: number): AsyncGenerator<PageResult<CharacterAsset>, void, undefined>;
|
|
63
|
+
streamCorporationAssets(corporationId: number): AsyncGenerator<PageResult<CharacterAsset>, void, undefined>;
|
|
64
|
+
}
|
|
65
|
+
//# sourceMappingURL=AssetsClient.d.ts.map
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { ApiClient } from '../core/ApiClient.mjs';
|
|
2
|
+
import { createClient, WithMetadata, WithSafeMode } from '../core/endpoints/createClient.mjs';
|
|
3
|
+
import { EndpointMap } from '../core/endpoints/EndpointDefinition.mjs';
|
|
4
|
+
import { PageResult } from '../core/pagination/AsyncPaginationIterator.mjs';
|
|
5
|
+
type ClientMethods<T extends EndpointMap> = ReturnType<typeof createClient<T>>;
|
|
6
|
+
export declare abstract class BaseEsiClient<T extends EndpointMap> {
|
|
7
|
+
protected api: ClientMethods<T>;
|
|
8
|
+
protected _client: ApiClient;
|
|
9
|
+
protected _endpoints: T;
|
|
10
|
+
private _metaApi?;
|
|
11
|
+
private _safeApi?;
|
|
12
|
+
constructor(client: ApiClient, endpoints: T);
|
|
13
|
+
streamEndpoint<R>(endpointName: string & keyof T, ...args: unknown[]): AsyncGenerator<PageResult<R>, void, undefined>;
|
|
14
|
+
fetchAllEndpoint<R>(endpointName: string & keyof T, args: unknown[], concurrency?: number): Promise<R[]>;
|
|
15
|
+
withMetadata(): WithMetadata<Omit<this, 'withMetadata' | 'withSafeMode'>>;
|
|
16
|
+
withSafeMode(): WithSafeMode<Omit<this, 'withMetadata' | 'withSafeMode'>>;
|
|
17
|
+
}
|
|
18
|
+
export {};
|
|
19
|
+
//# sourceMappingURL=BaseEsiClient.d.ts.map
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { ApiClient } from '../core/ApiClient.mjs';
|
|
2
|
+
import { BaseEsiClient } from './BaseEsiClient.mjs';
|
|
3
|
+
import { calendarEndpoints } from '../core/endpoints/calendarEndpoints.mjs';
|
|
4
|
+
import { CalendarEvent, CalendarEventDetail, CalendarEventAttendee } from '../types/api-responses.mjs';
|
|
5
|
+
import { PageResult } from '../core/pagination/AsyncPaginationIterator.mjs';
|
|
6
|
+
export declare class CalendarClient extends BaseEsiClient<typeof calendarEndpoints> {
|
|
7
|
+
constructor(client: ApiClient);
|
|
8
|
+
/**
|
|
9
|
+
* Retrieve a character's upcoming calendar events.
|
|
10
|
+
*
|
|
11
|
+
* @param characterId - The ID of the character whose calendar events to retrieve
|
|
12
|
+
* @returns A list of upcoming calendar events
|
|
13
|
+
* @requires Authentication
|
|
14
|
+
*/
|
|
15
|
+
getCalendarEvents(characterId: number): Promise<CalendarEvent[]>;
|
|
16
|
+
/**
|
|
17
|
+
* Retrieve detailed information about a specific calendar event for a character.
|
|
18
|
+
*
|
|
19
|
+
* @param characterId - The ID of the character who owns the event
|
|
20
|
+
* @param eventId - The ID of the calendar event to retrieve
|
|
21
|
+
* @returns Detailed event information including title, description, and timing
|
|
22
|
+
* @requires Authentication
|
|
23
|
+
*/
|
|
24
|
+
getCalendarEventById(characterId: number, eventId: number): Promise<CalendarEventDetail>;
|
|
25
|
+
/**
|
|
26
|
+
* Set a character's response to a calendar event (accepted, declined, or tentative).
|
|
27
|
+
*
|
|
28
|
+
* @param characterId - The ID of the character responding to the event
|
|
29
|
+
* @param eventId - The ID of the calendar event to respond to
|
|
30
|
+
* @param response - The response status to set for this event
|
|
31
|
+
* @requires Authentication
|
|
32
|
+
*/
|
|
33
|
+
respondToCalendarEvent(characterId: number, eventId: number, response: string): Promise<void>;
|
|
34
|
+
/**
|
|
35
|
+
* Retrieve the list of attendees and their response statuses for a calendar event.
|
|
36
|
+
*
|
|
37
|
+
* @param characterId - The ID of the character who owns the event
|
|
38
|
+
* @param eventId - The ID of the calendar event whose attendees to retrieve
|
|
39
|
+
* @returns A list of attendees with their response statuses
|
|
40
|
+
* @requires Authentication
|
|
41
|
+
*/
|
|
42
|
+
getEventAttendees(characterId: number, eventId: number): Promise<CalendarEventAttendee[]>;
|
|
43
|
+
fetchAllCalendarEvents(characterId: number, concurrency?: number): Promise<CalendarEvent[]>;
|
|
44
|
+
fetchAllEventAttendees(characterId: number, eventId: number, concurrency?: number): Promise<CalendarEventAttendee[]>;
|
|
45
|
+
streamCalendarEvents(characterId: number): AsyncGenerator<PageResult<CalendarEvent>, void, undefined>;
|
|
46
|
+
streamEventAttendees(characterId: number, eventId: number): AsyncGenerator<PageResult<CalendarEventAttendee>, void, undefined>;
|
|
47
|
+
}
|
|
48
|
+
//# sourceMappingURL=CalendarClient.d.ts.map
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
import { ApiClient } from '../core/ApiClient.mjs';
|
|
2
|
+
import { BaseEsiClient } from './BaseEsiClient.mjs';
|
|
3
|
+
import { characterEndpoints } from '../core/endpoints/characterEndpoints.mjs';
|
|
4
|
+
import { CharacterInfo, CharacterPortrait, AgentResearch, Blueprint, CorporationHistory, JumpFatigue, Medal, Notification, Standing, CharacterTitle, CharacterAffiliation, CharacterRole } from '../types/api-responses.mjs';
|
|
5
|
+
import { PageResult } from '../core/pagination/AsyncPaginationIterator.mjs';
|
|
6
|
+
export declare class CharacterClient extends BaseEsiClient<typeof characterEndpoints> {
|
|
7
|
+
constructor(client: ApiClient);
|
|
8
|
+
/**
|
|
9
|
+
* Retrieve publicly available information about a character.
|
|
10
|
+
*
|
|
11
|
+
* @param characterId - The ID of the character to look up
|
|
12
|
+
* @returns Public character information including name, corporation, and birthday
|
|
13
|
+
*/
|
|
14
|
+
getCharacterPublicInfo(characterId: number): Promise<CharacterInfo>;
|
|
15
|
+
/**
|
|
16
|
+
* Retrieve a character's active research agents and their accumulated research points.
|
|
17
|
+
*
|
|
18
|
+
* @param characterId - The ID of the character whose research agents to retrieve
|
|
19
|
+
* @returns A list of research agents with skill, points, and start date information
|
|
20
|
+
* @requires Authentication
|
|
21
|
+
*/
|
|
22
|
+
getCharacterAgentsResearch(characterId: number): Promise<AgentResearch[]>;
|
|
23
|
+
/**
|
|
24
|
+
* Retrieve blueprints owned by a character.
|
|
25
|
+
*
|
|
26
|
+
* @param characterId - The ID of the character whose blueprints to retrieve
|
|
27
|
+
* @returns A list of blueprints with material/time efficiency and run information
|
|
28
|
+
* @requires Authentication
|
|
29
|
+
*/
|
|
30
|
+
getCharacterBlueprints(characterId: number): Promise<Blueprint[]>;
|
|
31
|
+
/**
|
|
32
|
+
* Retrieve the corporation membership history of a character (public endpoint).
|
|
33
|
+
*
|
|
34
|
+
* @param characterId - The ID of the character whose corporation history to retrieve
|
|
35
|
+
* @returns A chronological list of corporations the character has been a member of
|
|
36
|
+
*/
|
|
37
|
+
getCharacterCorporationHistory(characterId: number): Promise<CorporationHistory[]>;
|
|
38
|
+
/**
|
|
39
|
+
* Calculate the CSPA (CONCORD Spam Prevention Act) charge cost for sending mail to a set of characters.
|
|
40
|
+
*
|
|
41
|
+
* @param characterId - The ID of the character who would be sending mail
|
|
42
|
+
* @param characters - An array of character IDs to calculate CSPA charges for
|
|
43
|
+
* @returns The total CSPA charge cost in ISK
|
|
44
|
+
* @requires Authentication
|
|
45
|
+
*/
|
|
46
|
+
postCspaChargeCost(characterId: number, characters: number[]): Promise<number>;
|
|
47
|
+
/**
|
|
48
|
+
* Retrieve a character's current jump fatigue and activation cooldown timers.
|
|
49
|
+
*
|
|
50
|
+
* @param characterId - The ID of the character whose jump fatigue to retrieve
|
|
51
|
+
* @returns Jump fatigue expiry dates and last jump information
|
|
52
|
+
* @requires Authentication
|
|
53
|
+
*/
|
|
54
|
+
getCharacterFatigue(characterId: number): Promise<JumpFatigue>;
|
|
55
|
+
/**
|
|
56
|
+
* Retrieve medals awarded to a character.
|
|
57
|
+
*
|
|
58
|
+
* @param characterId - The ID of the character whose medals to retrieve
|
|
59
|
+
* @returns A list of medals the character has been awarded
|
|
60
|
+
* @requires Authentication
|
|
61
|
+
*/
|
|
62
|
+
getCharacterMedals(characterId: number): Promise<Medal[]>;
|
|
63
|
+
/**
|
|
64
|
+
* Retrieve a character's notifications from the notification center.
|
|
65
|
+
*
|
|
66
|
+
* @param characterId - The ID of the character whose notifications to retrieve
|
|
67
|
+
* @returns A list of notifications including type, sender, and timestamp
|
|
68
|
+
* @requires Authentication
|
|
69
|
+
*/
|
|
70
|
+
getCharacterNotifications(characterId: number): Promise<Notification[]>;
|
|
71
|
+
/**
|
|
72
|
+
* Retrieve notifications related to contact changes for a character.
|
|
73
|
+
*
|
|
74
|
+
* @param characterId - The ID of the character whose contact notifications to retrieve
|
|
75
|
+
* @returns A list of contact-related notifications
|
|
76
|
+
* @requires Authentication
|
|
77
|
+
*/
|
|
78
|
+
getCharacterNotificationsContacts(characterId: number): Promise<Notification[]>;
|
|
79
|
+
/**
|
|
80
|
+
* Retrieve portrait image URLs for a character at various resolutions.
|
|
81
|
+
*
|
|
82
|
+
* @param characterId - The ID of the character whose portrait to retrieve
|
|
83
|
+
* @returns Portrait URLs at different resolutions (64x64, 128x128, 256x256, 512x512)
|
|
84
|
+
*/
|
|
85
|
+
getCharacterPortrait(characterId: number): Promise<CharacterPortrait>;
|
|
86
|
+
/**
|
|
87
|
+
* Retrieve the corporation roles assigned to a character.
|
|
88
|
+
*
|
|
89
|
+
* @param characterId - The ID of the character whose roles to retrieve
|
|
90
|
+
* @returns The character's roles including regular, HQ, base, and other role categories
|
|
91
|
+
* @requires Authentication
|
|
92
|
+
*/
|
|
93
|
+
getCharacterRoles(characterId: number): Promise<CharacterRole>;
|
|
94
|
+
/**
|
|
95
|
+
* Retrieve a character's standings with NPC factions, corporations, and agents.
|
|
96
|
+
*
|
|
97
|
+
* @param characterId - The ID of the character whose standings to retrieve
|
|
98
|
+
* @returns A list of standings with from_type, from_id, and standing value
|
|
99
|
+
* @requires Authentication
|
|
100
|
+
*/
|
|
101
|
+
getCharacterStandings(characterId: number): Promise<Standing[]>;
|
|
102
|
+
/**
|
|
103
|
+
* Retrieve the corporation titles held by a character.
|
|
104
|
+
*
|
|
105
|
+
* @param characterId - The ID of the character whose titles to retrieve
|
|
106
|
+
* @returns A list of corporation titles assigned to the character
|
|
107
|
+
* @requires Authentication
|
|
108
|
+
*/
|
|
109
|
+
getCharacterTitles(characterId: number): Promise<CharacterTitle[]>;
|
|
110
|
+
/**
|
|
111
|
+
* Look up the current corporation, alliance, and faction affiliations for a set of characters via a bulk POST request.
|
|
112
|
+
*
|
|
113
|
+
* @param characters - An array of character IDs to look up affiliations for
|
|
114
|
+
* @returns Affiliation data including corporation, alliance, and faction IDs for each character
|
|
115
|
+
*/
|
|
116
|
+
postCharacterAffiliation(characters: number[]): Promise<CharacterAffiliation[]>;
|
|
117
|
+
fetchAllCharacterAgentsResearch(characterId: number, concurrency?: number): Promise<AgentResearch[]>;
|
|
118
|
+
fetchAllCharacterBlueprints(characterId: number, concurrency?: number): Promise<Blueprint[]>;
|
|
119
|
+
fetchAllCharacterCorporationHistory(characterId: number, concurrency?: number): Promise<CorporationHistory[]>;
|
|
120
|
+
fetchAllCharacterMedals(characterId: number, concurrency?: number): Promise<Medal[]>;
|
|
121
|
+
fetchAllCharacterNotifications(characterId: number, concurrency?: number): Promise<Notification[]>;
|
|
122
|
+
fetchAllCharacterNotificationsContacts(characterId: number, concurrency?: number): Promise<Notification[]>;
|
|
123
|
+
fetchAllCharacterStandings(characterId: number, concurrency?: number): Promise<Standing[]>;
|
|
124
|
+
fetchAllCharacterTitles(characterId: number, concurrency?: number): Promise<CharacterTitle[]>;
|
|
125
|
+
streamCharacterAgentsResearch(characterId: number): AsyncGenerator<PageResult<AgentResearch>, void, undefined>;
|
|
126
|
+
streamCharacterBlueprints(characterId: number): AsyncGenerator<PageResult<Blueprint>, void, undefined>;
|
|
127
|
+
streamCharacterCorporationHistory(characterId: number): AsyncGenerator<PageResult<CorporationHistory>, void, undefined>;
|
|
128
|
+
streamCharacterMedals(characterId: number): AsyncGenerator<PageResult<Medal>, void, undefined>;
|
|
129
|
+
streamCharacterNotifications(characterId: number): AsyncGenerator<PageResult<Notification>, void, undefined>;
|
|
130
|
+
streamCharacterNotificationsContacts(characterId: number): AsyncGenerator<PageResult<Notification>, void, undefined>;
|
|
131
|
+
streamCharacterStandings(characterId: number): AsyncGenerator<PageResult<Standing>, void, undefined>;
|
|
132
|
+
streamCharacterTitles(characterId: number): AsyncGenerator<PageResult<CharacterTitle>, void, undefined>;
|
|
133
|
+
}
|
|
134
|
+
//# sourceMappingURL=CharacterClient.d.ts.map
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { ApiClient } from '../core/ApiClient.mjs';
|
|
2
|
+
import { BaseEsiClient } from './BaseEsiClient.mjs';
|
|
3
|
+
import { cloneEndpoints } from '../core/endpoints/cloneEndpoints.mjs';
|
|
4
|
+
import { CloneInfo } from '../types/api-responses.mjs';
|
|
5
|
+
import { PageResult } from '../core/pagination/AsyncPaginationIterator.mjs';
|
|
6
|
+
export declare class ClonesClient extends BaseEsiClient<typeof cloneEndpoints> {
|
|
7
|
+
constructor(client: ApiClient);
|
|
8
|
+
/**
|
|
9
|
+
* Retrieve a character's clone state, including home station and available jump clones.
|
|
10
|
+
*
|
|
11
|
+
* @param characterId - The ID of the character whose clone information to retrieve
|
|
12
|
+
* @returns Clone information including home location and jump clone details
|
|
13
|
+
* @requires Authentication
|
|
14
|
+
*/
|
|
15
|
+
getClones(characterId: number): Promise<CloneInfo>;
|
|
16
|
+
/**
|
|
17
|
+
* Retrieve the implants currently installed in a character's active clone.
|
|
18
|
+
*
|
|
19
|
+
* @param characterId - The ID of the character whose implants to retrieve
|
|
20
|
+
* @returns An array of type IDs for the currently installed implants
|
|
21
|
+
* @requires Authentication
|
|
22
|
+
*/
|
|
23
|
+
getImplants(characterId: number): Promise<number[]>;
|
|
24
|
+
fetchAllImplants(characterId: number, concurrency?: number): Promise<number[]>;
|
|
25
|
+
streamImplants(characterId: number): AsyncGenerator<PageResult<number>, void, undefined>;
|
|
26
|
+
}
|
|
27
|
+
//# sourceMappingURL=ClonesClient.d.ts.map
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import { ApiClient } from '../core/ApiClient.mjs';
|
|
2
|
+
import { BaseEsiClient } from './BaseEsiClient.mjs';
|
|
3
|
+
import { contactEndpoints } from '../core/endpoints/contactEndpoints.mjs';
|
|
4
|
+
import { Contact, ContactLabel } from '../types/api-responses.mjs';
|
|
5
|
+
import { PageResult } from '../core/pagination/AsyncPaginationIterator.mjs';
|
|
6
|
+
export declare class ContactsClient extends BaseEsiClient<typeof contactEndpoints> {
|
|
7
|
+
constructor(client: ApiClient);
|
|
8
|
+
/**
|
|
9
|
+
* Retrieve contacts for an alliance.
|
|
10
|
+
*
|
|
11
|
+
* @param allianceId - The ID of the alliance whose contacts to retrieve
|
|
12
|
+
* @returns A list of alliance contacts with standings and contact types
|
|
13
|
+
* @requires Authentication
|
|
14
|
+
*/
|
|
15
|
+
getAllianceContacts(allianceId: number): Promise<Contact[]>;
|
|
16
|
+
/**
|
|
17
|
+
* Retrieve custom contact labels for an alliance.
|
|
18
|
+
*
|
|
19
|
+
* @param allianceId - The ID of the alliance whose contact labels to retrieve
|
|
20
|
+
* @returns A list of custom labels used to categorize alliance contacts
|
|
21
|
+
* @requires Authentication
|
|
22
|
+
*/
|
|
23
|
+
getAllianceContactLabels(allianceId: number): Promise<ContactLabel[]>;
|
|
24
|
+
/**
|
|
25
|
+
* Delete contacts from a character's contact list.
|
|
26
|
+
*
|
|
27
|
+
* @param characterId - The ID of the character whose contacts to delete
|
|
28
|
+
* @param contactIds - An array of contact IDs to remove
|
|
29
|
+
* @requires Authentication
|
|
30
|
+
*/
|
|
31
|
+
deleteCharacterContacts(characterId: number, contactIds: number[]): Promise<void>;
|
|
32
|
+
/**
|
|
33
|
+
* Retrieve a character's contact list.
|
|
34
|
+
*
|
|
35
|
+
* @param characterId - The ID of the character whose contacts to retrieve
|
|
36
|
+
* @returns A list of character contacts with standings, labels, and contact types
|
|
37
|
+
* @requires Authentication
|
|
38
|
+
*/
|
|
39
|
+
getCharacterContacts(characterId: number): Promise<Contact[]>;
|
|
40
|
+
/**
|
|
41
|
+
* Add contacts to a character's contact list via a POST request.
|
|
42
|
+
*
|
|
43
|
+
* @param characterId - The ID of the character to add contacts for
|
|
44
|
+
* @param standing - Standing value for the contacts (-10 to 10)
|
|
45
|
+
* @param contactIds - Array of character/corporation/alliance IDs to add
|
|
46
|
+
* @returns An array of contact IDs that were successfully added
|
|
47
|
+
* @requires Authentication
|
|
48
|
+
*/
|
|
49
|
+
postCharacterContacts(characterId: number, standing: number, contactIds: number[]): Promise<number[]>;
|
|
50
|
+
/**
|
|
51
|
+
* Update existing contacts in a character's contact list via a PUT request.
|
|
52
|
+
*
|
|
53
|
+
* @param characterId - The ID of the character whose contacts to update
|
|
54
|
+
* @param standing - New standing value for the contacts (-10 to 10)
|
|
55
|
+
* @param contactIds - Array of contact IDs to update
|
|
56
|
+
* @requires Authentication
|
|
57
|
+
*/
|
|
58
|
+
putCharacterContacts(characterId: number, standing: number, contactIds: number[]): Promise<void>;
|
|
59
|
+
/**
|
|
60
|
+
* Retrieve custom contact labels for a character.
|
|
61
|
+
*
|
|
62
|
+
* @param characterId - The ID of the character whose contact labels to retrieve
|
|
63
|
+
* @returns A list of custom labels used to categorize character contacts
|
|
64
|
+
* @requires Authentication
|
|
65
|
+
*/
|
|
66
|
+
getCharacterContactLabels(characterId: number): Promise<ContactLabel[]>;
|
|
67
|
+
/**
|
|
68
|
+
* Retrieve contacts for a corporation.
|
|
69
|
+
*
|
|
70
|
+
* @param corporationId - The ID of the corporation whose contacts to retrieve
|
|
71
|
+
* @returns A list of corporation contacts with standings and contact types
|
|
72
|
+
* @requires Authentication
|
|
73
|
+
*/
|
|
74
|
+
getCorporationContacts(corporationId: number): Promise<Contact[]>;
|
|
75
|
+
/**
|
|
76
|
+
* Retrieve custom contact labels for a corporation.
|
|
77
|
+
*
|
|
78
|
+
* @param corporationId - The ID of the corporation whose contact labels to retrieve
|
|
79
|
+
* @returns A list of custom labels used to categorize corporation contacts
|
|
80
|
+
* @requires Authentication
|
|
81
|
+
*/
|
|
82
|
+
getCorporationContactLabels(corporationId: number): Promise<ContactLabel[]>;
|
|
83
|
+
fetchAllAllianceContacts(allianceId: number, concurrency?: number): Promise<Contact[]>;
|
|
84
|
+
fetchAllAllianceContactLabels(allianceId: number, concurrency?: number): Promise<ContactLabel[]>;
|
|
85
|
+
fetchAllCharacterContacts(characterId: number, concurrency?: number): Promise<Contact[]>;
|
|
86
|
+
fetchAllCharacterContactLabels(characterId: number, concurrency?: number): Promise<ContactLabel[]>;
|
|
87
|
+
fetchAllCorporationContacts(corporationId: number, concurrency?: number): Promise<Contact[]>;
|
|
88
|
+
fetchAllCorporationContactLabels(corporationId: number, concurrency?: number): Promise<ContactLabel[]>;
|
|
89
|
+
streamAllianceContacts(allianceId: number): AsyncGenerator<PageResult<Contact>, void, undefined>;
|
|
90
|
+
streamAllianceContactLabels(allianceId: number): AsyncGenerator<PageResult<ContactLabel>, void, undefined>;
|
|
91
|
+
streamCharacterContacts(characterId: number): AsyncGenerator<PageResult<Contact>, void, undefined>;
|
|
92
|
+
streamCharacterContactLabels(characterId: number): AsyncGenerator<PageResult<ContactLabel>, void, undefined>;
|
|
93
|
+
streamCorporationContacts(corporationId: number): AsyncGenerator<PageResult<Contact>, void, undefined>;
|
|
94
|
+
streamCorporationContactLabels(corporationId: number): AsyncGenerator<PageResult<ContactLabel>, void, undefined>;
|
|
95
|
+
}
|
|
96
|
+
//# sourceMappingURL=ContactsClient.d.ts.map
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import { ApiClient } from '../core/ApiClient.mjs';
|
|
2
|
+
import { BaseEsiClient } from './BaseEsiClient.mjs';
|
|
3
|
+
import { contractEndpoints } from '../core/endpoints/contractEndpoints.mjs';
|
|
4
|
+
import { Contract, ContractBid, ContractItem, PublicContract, PublicContractBid, PublicContractItem } from '../types/api-responses.mjs';
|
|
5
|
+
import { PageResult } from '../core/pagination/AsyncPaginationIterator.mjs';
|
|
6
|
+
export declare class ContractsClient extends BaseEsiClient<typeof contractEndpoints> {
|
|
7
|
+
constructor(client: ApiClient);
|
|
8
|
+
/**
|
|
9
|
+
* Retrieve contracts issued by or assigned to a character.
|
|
10
|
+
*
|
|
11
|
+
* @param characterId - The ID of the character whose contracts to retrieve
|
|
12
|
+
* @returns A list of contracts with type, status, and pricing information
|
|
13
|
+
* @requires Authentication
|
|
14
|
+
*/
|
|
15
|
+
getCharacterContracts(characterId: number): Promise<Contract[]>;
|
|
16
|
+
/**
|
|
17
|
+
* Retrieve bids placed on an auction contract owned by a character.
|
|
18
|
+
*
|
|
19
|
+
* @param characterId - The ID of the character who owns the contract
|
|
20
|
+
* @param contractId - The ID of the contract whose bids to retrieve
|
|
21
|
+
* @returns A list of bids with bidder, amount, and timestamp
|
|
22
|
+
* @requires Authentication
|
|
23
|
+
*/
|
|
24
|
+
getCharacterContractBids(characterId: number, contractId: number): Promise<ContractBid[]>;
|
|
25
|
+
/**
|
|
26
|
+
* Retrieve the items included in a contract owned by a character.
|
|
27
|
+
*
|
|
28
|
+
* @param characterId - The ID of the character who owns the contract
|
|
29
|
+
* @param contractId - The ID of the contract whose items to retrieve
|
|
30
|
+
* @returns A list of items in the contract with type, quantity, and included/excluded status
|
|
31
|
+
* @requires Authentication
|
|
32
|
+
*/
|
|
33
|
+
getCharacterContractItems(characterId: number, contractId: number): Promise<ContractItem[]>;
|
|
34
|
+
/**
|
|
35
|
+
* Retrieve publicly available contracts in a specific region.
|
|
36
|
+
*
|
|
37
|
+
* @param regionId - The ID of the region whose public contracts to retrieve
|
|
38
|
+
* @returns A list of public contracts in the region. ESI sends no status
|
|
39
|
+
* or availability on these: every listed contract is public and outstanding.
|
|
40
|
+
*/
|
|
41
|
+
getPublicContracts(regionId: number): Promise<PublicContract[]>;
|
|
42
|
+
/**
|
|
43
|
+
* Retrieve bids placed on a public auction contract.
|
|
44
|
+
*
|
|
45
|
+
* @param contractId - The ID of the public contract whose bids to retrieve
|
|
46
|
+
* @returns A list of bids with amount and timestamp. ESI does not name the
|
|
47
|
+
* bidder on a public contract.
|
|
48
|
+
*/
|
|
49
|
+
getPublicContractBids(contractId: number): Promise<PublicContractBid[]>;
|
|
50
|
+
/**
|
|
51
|
+
* Retrieve the items included in a public contract.
|
|
52
|
+
*
|
|
53
|
+
* @param contractId - The ID of the public contract whose items to retrieve
|
|
54
|
+
* @returns A list of items in the contract with type, quantity, and included/excluded
|
|
55
|
+
* status; blueprint lines also carry item ID, efficiencies and runs
|
|
56
|
+
*/
|
|
57
|
+
getPublicContractItems(contractId: number): Promise<PublicContractItem[]>;
|
|
58
|
+
/**
|
|
59
|
+
* Retrieve contracts issued by or assigned to a corporation.
|
|
60
|
+
*
|
|
61
|
+
* @param corporationId - The ID of the corporation whose contracts to retrieve
|
|
62
|
+
* @returns A list of contracts with type, status, and pricing information
|
|
63
|
+
* @requires Authentication
|
|
64
|
+
*/
|
|
65
|
+
getCorporationContracts(corporationId: number): Promise<Contract[]>;
|
|
66
|
+
/**
|
|
67
|
+
* Retrieve bids placed on an auction contract owned by a corporation.
|
|
68
|
+
*
|
|
69
|
+
* @param corporationId - The ID of the corporation that owns the contract
|
|
70
|
+
* @param contractId - The ID of the contract whose bids to retrieve
|
|
71
|
+
* @returns A list of bids with bidder, amount, and timestamp
|
|
72
|
+
* @requires Authentication
|
|
73
|
+
*/
|
|
74
|
+
getCorporationContractBids(corporationId: number, contractId: number): Promise<ContractBid[]>;
|
|
75
|
+
/**
|
|
76
|
+
* Retrieve the items included in a contract owned by a corporation.
|
|
77
|
+
*
|
|
78
|
+
* @param corporationId - The ID of the corporation that owns the contract
|
|
79
|
+
* @param contractId - The ID of the contract whose items to retrieve
|
|
80
|
+
* @returns A list of items in the contract with type, quantity, and included/excluded status
|
|
81
|
+
* @requires Authentication
|
|
82
|
+
*/
|
|
83
|
+
getCorporationContractItems(corporationId: number, contractId: number): Promise<ContractItem[]>;
|
|
84
|
+
fetchAllPublicContracts(regionId: number, concurrency?: number): Promise<PublicContract[]>;
|
|
85
|
+
fetchAllCharacterContracts(characterId: number, concurrency?: number): Promise<Contract[]>;
|
|
86
|
+
fetchAllCorporationContracts(corporationId: number, concurrency?: number): Promise<Contract[]>;
|
|
87
|
+
streamPublicContracts(regionId: number): AsyncGenerator<PageResult<PublicContract>, void, undefined>;
|
|
88
|
+
streamCharacterContracts(characterId: number): AsyncGenerator<PageResult<Contract>, void, undefined>;
|
|
89
|
+
streamCorporationContracts(corporationId: number): AsyncGenerator<PageResult<Contract>, void, undefined>;
|
|
90
|
+
}
|
|
91
|
+
//# sourceMappingURL=ContractsClient.d.ts.map
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { ApiClient } from '../core/ApiClient.mjs';
|
|
2
|
+
import { BaseEsiClient } from './BaseEsiClient.mjs';
|
|
3
|
+
import { corporationProjectEndpoints } from '../core/endpoints/corporationProjectEndpoints.mjs';
|
|
4
|
+
import { CorporationProject, CorporationProjectContribution, CorporationProjectContributorsListing, CorporationProjectsListing } from '../types/api-responses.mjs';
|
|
5
|
+
export declare class CorporationProjectsClient extends BaseEsiClient<typeof corporationProjectEndpoints> {
|
|
6
|
+
constructor(client: ApiClient);
|
|
7
|
+
/**
|
|
8
|
+
* Retrieves one page of a corporation's projects.
|
|
9
|
+
*
|
|
10
|
+
* The list is cursor paginated: pass `cursor.after` from one page as
|
|
11
|
+
* `after` to read the next. Tokens are opaque; an empty `projects` array
|
|
12
|
+
* marks the end of the list.
|
|
13
|
+
*
|
|
14
|
+
* @param corporationId - The ID of the corporation
|
|
15
|
+
* @param before - Optional cursor token to read records before
|
|
16
|
+
* @param after - Optional cursor token to read records after
|
|
17
|
+
* @returns A page of projects and its cursor
|
|
18
|
+
* @requires Authentication
|
|
19
|
+
*/
|
|
20
|
+
getCorporationProjects(corporationId: number, before?: string, after?: string): Promise<CorporationProjectsListing>;
|
|
21
|
+
/**
|
|
22
|
+
* Retrieves details of a specific corporation project.
|
|
23
|
+
*
|
|
24
|
+
* @param corporationId - The ID of the corporation
|
|
25
|
+
* @param projectId - The project's UUID
|
|
26
|
+
* @returns The corporation project details
|
|
27
|
+
* @requires Authentication
|
|
28
|
+
*/
|
|
29
|
+
getCorporationProject(corporationId: number, projectId: string): Promise<CorporationProject>;
|
|
30
|
+
/**
|
|
31
|
+
* Retrieves a character's contribution to a specific corporation project.
|
|
32
|
+
*
|
|
33
|
+
* @param corporationId - The ID of the corporation
|
|
34
|
+
* @param projectId - The project's UUID
|
|
35
|
+
* @param characterId - The ID of the character
|
|
36
|
+
* @returns The character's contribution details
|
|
37
|
+
* @requires Authentication
|
|
38
|
+
*/
|
|
39
|
+
getCorporationProjectContribution(corporationId: number, projectId: string, characterId: number): Promise<CorporationProjectContribution>;
|
|
40
|
+
/**
|
|
41
|
+
* Retrieves one page of the contributors to a corporation project.
|
|
42
|
+
*
|
|
43
|
+
* Cursor paginated in the same way as {@link getCorporationProjects}.
|
|
44
|
+
*
|
|
45
|
+
* @param corporationId - The ID of the corporation
|
|
46
|
+
* @param projectId - The project's UUID
|
|
47
|
+
* @param before - Optional cursor token to read records before
|
|
48
|
+
* @param after - Optional cursor token to read records after
|
|
49
|
+
* @returns A page of contributors and its cursor
|
|
50
|
+
* @requires Authentication
|
|
51
|
+
*/
|
|
52
|
+
getCorporationProjectContributors(corporationId: number, projectId: string, before?: string, after?: string): Promise<CorporationProjectContributorsListing>;
|
|
53
|
+
}
|
|
54
|
+
//# sourceMappingURL=CorporationProjectsClient.d.ts.map
|