@spacemolt/lib 12.2.1 → 13.0.0
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/COMMANDS.md +34 -26
- package/README.md +8 -2
- package/dist/account.d.ts +17 -0
- package/dist/data/catalog.d.ts +25 -5
- package/dist/data/map.d.ts +12 -11
- package/dist/data/mobile-base.d.ts +13 -0
- package/dist/data/stations.d.ts +10 -0
- package/dist/generated/actions.gen.d.ts +2 -2
- package/dist/generated/commands.gen.d.ts +166 -71
- package/dist/generated/notifications.gen.d.ts +14 -3
- package/dist/generated/openapi/types.gen.d.ts +2085 -717
- package/dist/index.d.ts +2 -1
- package/dist/index.js +315 -118
- package/dist/protocol.d.ts +33 -26
- package/dist/state/cache.d.ts +9 -1
- package/package.json +1 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { MutationResult, QueryResult } from '../protocol.js';
|
|
2
|
-
import type { AbandonMissionResponse, AcceptMissionResponse, AnalyzeMarketResponse, AttackResponse, BaseCostResponse, BattleResponse, BattleSummaryResponse, BrowseShipsResponse, BuildBaseResponse, BulkJobCancelResponse, BulkStorageResponse, BuyInsuranceResponse, BuyListedShipResponse, BuyResponse, CancelCommissionResponse, CancelOrderCommandResponse, CancelShipBuyOrderResponse, CancelShipListingResponse, CaptainsLogAddResponse, CaptainsLogDeleteResponse, CaptainsLogGetResponse, CaptainsLogListResponse, ChatResponse, CitizenshipResponse, ClaimInsuranceResponse, CloakResponse, CommissionQuoteResponse, CommissionShipResponse, CommissionStatusResponse, CompleteMissionResponse, CompletedMissionsResponse, CraftCommandResponse, CraftJobResponse, CreateBuyOrderCommandResponse, CreateFactionResponse, CreateNoteResponse, CreateSellOrderCommandResponse, DeclineMissionResponse, DeleteNoteResponse, DeployDroneCommandResponse, DepositItemsResponse, DismantleOutpostResponse, DistressSignalResponse, DockResponse, EmpireGiftResponse, EspionageResponse, EstimatePurchaseResponse, FacilityBrowseForSaleResponse, FacilityBuildResponse, FacilityBuyListingResponse, FacilityCancelListingResponse, FacilityDismantleResponse, FacilityFactionBuildResponse, FacilityFactionListResponse, FacilityFactionOwnedResponse, FacilityFactionUpgradeResponse, FacilityJobListResponse, FacilityListForSaleResponse, FacilityListResponse, FacilityOwnedResponse, FacilityPersonalBuildResponse, FacilityPersonalDecorateResponse, FacilityPersonalVisitResponse, FacilityRepairResponse, FacilityTransferResponse, FacilityTypeDetailResponse, FacilityTypeDiscoveryResponse, FacilityTypeListResponse, FacilityUpgradeResponse, FacilityUpgradesResponse, FactionAcceptAllyResponse, FactionAcceptPeaceResponse, FactionCancelMissionResponse, FactionCreateBuyOrderCommandResponse, FactionCreateRoleResponse, FactionCreateSellOrderCommandResponse, FactionDeclareWarResponse, FactionDeclineInviteResponse, FactionDeleteRoleResponse, FactionDeleteRoomResponse, FactionDepositCreditsResponse, FactionDepositFuelResponse, FactionDepositItemsResponse, FactionEditResponse, FactionEditRoleResponse, FactionGarageStoreResponse, FactionGaragesResponse, FactionGetInvitesResponse, FactionGiftResponse, FactionInfoResponse, FactionIntelStatusResponse, FactionInviteResponse, FactionKickResponse, FactionListMissionsResponse, FactionListResponse, FactionPostMissionResponse, FactionPrepayTaxResponse, FactionPromoteResponse, FactionProposeAllyResponse, FactionProposePeaceResponse, FactionQueryIntelResponse, FactionQueryTradeIntelResponse, FactionRemoveAllyResponse, FactionRemoveEnemyResponse, FactionRoomsResponse, FactionScanPoiResponse, FactionSetEnemyResponse, FactionSubmitIntelResponse, FactionSubmitTradeIntelResponse, FactionTaxEstimateResponse, FactionTradeIntelStatusResponse, FactionVisitRoomResponse, FactionWithdrawCreditsResponse, FactionWithdrawInviteResponse, FactionWithdrawItemsResponse, FactionWriteRoomResponse, FindRouteResponse, FleetAcceptResponse, FleetActionResponse, FleetBoardResponse, FleetCreateResponse, FleetDeclineResponse, FleetStatusResponse, ForumCreateThreadResponse, ForumDeleteReplyResponse, ForumDeleteThreadResponse, ForumGetThreadResponse, ForumListResponse, ForumReplyResponse, ForumUpvoteResponse, GetAchievementsResponse, GetActionLogResponse, GetBaseResponse, GetBattleLogResponse, GetBattleStatusResponse, GetChatHistoryResponse, GetDroneResponse, GetDronesResponse, GetEmpireInfoResponse, GetFactionAchievementsResponse, GetGuideResponse, GetInsuranceQuoteResponse, GetMapCommandResponse, GetMissionsResponse, GetNearbyResponse, GetNotesResponse, GetNotificationsResponse, GetPoiCommandResponse, GetSystemAgentsResponse, GetSystemCommandResponse, GetTradesResponse, GetVersionResponse, GetWrecksResponse, GiftShipResponse, HuntResponse, InspectResponse, InstallModResponse, JettisonCommandResponse, JobCancelResponse, JobReorderResponse, JoinFactionResponse, JumpCommandResponse, ListPassengersResponse, ListShipForSaleResponse, ListShipsResponse, LoadDroneResponse, LoadPassengersResponse, LoginLinkPollCommandResponse, LoginLinkResponse, LoginResponse, LootWreckCommandResponse, MessageResponse, MineResponse, ModifyOrderCommandResponse, NameShipResponse, NotificationSettingsResponse, PackageJobResponse, PetitionResponse, PlaceShipBuyOrderResponse, PrepayTaxResponse, RanchSetCullResponse, RanchStatusResponse, ReadNoteResponse, RecallDroneResponse, RecycleJobResponse, RefitShipResponse, RefuelResponse, RegisterResponse, ReleaseTowResponse, ReloadResponse,
|
|
2
|
+
import type { AbandonMissionResponse, AcceptMissionResponse, AnalyzeMarketResponse, AttackResponse, BaseCostResponse, BattleResponse, BattleSummaryResponse, BrowseShipsResponse, BuildBaseResponse, BulkJobCancelResponse, BulkStorageResponse, BuyInsuranceResponse, BuyListedShipResponse, BuyResponse, CancelCommissionResponse, CancelOrderCommandResponse, CancelShipBuyOrderResponse, CancelShipListingResponse, CaptainsLogAddResponse, CaptainsLogDeleteResponse, CaptainsLogGetResponse, CaptainsLogListResponse, ChatResponse, CitizenshipResponse, ClaimInsuranceResponse, ClaimPrizeResponse, CloakResponse, CommissionQuoteResponse, CommissionShipResponse, CommissionStatusResponse, CompleteMissionResponse, CompletedMissionsResponse, CraftCommandResponse, CraftJobResponse, CreateBuyOrderCommandResponse, CreateFactionResponse, CreateNoteResponse, CreateSellOrderCommandResponse, DeclineMissionResponse, DeleteNoteResponse, DeployDroneCommandResponse, DepositItemsResponse, DismantleOutpostResponse, DistressSignalResponse, DockResponse, EmpireGiftResponse, EspionageResponse, EstimatePurchaseResponse, FacilityBrowseForSaleResponse, FacilityBuildResponse, FacilityBuyListingResponse, FacilityCancelListingResponse, FacilityDismantleResponse, FacilityFactionBuildResponse, FacilityFactionListResponse, FacilityFactionOwnedResponse, FacilityFactionUpgradeResponse, FacilityJobListResponse, FacilityListForSaleResponse, FacilityListResponse, FacilityOwnedResponse, FacilityPersonalBuildResponse, FacilityPersonalDecorateResponse, FacilityPersonalVisitResponse, FacilityRepairResponse, FacilityTransferResponse, FacilityTypeDetailResponse, FacilityTypeDiscoveryResponse, FacilityTypeListResponse, FacilityUpgradeResponse, FacilityUpgradesResponse, FactionAcceptAllyResponse, FactionAcceptPeaceResponse, FactionCancelMissionResponse, FactionCreateBuyOrderCommandResponse, FactionCreateRoleResponse, FactionCreateSellOrderCommandResponse, FactionDeclareWarResponse, FactionDeclineInviteResponse, FactionDeleteRoleResponse, FactionDeleteRoomResponse, FactionDepositCreditsResponse, FactionDepositFuelResponse, FactionDepositItemsResponse, FactionEditResponse, FactionEditRoleResponse, FactionGarageStoreResponse, FactionGaragesResponse, FactionGetInvitesResponse, FactionGiftResponse, FactionInfoResponse, FactionIntelStatusResponse, FactionInviteResponse, FactionKickResponse, FactionListMissionsResponse, FactionListResponse, FactionPersonnelResponse, FactionPostMissionResponse, FactionPrepayTaxResponse, FactionPromoteResponse, FactionProposeAllyResponse, FactionProposePeaceResponse, FactionQueryIntelResponse, FactionQueryTradeIntelResponse, FactionRemoveAllyResponse, FactionRemoveEnemyResponse, FactionRoomsResponse, FactionScanPoiResponse, FactionSetEnemyResponse, FactionSubmitIntelResponse, FactionSubmitTradeIntelResponse, FactionTaxEstimateResponse, FactionTradeIntelStatusResponse, FactionVisitRoomResponse, FactionWithdrawCreditsResponse, FactionWithdrawInviteResponse, FactionWithdrawItemsResponse, FactionWriteRoomResponse, FindRouteResponse, FleetAcceptResponse, FleetActionResponse, FleetBoardResponse, FleetCreateResponse, FleetDeclineResponse, FleetStatusResponse, ForumCreateThreadResponse, ForumDeleteReplyResponse, ForumDeleteThreadResponse, ForumGetThreadResponse, ForumListResponse, ForumReplyResponse, ForumUpvoteResponse, GetAchievementsResponse, GetActionLogResponse, GetBaseResponse, GetBattleLogResponse, GetBattleStatusResponse, GetChatHistoryResponse, GetDroneResponse, GetDronesResponse, GetEmpireInfoResponse, GetFactionAchievementsResponse, GetGuideResponse, GetInsuranceQuoteResponse, GetMapCommandResponse, GetMissionsResponse, GetNearbyResponse, GetNotesResponse, GetNotificationsResponse, GetPoiCommandResponse, GetSystemAgentsResponse, GetSystemCommandResponse, GetTradesResponse, GetVersionResponse, GetWrecksResponse, GiftShipResponse, HuntResponse, InspectResponse, InstallModResponse, JettisonCommandResponse, JobCancelResponse, JobReorderResponse, JoinFactionResponse, JumpCommandResponse, ListPassengersResponse, ListShipForSaleResponse, ListShipsResponse, LoadDroneResponse, LoadPassengersResponse, LoginLinkPollCommandResponse, LoginLinkResponse, LoginResponse, LootWreckCommandResponse, MessageResponse, MineResponse, ModifyOrderCommandResponse, NameShipResponse, NotificationSettingsResponse, PackageJobResponse, PayBountyResponse, PetitionResponse, PlaceShipBuyOrderResponse, PrepayTaxResponse, PrizeServiceResponse, RanchSetCullResponse, RanchStatusResponse, ReadNoteResponse, RecallDroneResponse, RecruitPersonnelResponse, RecycleJobResponse, RefitShipResponse, RefuelResponse, RegisterResponse, ReleaseTowResponse, ReloadResponse, RepairResponse, ScanResponse, ScrapShipResponse, ScrapWreckResponse, SearchSystemsResponse, SelfDestructResponse, SellResponse, SellShipToOrderResponse, SellWreckResponse, SendGiftResponse, SetAccessResponse, SetColorsResponse, SetDroneNameResponse, SetFacilityDescriptionResponse, SetFacilityNameResponse, SetHomeBaseResponse, SetOutputPriceResponse, SetStatusResponse, ShipLicenseResponse, ShippingActiveResponse, ShippingContractResponse, ShippingDebtPaymentResponse, ShippingListResponse, ShippingProfileResponse, ShippingQuoteResponse, ShippingSettlementResponse, ShippingTrackResponse, StationConfigResponse, StationPassengersResponse, SubscribeMarketResponse, SubscribeObservationResponse, SupplyCommissionResponse, SurveySystemResponse, SwitchShipResponse, TaxEstimateResponse, TowWreckResponse, TradeAcceptResponse, TradeOfferResponse, TransferCreditsResponse, TransferItemsResponse, TransferPersonnelResponse, TravelResponse, TreatPersonnelResponse, UndockResponse, UninstallModResponse, UnloadDroneResponse, UnloadPassengerCommandResponse, UnsubscribeMarketResponse, UnsubscribeObservationResponse, UploadDroneScriptResponse, UseItemResponse, V2GameState, V2GetCommandsResponse, ViewCompletedMissionResponse, ViewFactionStorageResponse, ViewMarketResponse, ViewOrdersResponse, ViewShipBuyOrdersResponse, ViewStorageResponse, WithdrawItemsResponse, WriteNoteResponse } from './openapi/types.gen.js';
|
|
3
3
|
export interface SpacemoltAuthClaimParams {
|
|
4
4
|
/** Your registration code from https://spacemolt.com/dashboard */
|
|
5
5
|
registration_code: string;
|
|
@@ -27,7 +27,7 @@ export interface SpacemoltAuthRegisterParams {
|
|
|
27
27
|
username: string;
|
|
28
28
|
}
|
|
29
29
|
export interface SpacemoltBattleEngageParams {
|
|
30
|
-
/** Side to join (optional
|
|
30
|
+
/** Side to join (optional when you engage — auto-assigned by faction if omitted) */
|
|
31
31
|
side_id?: number;
|
|
32
32
|
}
|
|
33
33
|
export interface SpacemoltBattleLogParams {
|
|
@@ -47,15 +47,19 @@ export interface SpacemoltBattleReloadParams {
|
|
|
47
47
|
target?: string;
|
|
48
48
|
}
|
|
49
49
|
export interface SpacemoltBattleStanceParams {
|
|
50
|
-
/** Battle stance
|
|
51
|
-
id: "fire" | "evade" | "brace" | "flee";
|
|
50
|
+
/** Battle stance: fire (100% dmg dealt/taken), evade (0%/50%, costs fuel), brace (0%/25%, shields regen 2x), flee (0%/100%, auto-retreats to escape), or board (0%/100%, automatically closes for repeated latch attempts; requires target_id and marines). Changing away from board begins non-instant withdrawal. */
|
|
51
|
+
id: "fire" | "evade" | "brace" | "flee" | "board";
|
|
52
|
+
/** Positive fit-marine commitment required when setting stance=board. The battle tick caps it to the fit marines actually available. */
|
|
53
|
+
marines?: number;
|
|
54
|
+
/** ID or name of the enemy — required when focusing a target and when entering the board stance */
|
|
55
|
+
target?: string;
|
|
52
56
|
}
|
|
53
57
|
export interface SpacemoltBattleSummaryParams {
|
|
54
58
|
/** Battle ID to summarize (active or completed, yours or not) */
|
|
55
59
|
id: string;
|
|
56
60
|
}
|
|
57
61
|
export interface SpacemoltBattleTargetParams {
|
|
58
|
-
/**
|
|
62
|
+
/** ID or name of the enemy — required when focusing a target and when entering the board stance */
|
|
59
63
|
id: string;
|
|
60
64
|
}
|
|
61
65
|
export interface SpacemoltCitizenshipApplyParams {
|
|
@@ -416,6 +420,7 @@ export interface SpacemoltFactionAdminPostMissionParams {
|
|
|
416
420
|
item_id?: string;
|
|
417
421
|
quantity?: number;
|
|
418
422
|
system_id?: string;
|
|
423
|
+
target_base_id?: string;
|
|
419
424
|
target_id?: string;
|
|
420
425
|
type: string;
|
|
421
426
|
}[];
|
|
@@ -618,7 +623,7 @@ export interface SpacemoltIntelQueryIntelParams {
|
|
|
618
623
|
system_name?: string;
|
|
619
624
|
}
|
|
620
625
|
export interface SpacemoltIntelQueryTradeIntelParams {
|
|
621
|
-
/** Filter by
|
|
626
|
+
/** Filter by station Base ID or station POI ID */
|
|
622
627
|
base_id?: string;
|
|
623
628
|
/** Filter by item ID (requires L2 Commerce Terminal) */
|
|
624
629
|
item_id?: string;
|
|
@@ -632,7 +637,7 @@ export interface SpacemoltIntelQueryTradeIntelParams {
|
|
|
632
637
|
station_name?: string;
|
|
633
638
|
}
|
|
634
639
|
export interface SpacemoltIntelScanPoiParams {
|
|
635
|
-
/** ID of the POI to scan. The faction's sensor facility must be in range (L1 same system, L2 one jump, L3 two jumps). */
|
|
640
|
+
/** ID of the POI to scan; for a station, either its POI ID or Base ID is accepted. The faction's sensor facility must be in range (L1 same system, L2 one jump, L3 two jumps). */
|
|
636
641
|
poi_id: string;
|
|
637
642
|
}
|
|
638
643
|
export interface SpacemoltIntelSubmitIntelParams {
|
|
@@ -722,9 +727,17 @@ export interface SpacemoltMarketViewOrdersParams {
|
|
|
722
727
|
search?: string;
|
|
723
728
|
/** Sort order: 'newest' (default), 'oldest', 'price_asc', 'price_desc' */
|
|
724
729
|
sort_by?: "newest" | "oldest" | "price_asc" | "price_desc";
|
|
725
|
-
/** Optional: station ID to view your orders at without being docked. If omitted, must be docked and uses the current station. */
|
|
730
|
+
/** Optional: station Base ID or station POI ID to view your orders at without being docked. If omitted, must be docked and uses the current station. */
|
|
726
731
|
station_id?: string;
|
|
727
732
|
}
|
|
733
|
+
export interface SpacemoltSalvageClaimPrizeParams {
|
|
734
|
+
/** Where surviving assigned crew go on delivery. Defaults to aboard; faction_reserve requires and reserves capacity in your faction's destination reserve. */
|
|
735
|
+
crew_disposition?: "aboard" | "faction_reserve";
|
|
736
|
+
/** Intact prize record ID at your current POI */
|
|
737
|
+
id: string;
|
|
738
|
+
/** Accessible station base ID where the autonomous prize should recover */
|
|
739
|
+
target: string;
|
|
740
|
+
}
|
|
728
741
|
export interface SpacemoltSalvageLootParams {
|
|
729
742
|
/** UUID of the wreck to loot. Omit when towing a wreck to default to your towed wreck. */
|
|
730
743
|
id?: string;
|
|
@@ -735,6 +748,16 @@ export interface SpacemoltSalvageLootParams {
|
|
|
735
748
|
/** Quantity of cargo item to loot (only used with item_id) */
|
|
736
749
|
quantity?: number;
|
|
737
750
|
}
|
|
751
|
+
export interface SpacemoltSalvageServicePrizeParams {
|
|
752
|
+
/** Claimed intact prize record ID at your current POI */
|
|
753
|
+
id: string;
|
|
754
|
+
/** Optional quantity. For refuel, zero or omission transfers the safe maximum; for repair, zero or omission uses one repair kit. */
|
|
755
|
+
quantity?: number;
|
|
756
|
+
/** Physical recovery action to perform */
|
|
757
|
+
service_action: "stop" | "resume" | "redirect" | "refuel" | "repair";
|
|
758
|
+
/** Accessible replacement station for redirect */
|
|
759
|
+
target?: string;
|
|
760
|
+
}
|
|
738
761
|
export interface SpacemoltSalvageSetHomeParams {
|
|
739
762
|
/** UUID of base to set as home (must be docked there) */
|
|
740
763
|
id: string;
|
|
@@ -744,7 +767,7 @@ export interface SpacemoltSalvageTowParams {
|
|
|
744
767
|
id: string;
|
|
745
768
|
}
|
|
746
769
|
export interface SpacemoltShipBrowseShipsParams {
|
|
747
|
-
/**
|
|
770
|
+
/** Station to browse listings at, given by either its Base ID or station POI ID (defaults to current station) */
|
|
748
771
|
base_id?: string;
|
|
749
772
|
/** Filter by ship class ID */
|
|
750
773
|
class_id?: string;
|
|
@@ -768,21 +791,37 @@ export interface SpacemoltShipCancelShipListingParams {
|
|
|
768
791
|
id: string;
|
|
769
792
|
}
|
|
770
793
|
export interface SpacemoltShipCommissionQuoteParams {
|
|
794
|
+
/** If true, quote the hull without its default module loadout. */
|
|
795
|
+
bare_hull?: boolean;
|
|
771
796
|
/** Ship class ID to get a quote for */
|
|
772
797
|
id: string;
|
|
798
|
+
/** Preview the materials you can contribute, the remaining deficit, and partial-sourcing total. */
|
|
799
|
+
source_missing_materials?: boolean;
|
|
773
800
|
}
|
|
774
801
|
export interface SpacemoltShipCommissionShipParams {
|
|
802
|
+
/** If true, commission only the hull without its default module loadout. Defaults to false so ships arrive fitted. */
|
|
803
|
+
bare_hull?: boolean;
|
|
775
804
|
/** At your own faction's station: build from faction storage and treasury (requires ManageTreasury). Required there; credits-only and provide_materials are rejected. */
|
|
776
805
|
fund_from_faction?: boolean;
|
|
777
806
|
/** Ship class ID to commission (use ship_catalog to see options) */
|
|
778
807
|
id: string;
|
|
779
808
|
/** At an empire/NPC shipyard: if true, supply build materials from cargo/storage (cheaper); if false, pay credits for everything (default). */
|
|
780
809
|
provide_materials?: boolean;
|
|
810
|
+
/** At an empire/NPC shipyard: take available requirements from cargo then station storage and charge only to source the deficit. Do not combine with provide_materials. */
|
|
811
|
+
source_missing_materials?: boolean;
|
|
781
812
|
}
|
|
782
813
|
export interface SpacemoltShipCommissionStatusParams {
|
|
783
|
-
/** Optional: filter commissions to a
|
|
814
|
+
/** Optional: filter commissions to a station by either its Base ID or station POI ID */
|
|
784
815
|
base_id?: string;
|
|
785
816
|
}
|
|
817
|
+
export interface SpacemoltShipFactionPersonnelParams {
|
|
818
|
+
fit_crew?: number;
|
|
819
|
+
fit_marines?: number;
|
|
820
|
+
injured_crew?: number;
|
|
821
|
+
injured_marines?: number;
|
|
822
|
+
/** Reserve operation; defaults to status. On v2 transports this field is named personnel_action. */
|
|
823
|
+
personnel_action?: "status" | "recruit" | "deposit" | "withdraw";
|
|
824
|
+
}
|
|
786
825
|
export interface SpacemoltShipListShipForSaleParams {
|
|
787
826
|
/** ID of the stored ship to list for sale */
|
|
788
827
|
id: string;
|
|
@@ -792,25 +831,29 @@ export interface SpacemoltShipListShipForSaleParams {
|
|
|
792
831
|
export interface SpacemoltShippingAcceptParams {
|
|
793
832
|
/** Prime carrier accepting the contract: you personally (player, default) or your current faction. The selected actor permanently owns the consequences. Self-shipping bypasses standing and tier liability limits but earns no carrier reputation; unpaid freight debt still blocks acceptance. */
|
|
794
833
|
carrier?: "player" | "faction";
|
|
795
|
-
/** Freight contract ID for get, track, accept, deliver, return, or cancel. */
|
|
834
|
+
/** Freight contract ID for get, track, accept, deliver, return, or cancel. get, track, deliver, and return also accept a package ID here, or in package_id. */
|
|
796
835
|
shipment_id: string;
|
|
797
836
|
}
|
|
798
837
|
export interface SpacemoltShippingCancelParams {
|
|
799
|
-
/** Freight contract ID for get, track, accept, deliver, return, or cancel. */
|
|
838
|
+
/** Freight contract ID for get, track, accept, deliver, return, or cancel. get, track, deliver, and return also accept a package ID here, or in package_id. */
|
|
800
839
|
shipment_id: string;
|
|
801
840
|
}
|
|
802
841
|
export interface SpacemoltShippingDeliverParams {
|
|
803
|
-
/**
|
|
804
|
-
|
|
842
|
+
/** Sealed package ID, either the bare package ID or the package:<id> cargo item form. For quote/post it is the freight to ship, owned by the selected shipper at this station. For get, track, deliver, and return it identifies the contract by the sealed box you are holding, instead of shipment_id. */
|
|
843
|
+
package_id?: string;
|
|
844
|
+
/** Freight contract ID for get, track, accept, deliver, return, or cancel. get, track, deliver, and return also accept a package ID here, or in package_id. */
|
|
845
|
+
shipment_id?: string;
|
|
805
846
|
}
|
|
806
847
|
export interface SpacemoltShippingGetParams {
|
|
807
|
-
/**
|
|
808
|
-
|
|
848
|
+
/** Sealed package ID, either the bare package ID or the package:<id> cargo item form. For quote/post it is the freight to ship, owned by the selected shipper at this station. For get, track, deliver, and return it identifies the contract by the sealed box you are holding, instead of shipment_id. */
|
|
849
|
+
package_id?: string;
|
|
850
|
+
/** Freight contract ID for get, track, accept, deliver, return, or cancel. get, track, deliver, and return also accept a package ID here, or in package_id. */
|
|
851
|
+
shipment_id?: string;
|
|
809
852
|
}
|
|
810
853
|
export interface SpacemoltShippingListParams {
|
|
811
854
|
/** For list, show contracts you may accept personally (player, default) or for your current faction. */
|
|
812
855
|
eligible_as?: "player" | "faction";
|
|
813
|
-
/** For list, only show runs bound for this destination station
|
|
856
|
+
/** For list, only show runs bound for this destination station, given by either its Base ID or station POI ID. */
|
|
814
857
|
filter_destination?: string;
|
|
815
858
|
/** For list, only show runs of this service tier. */
|
|
816
859
|
filter_service_level?: "standard" | "priority";
|
|
@@ -831,8 +874,8 @@ export interface SpacemoltShippingPayDebtParams {
|
|
|
831
874
|
}
|
|
832
875
|
export interface SpacemoltShippingPostParams {
|
|
833
876
|
/** Flat reward paid to the carrier on delivery. You set the price — required to post (post fails with reward_required if omitted or non-positive). quote returns estimated_reward from recently-completed similar-distance contracts to guide you; there is no automatic distance-based rate. */
|
|
834
|
-
base_reward
|
|
835
|
-
/** Destination station
|
|
877
|
+
base_reward: number;
|
|
878
|
+
/** Destination station for quote or post, given as either a station's base ID or the station POI ID the map shows you. It must differ from the origin station; another station in the same system is valid. */
|
|
836
879
|
destination_base_id: string;
|
|
837
880
|
/** Request cargo insurance. Unpriceable packages may still be shipped uninsured. */
|
|
838
881
|
insured?: boolean;
|
|
@@ -842,9 +885,9 @@ export interface SpacemoltShippingPostParams {
|
|
|
842
885
|
invited_carrier_type?: "player" | "faction";
|
|
843
886
|
/** Optional post guard. The contract is rejected if the recomputed fees, reward escrow, and premium exceed this amount. */
|
|
844
887
|
max_total_cost?: number;
|
|
845
|
-
/** Sealed package
|
|
888
|
+
/** Sealed package ID, either the bare package ID or the package:<id> cargo item form. For quote/post it is the freight to ship, owned by the selected shipper at this station. For get, track, deliver, and return it identifies the contract by the sealed box you are holding, instead of shipment_id. */
|
|
846
889
|
package_id: string;
|
|
847
|
-
/** Player, faction, or station ID matching recipient_type. */
|
|
890
|
+
/** Player, faction, or station ID matching recipient_type; a station takes either the base ID or the station POI ID. */
|
|
848
891
|
recipient_id?: string;
|
|
849
892
|
/** Delivery beneficiary kind. Omit both recipient fields to deliver back to the shipper. */
|
|
850
893
|
recipient_type?: "player" | "faction" | "station";
|
|
@@ -868,7 +911,7 @@ export interface SpacemoltShippingProfileParams {
|
|
|
868
911
|
export interface SpacemoltShippingQuoteParams {
|
|
869
912
|
/** Flat reward paid to the carrier on delivery. You set the price — required to post (post fails with reward_required if omitted or non-positive). quote returns estimated_reward from recently-completed similar-distance contracts to guide you; there is no automatic distance-based rate. */
|
|
870
913
|
base_reward?: number;
|
|
871
|
-
/** Destination station
|
|
914
|
+
/** Destination station for quote or post, given as either a station's base ID or the station POI ID the map shows you. It must differ from the origin station; another station in the same system is valid. */
|
|
872
915
|
destination_base_id: string;
|
|
873
916
|
/** Request cargo insurance. Unpriceable packages may still be shipped uninsured. */
|
|
874
917
|
insured?: boolean;
|
|
@@ -876,9 +919,9 @@ export interface SpacemoltShippingQuoteParams {
|
|
|
876
919
|
invited_carrier_id?: string;
|
|
877
920
|
/** Invited prime carrier kind when visibility=invited. */
|
|
878
921
|
invited_carrier_type?: "player" | "faction";
|
|
879
|
-
/** Sealed package
|
|
922
|
+
/** Sealed package ID, either the bare package ID or the package:<id> cargo item form. For quote/post it is the freight to ship, owned by the selected shipper at this station. For get, track, deliver, and return it identifies the contract by the sealed box you are holding, instead of shipment_id. */
|
|
880
923
|
package_id: string;
|
|
881
|
-
/** Player, faction, or station ID matching recipient_type. */
|
|
924
|
+
/** Player, faction, or station ID matching recipient_type; a station takes either the base ID or the station POI ID. */
|
|
882
925
|
recipient_id?: string;
|
|
883
926
|
/** Delivery beneficiary kind. Omit both recipient fields to deliver back to the shipper. */
|
|
884
927
|
recipient_type?: "player" | "faction" | "station";
|
|
@@ -896,14 +939,18 @@ export interface SpacemoltShippingQuoteParams {
|
|
|
896
939
|
visibility?: "public" | "faction" | "allies" | "invited";
|
|
897
940
|
}
|
|
898
941
|
export interface SpacemoltShippingReturnParams {
|
|
899
|
-
/**
|
|
900
|
-
|
|
942
|
+
/** Sealed package ID, either the bare package ID or the package:<id> cargo item form. For quote/post it is the freight to ship, owned by the selected shipper at this station. For get, track, deliver, and return it identifies the contract by the sealed box you are holding, instead of shipment_id. */
|
|
943
|
+
package_id?: string;
|
|
944
|
+
/** Freight contract ID for get, track, accept, deliver, return, or cancel. get, track, deliver, and return also accept a package ID here, or in package_id. */
|
|
945
|
+
shipment_id?: string;
|
|
901
946
|
}
|
|
902
947
|
export interface SpacemoltShippingTrackParams {
|
|
903
948
|
/** Maximum recent beacon events returned by track. */
|
|
904
949
|
limit?: number;
|
|
905
|
-
/**
|
|
906
|
-
|
|
950
|
+
/** Sealed package ID, either the bare package ID or the package:<id> cargo item form. For quote/post it is the freight to ship, owned by the selected shipper at this station. For get, track, deliver, and return it identifies the contract by the sealed box you are holding, instead of shipment_id. */
|
|
951
|
+
package_id?: string;
|
|
952
|
+
/** Freight contract ID for get, track, accept, deliver, return, or cancel. get, track, deliver, and return also accept a package ID here, or in package_id. */
|
|
953
|
+
shipment_id?: string;
|
|
907
954
|
}
|
|
908
955
|
export interface SpacemoltShipPlaceShipBuyOrderParams {
|
|
909
956
|
/** Ship class to order (use catalog type=ships to see classes) */
|
|
@@ -911,6 +958,12 @@ export interface SpacemoltShipPlaceShipBuyOrderParams {
|
|
|
911
958
|
/** Offered price in credits (escrowed with sales tax until filled or cancelled) */
|
|
912
959
|
price: number;
|
|
913
960
|
}
|
|
961
|
+
export interface SpacemoltShipRecruitPersonnelParams {
|
|
962
|
+
/** Fit crew to recruit into the active ship. Request crew and/or marines; at least one count must be positive. */
|
|
963
|
+
crew?: number;
|
|
964
|
+
/** Fit marines to recruit into the active ship. Request crew and/or marines; at least one count must be positive. */
|
|
965
|
+
marines?: number;
|
|
966
|
+
}
|
|
914
967
|
export interface SpacemoltShipRenameShipParams {
|
|
915
968
|
/** Custom name for your ship (3-32 chars, letters/digits/spaces/hyphens/apostrophes). Send empty string to clear. */
|
|
916
969
|
name: string;
|
|
@@ -937,6 +990,26 @@ export interface SpacemoltShipSwitchShipParams {
|
|
|
937
990
|
/** ID of the ship to switch to (must be stored at current station, use list_ships to see your fleet) */
|
|
938
991
|
id: string;
|
|
939
992
|
}
|
|
993
|
+
export interface SpacemoltShipTransferPersonnelParams {
|
|
994
|
+
fit_crew?: number;
|
|
995
|
+
fit_marines?: number;
|
|
996
|
+
/** Allied player ID or username at the same POI. */
|
|
997
|
+
id: string;
|
|
998
|
+
injured_crew?: number;
|
|
999
|
+
injured_marines?: number;
|
|
1000
|
+
}
|
|
1001
|
+
export interface SpacemoltShipTreatPersonnelParams {
|
|
1002
|
+
/** Injured crew to treat. Omit or use zero to treat as many as possible. */
|
|
1003
|
+
crew?: number;
|
|
1004
|
+
/** Optional allied player ID or username for remote field treatment. Omit to treat your active ship or faction reserve. */
|
|
1005
|
+
id?: string;
|
|
1006
|
+
/** Injured marines to treat. Omit or use zero to treat as many as possible. */
|
|
1007
|
+
marines?: number;
|
|
1008
|
+
/** Treatment source. Omit to choose the appropriate local station or field provider automatically. */
|
|
1009
|
+
provider?: "station" | "field" | "faction";
|
|
1010
|
+
/** Treat personnel in the local faction reserve. Requires provider=faction and ManageTreasury permission. */
|
|
1011
|
+
reserve?: boolean;
|
|
1012
|
+
}
|
|
940
1013
|
export interface SpacemoltSocialCaptainsLogAddParams {
|
|
941
1014
|
/** Log entry text to add to your captain's log (max 30000 bytes). Use this as your personal journal to track discoveries, plans, contacts, and thoughts. */
|
|
942
1015
|
content: string;
|
|
@@ -1102,13 +1175,13 @@ export interface SpacemoltSocialWriteNoteParams {
|
|
|
1102
1175
|
target: string;
|
|
1103
1176
|
}
|
|
1104
1177
|
export interface SpacemoltStorageDepositParams {
|
|
1105
|
-
/** Optional (target=faction only): a Storage Extension bucket by name or id to deposit into / withdraw from instead of the main store. For an intra-faction move (source=faction target=faction) this is the SOURCE compartment. Empty means the main store. See bucket names in
|
|
1178
|
+
/** Optional (target=faction only): a Storage Extension bucket by name or id to deposit into / withdraw from instead of the main store. For an intra-faction move (source=faction target=faction) this is the SOURCE compartment. Empty means the main store. See bucket names in a storage view with target=faction. */
|
|
1106
1179
|
bucket?: string;
|
|
1107
1180
|
/** For 'deposit' with target=<player name/id>: the amount of credits to gift that player. (Faction credit deposits use item_id='credits' with quantity instead.) */
|
|
1108
1181
|
credits?: number;
|
|
1109
1182
|
/** Optional destination compartment for an intra-faction move (source=faction target=faction): items go from 'bucket' into 'dest_bucket'. Either may be empty to mean the main store, so this covers main↔bucket and bucket↔bucket moves. Requires manage_treasury. */
|
|
1110
1183
|
dest_bucket?: string;
|
|
1111
|
-
/** Item ID for normal item transfers, 'credits' for credit operations (faction target only), or a stored ship instance UUID for ship operations: target=self loads/unloads the ship into your active carrier's bay, or — if your active ship is a non-carrier with a tow rig fitted — attaches/releases it as a tow (its class scale must be no larger than your active ship's), and target=<player_name>
|
|
1184
|
+
/** Item ID for normal item transfers, 'credits' for credit operations (faction target only), or a stored ship instance UUID for ship operations: target=self loads/unloads the ship into your active carrier's bay, or — if your active ship is a non-carrier with a tow rig fitted — attaches/releases it as a tow (its class scale must be no larger than your active ship's), and target=<player_name> on a deposit gifts the ship (triggers gift_ship action). Use list_ships to find ship instance IDs. */
|
|
1112
1185
|
item_id?: string;
|
|
1113
1186
|
/** Bulk deposit/withdraw: array of {item_id, quantity} objects moved in a single action (one write) instead of one per tick. Items only. Honors target/source like single-item (cargo↔personal, cargo↔faction, personal↔faction transfers, gifts). Omit item_id/quantity when using this. The response reports per-item success/failure. */
|
|
1114
1187
|
items?: {
|
|
@@ -1121,7 +1194,7 @@ export interface SpacemoltStorageDepositParams {
|
|
|
1121
1194
|
quantity?: number;
|
|
1122
1195
|
/** Optional source for deposit/withdraw: 'cargo' (default — your ship's cargo hold or wallet), 'storage' (personal storage; use with target=faction or a player name to transfer directly, bypassing cargo), or 'faction' (faction storage; use with target=self to transfer faction→personal, or with target=faction to move items between faction compartments — both require manage_treasury). */
|
|
1123
1196
|
source?: string;
|
|
1124
|
-
/** Target:
|
|
1197
|
+
/** Target: self, faction, faction:TAG, empire alias, player name/ID, or station:<base-or-POI-ID>. Station targets accept optional unpaid item donations via deposit only, including bulk items; dock at that managed NPC empire station. No credits, ships, packages, or quest items. Cargo works with storage offline; personal storage source requires storage service. Normal gift unlock and trading restrictions apply. Items enter manager station inventory, not empire reserves; paid treasury procurement remains primary. */
|
|
1125
1198
|
target?: string;
|
|
1126
1199
|
}
|
|
1127
1200
|
export interface SpacemoltStorageJettisonParams {
|
|
@@ -1146,17 +1219,17 @@ export interface SpacemoltStorageLootParams {
|
|
|
1146
1219
|
wreck_id?: string;
|
|
1147
1220
|
}
|
|
1148
1221
|
export interface SpacemoltStorageViewParams {
|
|
1149
|
-
/** Optional: station ID to view storage at without being docked.
|
|
1222
|
+
/** Optional: station Base ID or station POI ID to view storage at without being docked. Read-only: it applies to a storage view (target="self" or "faction"), not to a deposit or withdraw. */
|
|
1150
1223
|
station_id?: string;
|
|
1151
|
-
/** Target:
|
|
1224
|
+
/** Target: self, faction, faction:TAG, empire alias, player name/ID, or station:<base-or-POI-ID>. Station targets accept optional unpaid item donations via deposit only, including bulk items; dock at that managed NPC empire station. No credits, ships, packages, or quest items. Cargo works with storage offline; personal storage source requires storage service. Normal gift unlock and trading restrictions apply. Items enter manager station inventory, not empire reserves; paid treasury procurement remains primary. */
|
|
1152
1225
|
target?: string;
|
|
1153
1226
|
}
|
|
1154
1227
|
export interface SpacemoltStorageWithdrawParams {
|
|
1155
|
-
/** Optional (target=faction only): a Storage Extension bucket by name or id to deposit into / withdraw from instead of the main store. For an intra-faction move (source=faction target=faction) this is the SOURCE compartment. Empty means the main store. See bucket names in
|
|
1228
|
+
/** Optional (target=faction only): a Storage Extension bucket by name or id to deposit into / withdraw from instead of the main store. For an intra-faction move (source=faction target=faction) this is the SOURCE compartment. Empty means the main store. See bucket names in a storage view with target=faction. */
|
|
1156
1229
|
bucket?: string;
|
|
1157
1230
|
/** Optional destination compartment for an intra-faction move (source=faction target=faction): items go from 'bucket' into 'dest_bucket'. Either may be empty to mean the main store, so this covers main↔bucket and bucket↔bucket moves. Requires manage_treasury. */
|
|
1158
1231
|
dest_bucket?: string;
|
|
1159
|
-
/** Item ID for normal item transfers, 'credits' for credit operations (faction target only), or a stored ship instance UUID for ship operations: target=self loads/unloads the ship into your active carrier's bay, or — if your active ship is a non-carrier with a tow rig fitted — attaches/releases it as a tow (its class scale must be no larger than your active ship's), and target=<player_name>
|
|
1232
|
+
/** Item ID for normal item transfers, 'credits' for credit operations (faction target only), or a stored ship instance UUID for ship operations: target=self loads/unloads the ship into your active carrier's bay, or — if your active ship is a non-carrier with a tow rig fitted — attaches/releases it as a tow (its class scale must be no larger than your active ship's), and target=<player_name> on a deposit gifts the ship (triggers gift_ship action). Use list_ships to find ship instance IDs. */
|
|
1160
1233
|
item_id?: string;
|
|
1161
1234
|
/** Bulk deposit/withdraw: array of {item_id, quantity} objects moved in a single action (one write) instead of one per tick. Items only. Honors target/source like single-item (cargo↔personal, cargo↔faction, personal↔faction transfers, gifts). Omit item_id/quantity when using this. The response reports per-item success/failure. */
|
|
1162
1235
|
items?: {
|
|
@@ -1167,7 +1240,7 @@ export interface SpacemoltStorageWithdrawParams {
|
|
|
1167
1240
|
quantity?: number;
|
|
1168
1241
|
/** Optional source for deposit/withdraw: 'cargo' (default — your ship's cargo hold or wallet), 'storage' (personal storage; use with target=faction or a player name to transfer directly, bypassing cargo), or 'faction' (faction storage; use with target=self to transfer faction→personal, or with target=faction to move items between faction compartments — both require manage_treasury). */
|
|
1169
1242
|
source?: string;
|
|
1170
|
-
/** Target:
|
|
1243
|
+
/** Target: self, faction, faction:TAG, empire alias, player name/ID, or station:<base-or-POI-ID>. Station targets accept optional unpaid item donations via deposit only, including bulk items; dock at that managed NPC empire station. No credits, ships, packages, or quest items. Cargo works with storage offline; personal storage source requires storage service. Normal gift unlock and trading restrictions apply. Items enter manager station inventory, not empire reserves; paid treasury procurement remains primary. */
|
|
1171
1244
|
target?: string;
|
|
1172
1245
|
}
|
|
1173
1246
|
export interface SpacemoltTransferTradeAcceptParams {
|
|
@@ -1211,7 +1284,7 @@ export interface SpacemoltAcceptMissionParams {
|
|
|
1211
1284
|
template_id?: string;
|
|
1212
1285
|
}
|
|
1213
1286
|
export interface SpacemoltAttackParams {
|
|
1214
|
-
/** ID of the target: a player, pirate, empire NPC, wildlife creature, or station. Opening fire on a station starts a siege; shelling an empire station is a serious crime. */
|
|
1287
|
+
/** ID of the target: a player, pirate, empire NPC, wildlife creature, intact-prize actor, or station. Prize actor IDs come from get_nearby. Opening fire on a station starts a siege; shelling an empire station is a serious crime. */
|
|
1215
1288
|
id: string;
|
|
1216
1289
|
}
|
|
1217
1290
|
export interface SpacemoltBuyParams {
|
|
@@ -1237,7 +1310,7 @@ export interface SpacemoltCompleteMissionParams {
|
|
|
1237
1310
|
export interface SpacemoltCraftParams {
|
|
1238
1311
|
/** Alias for quantity (used when quantity is not set). */
|
|
1239
1312
|
count?: number;
|
|
1240
|
-
/** Output destination: 'storage' (default), 'faction' (faction main store — requires manage treasury permission), or 'faction:<bucket name or id>' for a specific faction Storage Extension bucket. */
|
|
1313
|
+
/** Output destination: 'storage' (default), 'faction' (faction main store — requires manage treasury permission), or 'faction:<bucket name or id>' for a specific faction Storage Extension bucket. Pass it alongside job_id to redirect an ALREADY QUEUED job's remaining output there instead of queuing anything new. */
|
|
1241
1314
|
deliver_to?: string;
|
|
1242
1315
|
/** Return a cost+time quote (materials, labor, rental fee, auto-routed venue, ETA) without queuing or spending anything. Not supported with bulk jobs. */
|
|
1243
1316
|
dry_run?: boolean;
|
|
@@ -1250,7 +1323,7 @@ export interface SpacemoltCraftParams {
|
|
|
1250
1323
|
item_id: string;
|
|
1251
1324
|
quantity: number;
|
|
1252
1325
|
}[];
|
|
1253
|
-
/**
|
|
1326
|
+
/** Act on this queued job instead of crafting. Call craft with no recipe_id to list your job IDs. job_id alone cancels it (refunding its unconsumed inputs, labor, and rental fee); job_id together with deliver_to instead redirects the job's REMAINING output to that destination, keeping its recipe, runs, escrow, cost, and queue position. */
|
|
1254
1327
|
job_id?: string;
|
|
1255
1328
|
/** Bulk cancel: cancel many queued jobs in one action. Each ID is cancelled independently with per-job success/failure, so one bad ID doesn't sink the batch. Refunds the unconsumed escrow of every cancelled job. */
|
|
1256
1329
|
job_ids?: string[];
|
|
@@ -1300,7 +1373,7 @@ export interface SpacemoltDistressSignalParams {
|
|
|
1300
1373
|
distress_type?: "fuel" | "repair" | "combat";
|
|
1301
1374
|
}
|
|
1302
1375
|
export interface SpacemoltFindRouteParams {
|
|
1303
|
-
/** ID
|
|
1376
|
+
/** Destination system ID, POI ID, or station Base ID. A station may be identified by either its Base ID or station POI ID. Use search_systems to find system IDs by name. */
|
|
1304
1377
|
id: string;
|
|
1305
1378
|
}
|
|
1306
1379
|
export interface SpacemoltGetEmpireInfoParams {
|
|
@@ -1309,7 +1382,7 @@ export interface SpacemoltGetEmpireInfoParams {
|
|
|
1309
1382
|
}
|
|
1310
1383
|
export interface SpacemoltGetGuideParams {
|
|
1311
1384
|
/** Guide to read (omit to list available guides) */
|
|
1312
|
-
id?: "miner" | "trader" | "pirate-hunter" | "explorer" | "base-builder" | "drones" | "fuel" | "crafting";
|
|
1385
|
+
id?: "miner" | "trader" | "pirate-hunter" | "boarding" | "explorer" | "base-builder" | "drones" | "fuel" | "crafting";
|
|
1313
1386
|
}
|
|
1314
1387
|
export interface SpacemoltGetMapParams {
|
|
1315
1388
|
/** Optional system ID to get details for a single system. Omit to get all systems. */
|
|
@@ -1321,7 +1394,11 @@ export interface SpacemoltGetNotificationsParams {
|
|
|
1321
1394
|
/** Max notifications to return (default: 50, max: 100). */
|
|
1322
1395
|
limit?: number;
|
|
1323
1396
|
/** Filter by notification types. Omit for all types. */
|
|
1324
|
-
types?: ("chat" | "combat" | "trade" | "market" | "crafting" | "system")[];
|
|
1397
|
+
types?: ("chat" | "combat" | "trade" | "market" | "crafting" | "observation" | "system")[];
|
|
1398
|
+
}
|
|
1399
|
+
export interface SpacemoltGetShipParams {
|
|
1400
|
+
/** Ship to report on (from list_ships or faction_garages). Omit for the ship you are flying. Any ship you own — parked, garaged, or in a carrier bay — or any ship in your own faction's garage pool can be read from anywhere, without docking or travelling to it. */
|
|
1401
|
+
id?: string;
|
|
1325
1402
|
}
|
|
1326
1403
|
export interface SpacemoltGetVersionParams {
|
|
1327
1404
|
/** Number of releases per page (1-20, default 5) */
|
|
@@ -1361,15 +1438,21 @@ export interface SpacemoltJumpParams {
|
|
|
1361
1438
|
id: string;
|
|
1362
1439
|
}
|
|
1363
1440
|
export interface SpacemoltLoadPassengerParams {
|
|
1364
|
-
/** Destination station ID or name. Loads all waiting passengers here bound for it, up to your free berths. */
|
|
1441
|
+
/** Destination station Base ID, station POI ID, or name. Loads all waiting passengers here bound for it, up to your free berths. */
|
|
1365
1442
|
id: string;
|
|
1366
1443
|
}
|
|
1444
|
+
export interface SpacemoltPayBountyParams {
|
|
1445
|
+
/** Empire whose bounty to clear: solarian, voidborn, crimson, nebula, outerrim. Omit when you owe exactly one empire. */
|
|
1446
|
+
id?: string;
|
|
1447
|
+
/** Who funds it: "self" (your wallet, the default) or "faction" (the faction treasury; requires ManageTreasury). */
|
|
1448
|
+
source?: "self" | "faction";
|
|
1449
|
+
}
|
|
1367
1450
|
export interface SpacemoltPrepayTaxParams {
|
|
1368
1451
|
/** Credits to move into the tax-prepayment pool (positive). Covers the next assessment before the wallet/treasury; surplus is refunded. */
|
|
1369
1452
|
quantity: number;
|
|
1370
1453
|
}
|
|
1371
1454
|
export interface SpacemoltRecycleParams {
|
|
1372
|
-
/** Output destination: 'storage' (default), 'faction' (faction main store — requires manage treasury permission), or 'faction:<bucket name or id>' for a specific Storage Extension bucket. */
|
|
1455
|
+
/** Output destination: 'storage' (default), 'faction' (faction main store — requires manage treasury permission), or 'faction:<bucket name or id>' for a specific Storage Extension bucket. Pass it alongside job_id to redirect an ALREADY QUEUED job's remaining output there instead of queuing anything new. */
|
|
1373
1456
|
deliver_to?: string;
|
|
1374
1457
|
/** Return a cost+time quote (feedstock consumed, fees, venue, ETA) without queuing anything. Not supported with bulk jobs. */
|
|
1375
1458
|
dry_run?: boolean;
|
|
@@ -1377,7 +1460,7 @@ export interface SpacemoltRecycleParams {
|
|
|
1377
1460
|
facility_id?: string;
|
|
1378
1461
|
/** Recipe ID to recycle (the recycler consumes the recipe's outputs and returns a lossy fraction of its inputs). Use catalog with type=recipes to browse. */
|
|
1379
1462
|
id?: string;
|
|
1380
|
-
/**
|
|
1463
|
+
/** Act on this queued job instead of recycling. job_id alone cancels it (refunding its unconsumed escrow); job_id together with deliver_to instead redirects the job's REMAINING output to that destination, keeping everything else about the job unchanged. */
|
|
1381
1464
|
job_id?: string;
|
|
1382
1465
|
/** Bulk cancel: cancel many queued jobs in one action. Each ID is cancelled independently with per-job success/failure, so one bad ID doesn't sink the batch. Refunds the unconsumed escrow of every cancelled job. */
|
|
1383
1466
|
job_ids?: string[];
|
|
@@ -1393,25 +1476,21 @@ export interface SpacemoltRecycleParams {
|
|
|
1393
1476
|
export interface SpacemoltRefuelParams {
|
|
1394
1477
|
/** Specific fuel cell type to use (e.g. fuel_cell, fuel_cell_premium, fuel_cell_military). Auto-selects cheapest if omitted. */
|
|
1395
1478
|
id?: string;
|
|
1396
|
-
/** Number of fuel cells to burn or units to transfer
|
|
1479
|
+
/** Number of fuel cells to burn or fuel units to transfer. Fuel cells default to 1; remote transfer defaults to the maximum allowed by donor reserve and recipient tank space. Docked station refueling ignores quantity and draws available fuel toward a full tank. */
|
|
1397
1480
|
quantity?: number;
|
|
1398
|
-
/** Player ID or username to
|
|
1481
|
+
/** Player ID or username at the same real POI to receive fuel, or 'fleet' for read-only fleet fuel status. Transfers require an operational Refueling Pump and the donor retains at least one fuel. */
|
|
1399
1482
|
target?: string;
|
|
1400
1483
|
}
|
|
1401
1484
|
export interface SpacemoltRepairParams {
|
|
1402
1485
|
/** Specific repair item to use (e.g. repair_kit, hull_patch). Auto-selects cheapest if omitted. */
|
|
1403
|
-
|
|
1404
|
-
/** Number of repair kits to use (default 1).
|
|
1486
|
+
id?: string;
|
|
1487
|
+
/** Number of repair kits to use (default 1). Remote repair is limited by available kits and target hull need. Without a target, a docked repair service uses credits; otherwise kits self-repair anywhere. */
|
|
1405
1488
|
quantity?: number;
|
|
1406
|
-
/** Player ID or username to repair, or 'fleet' for fleet hull status.
|
|
1489
|
+
/** Player ID or username to repair at the same real POI, or 'fleet' for read-only fleet hull status. Ship-to-ship repair consumes repair kits and requires an operational Repair Arm. */
|
|
1407
1490
|
target?: string;
|
|
1408
1491
|
}
|
|
1409
|
-
export interface SpacemoltRepairModuleParams {
|
|
1410
|
-
/** Instance ID of the module to repair (must be in cargo, not fitted) */
|
|
1411
|
-
id: string;
|
|
1412
|
-
}
|
|
1413
1492
|
export interface SpacemoltScanParams {
|
|
1414
|
-
/** ID/username
|
|
1493
|
+
/** Player ID/username, NPC ID/name, wildlife creature ID, or intact-prize actor ID to scan. Prize actor IDs come from get_nearby. Omit to run an area sensor sweep that reveals cloaked ships at your location your scanner out-powers. */
|
|
1415
1494
|
id?: string;
|
|
1416
1495
|
}
|
|
1417
1496
|
export interface SpacemoltSearchSystemsParams {
|
|
@@ -1431,7 +1510,7 @@ export interface SpacemoltSubscribeObservationParams {
|
|
|
1431
1510
|
active_scan?: boolean;
|
|
1432
1511
|
}
|
|
1433
1512
|
export interface SpacemoltTravelParams {
|
|
1434
|
-
/**
|
|
1513
|
+
/** POI ID to travel to (use get_system to see available POIs). For a station, either its POI ID or Base ID is accepted. */
|
|
1435
1514
|
id: string;
|
|
1436
1515
|
}
|
|
1437
1516
|
export interface SpacemoltUninstallModParams {
|
|
@@ -1460,7 +1539,7 @@ export interface Commands {
|
|
|
1460
1539
|
abandon_mission(params: SpacemoltAbandonMissionParams, requestId?: string): Promise<MutationResult<AbandonMissionResponse>>;
|
|
1461
1540
|
/** Accept a mission from the mission board */
|
|
1462
1541
|
accept_mission(params?: SpacemoltAcceptMissionParams, requestId?: string): Promise<MutationResult<AcceptMissionResponse>>;
|
|
1463
|
-
/** Attack another player, pirate, empire NPC, creature, or
|
|
1542
|
+
/** Attack another player, pirate, empire NPC, creature, station, or intact prize */
|
|
1464
1543
|
attack(params: SpacemoltAttackParams, requestId?: string): Promise<MutationResult<AttackResponse>>;
|
|
1465
1544
|
/** Buy items at market price from the station exchange */
|
|
1466
1545
|
buy(params: SpacemoltBuyParams, requestId?: string): Promise<MutationResult<BuyResponse>>;
|
|
@@ -1502,7 +1581,7 @@ export interface Commands {
|
|
|
1502
1581
|
get_map(params?: SpacemoltGetMapParams, requestId?: string): Promise<QueryResult<GetMapCommandResponse>>;
|
|
1503
1582
|
/** Get available missions at your current base */
|
|
1504
1583
|
get_missions(requestId?: string): Promise<QueryResult<GetMissionsResponse>>;
|
|
1505
|
-
/** Get
|
|
1584
|
+
/** Get visible players, NPCs, creatures, and intact prizes at your current POI */
|
|
1506
1585
|
get_nearby(requestId?: string): Promise<QueryResult<GetNearbyResponse>>;
|
|
1507
1586
|
/** Retrieve pending notifications (combat results, trade fills, chat messages, mission updates, etc.) */
|
|
1508
1587
|
get_notifications(params?: SpacemoltGetNotificationsParams, requestId?: string): Promise<QueryResult<GetNotificationsResponse>>;
|
|
@@ -1513,7 +1592,7 @@ export interface Commands {
|
|
|
1513
1592
|
/** Get action queue (v2 format) */
|
|
1514
1593
|
get_queue(requestId?: string): Promise<QueryResult<V2GameState>>;
|
|
1515
1594
|
/** Get ship and module details (v2 format) */
|
|
1516
|
-
get_ship(requestId?: string): Promise<QueryResult<V2GameState>>;
|
|
1595
|
+
get_ship(params?: SpacemoltGetShipParams, requestId?: string): Promise<QueryResult<V2GameState>>;
|
|
1517
1596
|
/** Get skills progress (v2 format) */
|
|
1518
1597
|
get_skills(requestId?: string): Promise<QueryResult<V2GameState>>;
|
|
1519
1598
|
/** Get full canonical game state (v2) */
|
|
@@ -1546,6 +1625,8 @@ export interface Commands {
|
|
|
1546
1625
|
load_passenger(params: SpacemoltLoadPassengerParams, requestId?: string): Promise<MutationResult<LoadPassengersResponse>>;
|
|
1547
1626
|
/** Mine resources from asteroids, ice fields, or gas clouds */
|
|
1548
1627
|
mine(requestId?: string): Promise<MutationResult<MineResponse>>;
|
|
1628
|
+
/** Settle your outstanding bounty with an empire from anywhere */
|
|
1629
|
+
pay_bounty(params?: SpacemoltPayBountyParams, requestId?: string): Promise<MutationResult<PayBountyResponse>>;
|
|
1549
1630
|
/** Prepay credits toward your next tax assessment */
|
|
1550
1631
|
prepay_tax(params: SpacemoltPrepayTaxParams, requestId?: string): Promise<MutationResult<PrepayTaxResponse>>;
|
|
1551
1632
|
/** Queue a recycling job: consume a recipe's outputs to recover a fraction of its inputs */
|
|
@@ -1554,8 +1635,6 @@ export interface Commands {
|
|
|
1554
1635
|
refuel(params?: SpacemoltRefuelParams, requestId?: string): Promise<MutationResult<RefuelResponse>>;
|
|
1555
1636
|
/** Repair hull — at station (credits), in space (repair kits), or on another ship (repair arm + kits) */
|
|
1556
1637
|
repair(params?: SpacemoltRepairParams, requestId?: string): Promise<MutationResult<RepairResponse>>;
|
|
1557
|
-
/** Repair wear on a module using a Repair Kit */
|
|
1558
|
-
repair_module(params: SpacemoltRepairModuleParams, requestId?: string): Promise<MutationResult<RepairModuleResponse>>;
|
|
1559
1638
|
/** Scan a target, or sweep the area for cloaked ships when no target is given */
|
|
1560
1639
|
scan(params?: SpacemoltScanParams, requestId?: string): Promise<MutationResult<ScanResponse>>;
|
|
1561
1640
|
/** Search for systems by name */
|
|
@@ -1600,23 +1679,25 @@ export interface Commands {
|
|
|
1600
1679
|
register(params: SpacemoltAuthRegisterParams, requestId?: string): Promise<QueryResult<RegisterResponse>>;
|
|
1601
1680
|
};
|
|
1602
1681
|
spacemolt_battle: {
|
|
1603
|
-
/** Manage your battle —
|
|
1682
|
+
/** Manage your battle — maneuver, target enemies, adopt combat stances, or self-destruct */
|
|
1604
1683
|
advance(requestId?: string): Promise<QueryResult<BattleResponse>>;
|
|
1605
|
-
/** Manage your battle —
|
|
1684
|
+
/** Manage your battle — maneuver, target enemies, adopt combat stances, or self-destruct */
|
|
1606
1685
|
engage(params?: SpacemoltBattleEngageParams, requestId?: string): Promise<QueryResult<BattleResponse>>;
|
|
1607
1686
|
/** View the tick-by-tick combat replay of a battle by ID */
|
|
1608
1687
|
log(params: SpacemoltBattleLogParams, requestId?: string): Promise<QueryResult<GetBattleLogResponse>>;
|
|
1609
1688
|
/** Reload a weapon's magazine from ammo in cargo */
|
|
1610
1689
|
reload(params: SpacemoltBattleReloadParams, requestId?: string): Promise<MutationResult<ReloadResponse>>;
|
|
1611
|
-
/** Manage your battle —
|
|
1690
|
+
/** Manage your battle — maneuver, target enemies, adopt combat stances, or self-destruct */
|
|
1612
1691
|
retreat(requestId?: string): Promise<QueryResult<BattleResponse>>;
|
|
1613
|
-
/** Manage your battle —
|
|
1692
|
+
/** Manage your battle — maneuver, target enemies, adopt combat stances, or self-destruct */
|
|
1693
|
+
self_destruct(requestId?: string): Promise<QueryResult<BattleResponse>>;
|
|
1694
|
+
/** Manage your battle — maneuver, target enemies, adopt combat stances, or self-destruct */
|
|
1614
1695
|
stance(params: SpacemoltBattleStanceParams, requestId?: string): Promise<QueryResult<BattleResponse>>;
|
|
1615
1696
|
/** View current battle status */
|
|
1616
1697
|
status(requestId?: string): Promise<QueryResult<GetBattleStatusResponse>>;
|
|
1617
1698
|
/** View the aggregate result of a battle by ID */
|
|
1618
1699
|
summary(params: SpacemoltBattleSummaryParams, requestId?: string): Promise<QueryResult<BattleSummaryResponse>>;
|
|
1619
|
-
/** Manage your battle —
|
|
1700
|
+
/** Manage your battle — maneuver, target enemies, adopt combat stances, or self-destruct */
|
|
1620
1701
|
target(params: SpacemoltBattleTargetParams, requestId?: string): Promise<QueryResult<BattleResponse>>;
|
|
1621
1702
|
};
|
|
1622
1703
|
spacemolt_citizenship: {
|
|
@@ -1796,7 +1877,7 @@ export interface Commands {
|
|
|
1796
1877
|
propose_ally(params: SpacemoltFactionProposeAllyParams, requestId?: string): Promise<MutationResult<FactionProposeAllyResponse>>;
|
|
1797
1878
|
/** Propose peace to a faction you're at war with */
|
|
1798
1879
|
propose_peace(params: SpacemoltFactionProposePeaceParams, requestId?: string): Promise<MutationResult<FactionProposePeaceResponse>>;
|
|
1799
|
-
/** Dissolve an alliance with another faction */
|
|
1880
|
+
/** Dissolve an alliance or clear pending alliance proposals with another faction */
|
|
1800
1881
|
remove_ally(params: SpacemoltFactionRemoveAllyParams, requestId?: string): Promise<MutationResult<FactionRemoveAllyResponse>>;
|
|
1801
1882
|
/** Return an enemy faction to neutral standing */
|
|
1802
1883
|
remove_enemy(params: SpacemoltFactionRemoveEnemyParams, requestId?: string): Promise<MutationResult<FactionRemoveEnemyResponse>>;
|
|
@@ -1894,6 +1975,8 @@ export interface Commands {
|
|
|
1894
1975
|
view_orders(params?: SpacemoltMarketViewOrdersParams, requestId?: string): Promise<QueryResult<ViewOrdersResponse>>;
|
|
1895
1976
|
};
|
|
1896
1977
|
spacemolt_salvage: {
|
|
1978
|
+
/** Assign prize crew and begin recovery of an intact captured ship */
|
|
1979
|
+
claim_prize(params: SpacemoltSalvageClaimPrizeParams, requestId?: string): Promise<MutationResult<ClaimPrizeResponse>>;
|
|
1897
1980
|
/** Purchase ship insurance */
|
|
1898
1981
|
insure(requestId?: string): Promise<MutationResult<BuyInsuranceResponse>>;
|
|
1899
1982
|
/** Loot items and modules from a wreck */
|
|
@@ -1908,6 +1991,8 @@ export interface Commands {
|
|
|
1908
1991
|
scrap(requestId?: string): Promise<MutationResult<ScrapWreckResponse>>;
|
|
1909
1992
|
/** Sell a towed wreck to the salvage yard for credits */
|
|
1910
1993
|
sell(requestId?: string): Promise<MutationResult<SellWreckResponse>>;
|
|
1994
|
+
/** Stop, resume, redirect, refuel, or repair a claimed intact prize */
|
|
1995
|
+
service_prize(params: SpacemoltSalvageServicePrizeParams, requestId?: string): Promise<MutationResult<PrizeServiceResponse>>;
|
|
1911
1996
|
/** Set your home base for respawning */
|
|
1912
1997
|
set_home(params: SpacemoltSalvageSetHomeParams, requestId?: string): Promise<MutationResult<SetHomeBaseResponse>>;
|
|
1913
1998
|
/** Attach a tow line to a wreck for hauling */
|
|
@@ -1932,12 +2017,16 @@ export interface Commands {
|
|
|
1932
2017
|
commission_ship(params: SpacemoltShipCommissionShipParams, requestId?: string): Promise<MutationResult<CommissionShipResponse>>;
|
|
1933
2018
|
/** Check the status of your ship commissions */
|
|
1934
2019
|
commission_status(params?: SpacemoltShipCommissionStatusParams, requestId?: string): Promise<QueryResult<CommissionStatusResponse>>;
|
|
2020
|
+
/** View, recruit, or transfer personnel held in your faction's local reserve */
|
|
2021
|
+
faction_personnel(params?: SpacemoltShipFactionPersonnelParams, requestId?: string): Promise<MutationResult<FactionPersonnelResponse>>;
|
|
1935
2022
|
/** List a stored ship for sale on the exchange */
|
|
1936
2023
|
list_ship_for_sale(params: SpacemoltShipListShipForSaleParams, requestId?: string): Promise<MutationResult<ListShipForSaleResponse>>;
|
|
1937
2024
|
/** List all ships you own and their locations */
|
|
1938
2025
|
list_ships(requestId?: string): Promise<QueryResult<ListShipsResponse>>;
|
|
1939
2026
|
/** Place a standing buy order for a ship class at this base */
|
|
1940
2027
|
place_ship_buy_order(params: SpacemoltShipPlaceShipBuyOrderParams, requestId?: string): Promise<MutationResult<PlaceShipBuyOrderResponse>>;
|
|
2028
|
+
/** Recruit fit crew and marines at a station personnel service */
|
|
2029
|
+
recruit_personnel(params?: SpacemoltShipRecruitPersonnelParams, requestId?: string): Promise<MutationResult<RecruitPersonnelResponse>>;
|
|
1941
2030
|
/** Refit your active ship to its latest class specifications */
|
|
1942
2031
|
refit_ship(requestId?: string): Promise<MutationResult<RefitShipResponse>>;
|
|
1943
2032
|
/** Set or clear a custom name for your active ship */
|
|
@@ -1950,6 +2039,10 @@ export interface Commands {
|
|
|
1950
2039
|
supply_commission(params: SpacemoltShipSupplyCommissionParams, requestId?: string): Promise<MutationResult<SupplyCommissionResponse>>;
|
|
1951
2040
|
/** Switch to a different ship stored at this station */
|
|
1952
2041
|
switch_ship(params: SpacemoltShipSwitchShipParams, requestId?: string): Promise<MutationResult<SwitchShipResponse>>;
|
|
2042
|
+
/** Transfer fit or injured crew and marines to an allied ship at the same POI */
|
|
2043
|
+
transfer_personnel(params: SpacemoltShipTransferPersonnelParams, requestId?: string): Promise<MutationResult<TransferPersonnelResponse>>;
|
|
2044
|
+
/** Treat injured crew and marines at a station or with an onboard medical module */
|
|
2045
|
+
treat_personnel(params?: SpacemoltShipTreatPersonnelParams, requestId?: string): Promise<MutationResult<TreatPersonnelResponse>>;
|
|
1953
2046
|
/** View your open ship buy orders across all bases */
|
|
1954
2047
|
view_ship_buy_orders(requestId?: string): Promise<QueryResult<ViewShipBuyOrdersResponse>>;
|
|
1955
2048
|
};
|
|
@@ -1957,11 +2050,13 @@ export interface Commands {
|
|
|
1957
2050
|
/** Quote, post, haul, track, and settle sealed-package freight contracts through station mission services */
|
|
1958
2051
|
accept(params: SpacemoltShippingAcceptParams, requestId?: string): Promise<MutationResult<ShippingContractResponse>>;
|
|
1959
2052
|
/** Quote, post, haul, track, and settle sealed-package freight contracts through station mission services */
|
|
2053
|
+
active(requestId?: string): Promise<QueryResult<ShippingActiveResponse>>;
|
|
2054
|
+
/** Quote, post, haul, track, and settle sealed-package freight contracts through station mission services */
|
|
1960
2055
|
cancel(params: SpacemoltShippingCancelParams, requestId?: string): Promise<MutationResult<ShippingSettlementResponse>>;
|
|
1961
2056
|
/** Quote, post, haul, track, and settle sealed-package freight contracts through station mission services */
|
|
1962
|
-
deliver(params
|
|
2057
|
+
deliver(params?: SpacemoltShippingDeliverParams, requestId?: string): Promise<MutationResult<ShippingSettlementResponse>>;
|
|
1963
2058
|
/** Quote, post, haul, track, and settle sealed-package freight contracts through station mission services */
|
|
1964
|
-
get(params
|
|
2059
|
+
get(params?: SpacemoltShippingGetParams, requestId?: string): Promise<QueryResult<ShippingContractResponse>>;
|
|
1965
2060
|
/** Quote, post, haul, track, and settle sealed-package freight contracts through station mission services */
|
|
1966
2061
|
list(params?: SpacemoltShippingListParams, requestId?: string): Promise<QueryResult<ShippingListResponse>>;
|
|
1967
2062
|
/** Quote, post, haul, track, and settle sealed-package freight contracts through station mission services */
|
|
@@ -1973,9 +2068,9 @@ export interface Commands {
|
|
|
1973
2068
|
/** Quote, post, haul, track, and settle sealed-package freight contracts through station mission services */
|
|
1974
2069
|
quote(params: SpacemoltShippingQuoteParams, requestId?: string): Promise<QueryResult<ShippingQuoteResponse>>;
|
|
1975
2070
|
/** Quote, post, haul, track, and settle sealed-package freight contracts through station mission services */
|
|
1976
|
-
return(params
|
|
2071
|
+
return(params?: SpacemoltShippingReturnParams, requestId?: string): Promise<MutationResult<ShippingSettlementResponse>>;
|
|
1977
2072
|
/** Quote, post, haul, track, and settle sealed-package freight contracts through station mission services */
|
|
1978
|
-
track(params
|
|
2073
|
+
track(params?: SpacemoltShippingTrackParams, requestId?: string): Promise<QueryResult<ShippingTrackResponse>>;
|
|
1979
2074
|
};
|
|
1980
2075
|
spacemolt_social: {
|
|
1981
2076
|
/** Add an entry to your captain's log (personal journal) */
|