@spacemolt/lib 16.4.0 → 16.6.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.
@@ -1386,7 +1386,7 @@ export type BoardingStateLogEntry = {
1386
1386
  */
1387
1387
  phase: 'latching' | 'assault' | 'withdrawing' | 'resolved' | 'self_destruct';
1388
1388
  /**
1389
- * Why the event fired, when the event alone is ambiguous. boarding_rejected carries either a validation reason or contested_same_tick when deterministic boarding initiative selected another eligible request sharing either hull. self_destruct_canceled may carry battle_ended when combat ending cleared the countdown. Omitted otherwise.
1389
+ * Why the event fired, when the event alone is ambiguous. boarding_rejected carries either a validation reason or contested_same_tick when deterministic boarding initiative selected another eligible request sharing either hull. self_destruct_canceled may carry battle_ended when combat ending cleared the countdown. plundered carries surrendered when the target's crew gave up because no fit marine was left aboard, at latch or when its last marine fell; that ship keeps its surviving crew. Captures never surrender. Omitted otherwise.
1390
1390
  */
1391
1391
  reason?: string;
1392
1392
  /**
@@ -1694,7 +1694,7 @@ export type BulkSellOrderResult = {
1694
1694
  total_earned?: number;
1695
1695
  };
1696
1696
  /**
1697
- * The single-item storage response for this entry (deposit, withdraw, gift, or faction/empire variant). Successful station gifts use action=send_gift and canonical recipient=station:<base ID>; remaining source inventory reflects the completed bulk batch, including zero.
1697
+ * The single-item storage response for this entry (deposit, withdraw, gift, or faction/empire variant). Successful station gifts use action=send_gift and canonical recipient=station:<base ID>; remaining source inventory reflects the completed bulk batch, including zero. An entry never carries goodwill: a bulk station gift reports it once on the parent response.
1698
1698
  */
1699
1699
  export type BulkStorageItemData = {
1700
1700
  [key: string]: unknown;
@@ -1723,7 +1723,7 @@ export type BulkStorageResponse = {
1723
1723
  dest_bucket_id?: string;
1724
1724
  failed: number;
1725
1725
  /**
1726
- * How the empire or pirate crew received this gift: value to them, bounty paid, reputation change and their reply. Present on gifts to empires, NPC empire stations and pirate strongholds; omitted for gifts to players, factions and the fixer.
1726
+ * How the empire or pirate crew received a bulk station:<base ID> gift: one result for all items delivered in the batch. Omitted when no item was delivered and for every other bulk target. Per-item results never carry goodwill.
1727
1727
  */
1728
1728
  goodwill?: GiftGoodwill;
1729
1729
  requested: number;
@@ -1804,11 +1804,18 @@ export type BuyResponse = {
1804
1804
  xp_gained?: number;
1805
1805
  };
1806
1806
  export type CancelCommissionResponse = {
1807
+ /**
1808
+ * The caller's wallet balance after the cancel. It includes the refund only when refunded_to is the caller.
1809
+ */
1807
1810
  credits_total: number;
1808
1811
  materials_note?: string;
1809
1812
  materials_returned?: Array<CargoItem>;
1810
1813
  message: string;
1811
1814
  refund: number;
1815
+ /**
1816
+ * Who received the credit refund: the username of the player who placed the commission (not always the caller: a ManageBases member can cancel a capital mobile base for the faction), or for a faction-funded commission the name of the faction whose treasury received it.
1817
+ */
1818
+ refunded_to: string;
1812
1819
  };
1813
1820
  export type CancelOrderCommandResponse = ({
1814
1821
  kind: 'single';
@@ -1926,41 +1933,133 @@ export type CargoItem = {
1926
1933
  size?: number;
1927
1934
  };
1928
1935
  export type CarrierCapacity = {
1929
- active_contract_limit?: number;
1936
+ /**
1937
+ * Number of in_transit contracts the carrier holds. Same as the profile's active_contracts.
1938
+ */
1930
1939
  active_contracts: number;
1940
+ /**
1941
+ * Always true: the number of contracts a carrier can hold has no cap. Only liability is limited.
1942
+ */
1931
1943
  active_contracts_unlimited: boolean;
1944
+ /**
1945
+ * Sum in credits of reserved_exposure over the carrier's in_transit contracts.
1946
+ */
1932
1947
  active_liability: number;
1948
+ /**
1949
+ * Largest active_liability in credits the carrier can reach by accepting: 50000 probationary, 100000 licensed, 1000000 trusted. Absent for prime (no limit).
1950
+ */
1933
1951
  aggregate_liability_limit?: number;
1952
+ /**
1953
+ * True for a prime carrier. The liability limits are then absent.
1954
+ */
1934
1955
  liability_unlimited: boolean;
1956
+ /**
1957
+ * aggregate_liability_limit - active_liability, never below 0. Absent for prime.
1958
+ */
1935
1959
  remaining_aggregate_liability?: number;
1960
+ /**
1961
+ * Largest reserved_exposure in credits one accepted contract can have at this tier: 25000 probationary, 50000 licensed, 500000 trusted. Absent for prime (no limit).
1962
+ */
1936
1963
  single_package_liability_limit?: number;
1937
1964
  };
1938
1965
  export type CarrierProfile = {
1966
+ /**
1967
+ * Number of in_transit contracts this carrier holds.
1968
+ */
1939
1969
  active_contracts: number;
1970
+ /**
1971
+ * Sum in credits of reserved_exposure over those in_transit contracts.
1972
+ */
1940
1973
  active_liability: number;
1974
+ /**
1975
+ * The player or faction this freight-carrier record belongs to. One record per carrier across the whole galaxy.
1976
+ */
1941
1977
  actor: ShipmentActor;
1978
+ /**
1979
+ * Count of contracts that ended breached.
1980
+ */
1942
1981
  breaches: number;
1982
+ /**
1983
+ * Count of contracts that ended defaulted.
1984
+ */
1943
1985
  defaults: number;
1986
+ /**
1987
+ * Sum in credits of appraised_value over those deliveries.
1988
+ */
1944
1989
  delivered_value: number;
1990
+ /**
1991
+ * Time of the newest late delivery, late return, breach or default. Absent when there has been none.
1992
+ */
1945
1993
  last_consequence_at?: string;
1994
+ /**
1995
+ * Time a debt payment last brought outstanding_debt to 0. Absent when that has never happened.
1996
+ */
1946
1997
  last_recovery_at?: string;
1998
+ /**
1999
+ * Count of deliveries made after deadline_tick but inside the recovery window.
2000
+ */
1947
2001
  late_deliveries: number;
2002
+ /**
2003
+ * Sum in credits of outstanding over this carrier's freight debts. While positive the carrier cannot accept any contract.
2004
+ */
1948
2005
  outstanding_debt: number;
2006
+ /**
2007
+ * How many of those deliveries were priority service delivered at or before target_tick.
2008
+ */
1949
2009
  priority_deliveries: number;
2010
+ /**
2011
+ * Count of packages handed back to the shipper at the origin, on time or late.
2012
+ */
1950
2013
  returns: number;
2014
+ /**
2015
+ * Count of on-time deliveries with reputation_eligible true.
2016
+ */
1951
2017
  successful_deliveries: number;
2018
+ /**
2019
+ * Carrier standing. It sets which risk_band the carrier can accept and its liability limits. An on-time reputation-eligible delivery raises it when both thresholds are met: licensed 5 deliveries and 250 credits delivered, trusted 20 and 250000, prime 50 and 2000000. Each breach or default drops it one tier. A new carrier starts probationary.
2020
+ */
1952
2021
  tier: 'probationary' | 'licensed' | 'trusted' | 'prime';
2022
+ /**
2023
+ * Time the record last changed.
2024
+ */
1953
2025
  updated_at: string;
1954
2026
  };
1955
2027
  export type CarrierTierProgress = {
2028
+ /**
2029
+ * True at prime. The required and remaining fields are then 0.
2030
+ */
1956
2031
  at_maximum_tier: boolean;
2032
+ /**
2033
+ * The carrier's tier now.
2034
+ */
1957
2035
  current_tier: 'probationary' | 'licensed' | 'trusted' | 'prime';
2036
+ /**
2037
+ * The profile's delivered_value in credits.
2038
+ */
1958
2039
  delivered_value: number;
2040
+ /**
2041
+ * The tier one step above current_tier. Absent at prime.
2042
+ */
1959
2043
  next_tier?: 'licensed' | 'trusted' | 'prime';
2044
+ /**
2045
+ * required_delivered_value - delivered_value, never below 0. Promotion needs both remainders at 0 and happens on the next on-time reputation-eligible delivery. After a demotion both can already be 0.
2046
+ */
1960
2047
  remaining_delivered_value: number;
2048
+ /**
2049
+ * required_successful_deliveries - successful_deliveries, never below 0. 0 means the threshold is met.
2050
+ */
1961
2051
  remaining_successful_deliveries: number;
2052
+ /**
2053
+ * delivered_value in credits needed for next_tier: 250 for licensed, 250000 for trusted, 2000000 for prime. 0 at prime.
2054
+ */
1962
2055
  required_delivered_value: number;
2056
+ /**
2057
+ * successful_deliveries needed for next_tier: 5 for licensed, 20 for trusted, 50 for prime. 0 at prime.
2058
+ */
1963
2059
  required_successful_deliveries: number;
2060
+ /**
2061
+ * The profile's successful_deliveries.
2062
+ */
1964
2063
  successful_deliveries: number;
1965
2064
  };
1966
2065
  export type CatalogAchievement = {
@@ -2670,23 +2769,71 @@ export type CraftQuoteResponse = {
2670
2769
  venue_type: string;
2671
2770
  };
2672
2771
  export type CraftingDeposit = {
2772
+ /**
2773
+ * Item ID of the deposited item. A sealed package has a package item ID.
2774
+ */
2673
2775
  item_id: string;
2776
+ /**
2777
+ * Display name of the deposited item.
2778
+ */
2674
2779
  item_name: string;
2780
+ /**
2781
+ * Units of this item deposited this tick.
2782
+ */
2675
2783
  quantity: number;
2676
2784
  };
2677
2785
  export type CraftingJobUpdate = {
2786
+ /**
2787
+ * True when this tick finished the job's last run. No more updates follow for this job.
2788
+ */
2678
2789
  completed: boolean;
2790
+ /**
2791
+ * Items this job deposited this tick. Sorted by item_name.
2792
+ */
2679
2793
  deposited: Array<CraftingDeposit>;
2794
+ /**
2795
+ * Credits still prepaid on the job: labor plus the rental fee for an external job.
2796
+ */
2680
2797
  escrowed_credits: number;
2798
+ /**
2799
+ * True when this job rents a facility you do not own. Omitted when false.
2800
+ */
2681
2801
  external?: boolean;
2802
+ /**
2803
+ * Job ID. The same ID that the job queue listing shows.
2804
+ */
2682
2805
  job_id: string;
2683
- mode: string;
2806
+ /**
2807
+ * craft or recycle for a recipe job. pack or unpack for a package job.
2808
+ */
2809
+ mode: 'craft' | 'recycle' | 'pack' | 'unpack';
2810
+ /**
2811
+ * ID of the output package a packaged craft sealed on completion. Set only then.
2812
+ */
2684
2813
  output_package_id?: string;
2814
+ /**
2815
+ * Label of the output package a packaged craft sealed on completion. Set only then.
2816
+ */
2685
2817
  output_package_label?: string;
2818
+ /**
2819
+ * Display name of the job's recipe, not the recipe ID you passed to craft. For a package pack or unpack job it is the package label, or Package when the package has no label.
2820
+ */
2686
2821
  recipe: string;
2822
+ /**
2823
+ * Runs completed this tick (not the job total).
2824
+ */
2687
2825
  runs_done: number;
2826
+ /**
2827
+ * Runs still queued on the job. 0 when the job is completed.
2828
+ */
2688
2829
  runs_remaining: number;
2830
+ /**
2831
+ * Where the output landed: station or faction or cargo. A package job can report cargo+station when its cargo overflowed into station storage.
2832
+ */
2689
2833
  storage: string;
2834
+ /**
2835
+ * Display name of the venue: Station Workshop or the facility type name.
2836
+ */
2690
2837
  venue: string;
2691
2838
  };
2692
2839
  export type CreateBuyOrderCommandResponse = ({
@@ -3044,6 +3191,9 @@ export type DroneInfo = {
3044
3191
  type: string;
3045
3192
  };
3046
3193
  export type EmpireGiftResponse = {
3194
+ /**
3195
+ * Donation to an empire named by an empire alias target: empire_gift_credits (credits wired to the treasury from anywhere), empire_gift_items (cargo given to the quartermaster at one of its stations with storage service) or empire_gift_ship (a ship parked at the empire station where you are docked, seated in the empire's Reserve fleet, scrapped if it is a starter ship, or destroyed for flagship_bounty if it is a pirate boss's flagship). A station:<base ID> donation returns SendGiftResponse instead, even at an empire station.
3196
+ */
3047
3197
  action: 'empire_gift_credits' | 'empire_gift_items' | 'empire_gift_ship';
3048
3198
  /**
3049
3199
  * True when the engine docked you automatically before running this command, because the command requires being docked. Omitted when no automatic dock happened.
@@ -3061,26 +3211,81 @@ export type EmpireGiftResponse = {
3061
3211
  * Name of base_id. Omitted with it for a remote credit wire.
3062
3212
  */
3063
3213
  base_name?: string;
3214
+ /**
3215
+ * Units of item_id left in your cargo after the donation. Set on empire_gift_items only; omitted when zero.
3216
+ */
3064
3217
  cargo_remaining?: number;
3218
+ /**
3219
+ * Ship class of the donated ship. Set on empire_gift_ship only.
3220
+ */
3065
3221
  class_id?: string;
3222
+ /**
3223
+ * Display name of class_id. Set on empire_gift_ship only.
3224
+ */
3066
3225
  class_name?: string;
3226
+ /**
3227
+ * Credits moved from your wallet to the empire treasury. Set on empire_gift_credits only.
3228
+ */
3067
3229
  credits_sent?: number;
3230
+ /**
3231
+ * Empire that received the donation (e.g. solarian).
3232
+ */
3068
3233
  empire_id: string;
3234
+ /**
3235
+ * Display name of empire_id.
3236
+ */
3069
3237
  empire_name: string;
3238
+ /**
3239
+ * Credits the empire paid you for a pirate boss's stolen flagship (a flat 1000000), added to your wallet on top of the normal donation goodwill and counted as taxable ship_sale income. The empire destroys the hull. Set on empire_gift_ship only when the donated ship was a boss flagship; omitted otherwise. Less than the flat amount only if your wallet hit the credit cap.
3240
+ */
3241
+ flagship_bounty?: number;
3242
+ /**
3243
+ * The empire's shared Reserve fleet that the ship joined. Every ship donated to one empire reports the same fleet_id. Omitted when a starter ship is scrapped or a boss flagship is destroyed instead.
3244
+ */
3070
3245
  fleet_id?: string;
3246
+ /**
3247
+ * Display name of fleet_id. Omitted with it.
3248
+ */
3071
3249
  fleet_name?: string;
3072
3250
  /**
3073
- * How the empire or pirate crew received this gift: value to them, bounty paid, reputation change and their reply. Present on gifts to empires, NPC empire stations and pirate strongholds; omitted for gifts to players, factions and the fixer.
3251
+ * How the empire received this donation: value to them, bounty paid, reputation change and their reply. Present on every empire donation except a starter ship, which is scrapped and earns nothing.
3074
3252
  */
3075
3253
  goodwill?: GiftGoodwill;
3254
+ /**
3255
+ * Designation the empire gave the hull in its Reserve roster. Omitted when a starter ship is scrapped or a boss flagship is destroyed instead.
3256
+ */
3076
3257
  hull_designator?: string;
3258
+ /**
3259
+ * Donated item ID. Set on empire_gift_items only.
3260
+ */
3077
3261
  item_id?: string;
3262
+ /**
3263
+ * Your donation note; omitted when empty. When a donated starter ship is scrapped or a boss flagship is destroyed it is the empire's reply instead.
3264
+ */
3078
3265
  message?: string;
3266
+ /**
3267
+ * Empire NPC pilot seated on the donated ship, unique to this donation. Omitted when a starter ship is scrapped or a boss flagship is destroyed instead.
3268
+ */
3079
3269
  npc_id?: string;
3270
+ /**
3271
+ * ID of the automated donation notice filed with the empire's leadership. Omitted when a starter ship is scrapped or a boss flagship is destroyed.
3272
+ */
3080
3273
  petition_id?: string;
3274
+ /**
3275
+ * Full text of that donation notice. Omitted with petition_id.
3276
+ */
3081
3277
  petition_notice?: string;
3278
+ /**
3279
+ * Units of item_id donated. Set on empire_gift_items only.
3280
+ */
3082
3281
  quantity?: number;
3282
+ /**
3283
+ * ID of the donated ship. Set on empire_gift_ship only.
3284
+ */
3083
3285
  ship_id?: string;
3286
+ /**
3287
+ * Your wallet after the credit donation. Set on empire_gift_credits only; omitted when zero.
3288
+ */
3084
3289
  wallet_remaining?: number;
3085
3290
  };
3086
3291
  export type EmpireNpcInfo = {
@@ -3101,7 +3306,9 @@ export type EmpireNpcInfo = {
3101
3306
  };
3102
3307
  export type EmpirePolicySnapshot = {
3103
3308
  bounty_attack: number;
3309
+ bounty_hold: number;
3104
3310
  bounty_kill: number;
3311
+ bounty_plunder: number;
3105
3312
  bounty_rep_restoration_bps: number;
3106
3313
  bounty_rep_restoration_cap: number;
3107
3314
  citizenship_auto_approve: boolean;
@@ -3132,7 +3339,9 @@ export type EmpirePolicySnapshot = {
3132
3339
  rep_baseline_outsider: number;
3133
3340
  rep_decay_amount: number;
3134
3341
  rep_penalty_attack: number;
3342
+ rep_penalty_hold: number;
3135
3343
  rep_penalty_kill: number;
3344
+ rep_penalty_plunder: number;
3136
3345
  rep_trade_fill_cap: number;
3137
3346
  rep_trade_fill_divisor: number;
3138
3347
  repair_cost_per_hull: number;
@@ -3299,6 +3508,9 @@ export type FacilityDefSummary = {
3299
3508
  faction_service?: string;
3300
3509
  labor_cost: number;
3301
3510
  level: number;
3511
+ /**
3512
+ * Item stock this facility type must hold each facility cycle (100 ticks) to count as fully supplied, plus fuel drawn from the station tank as a fuel line. Omitted when the type has no upkeep. For a market that uses trade_authenticator (such as trade_concourse), the trade_authenticator quantity adds a charge that grows with the docked station's recent market trade volume and burns in full each cycle.
3513
+ */
3302
3514
  maintenance_per_cycle?: Array<ItemQuantity>;
3303
3515
  name: string;
3304
3516
  recipe_id?: string;
@@ -3429,7 +3641,7 @@ export type FacilityEntry = {
3429
3641
  */
3430
3642
  damaged?: boolean;
3431
3643
  /**
3432
- * Flavor text. For a facility with upkeep it adds a satisfied or degraded line that matches maintenance_satisfied. An owner-written description replaces the text, and a disguised facility seen from outside shows its cover description. Can be an empty string.
3644
+ * Flavor text. For a facility with upkeep it adds a satisfied or degraded line that matches maintenance_satisfied. A per-facility description replaces the text, and a disguised facility seen from outside shows its cover description. Can be an empty string.
3433
3645
  */
3434
3646
  description: string;
3435
3647
  /**
@@ -3493,7 +3705,7 @@ export type FacilityEntry = {
3493
3705
  */
3494
3706
  maintenance_level?: number;
3495
3707
  /**
3496
- * Item stock this station-run facility must hold each facility cycle (100 ticks) to count as fully supplied. Present only for fleet depots and dining/leisure venues (tourism_upkeep); omitted otherwise. A tourism venue's figure scales with recent paying footfall and never drops below 15 percent of its declared menu (at least one of each item); it burns its paying guests' share of its declared menu — about the whole listed stock in a busy cycle and nothing in a cycle no guest paid for.
3708
+ * Item stock this facility must hold each facility cycle (100 ticks) to count as fully supplied. Present only for fleet depots, dining/leisure venues (tourism_upkeep) and markets that use trade_authenticator (such as trade_concourse); omitted otherwise. A market's trade_authenticator quantity is its declared stock plus a charge that grows with this station's recent market trade volume; the market burns that charge in full each cycle, and on a player station it goes offline when faction storage cannot cover the whole quantity. A tourism venue's figure scales with recent paying footfall and never drops below 15 percent of its declared menu (at least one of each item); it burns its paying guests' share of its declared menu — about the whole listed stock in a busy cycle and nothing in a cycle no guest paid for.
3497
3709
  */
3498
3710
  maintenance_per_cycle?: Array<ItemQuantity>;
3499
3711
  /**
@@ -3930,6 +4142,9 @@ export type FacilityTypeDetailResponse = {
3930
4142
  labor_cost: number;
3931
4143
  level: number;
3932
4144
  lore?: string;
4145
+ /**
4146
+ * Item stock this facility type must hold each facility cycle (100 ticks) to count as fully supplied, plus fuel drawn from the station tank as a fuel line. Omitted when the type has no upkeep. For a market that uses trade_authenticator (such as trade_concourse), the trade_authenticator quantity adds a charge that grows with the docked station's recent market trade volume and burns in full each cycle.
4147
+ */
3933
4148
  maintenance_per_cycle?: Array<ItemQuantity>;
3934
4149
  name: string;
3935
4150
  personal_service?: string;
@@ -4222,9 +4437,11 @@ export type FactionEditRoleUpdates = {
4222
4437
  permissions?: FactionCreateRolePermissions;
4223
4438
  };
4224
4439
  export type FactionEditUpdates = {
4440
+ ally_battle_opt_out?: boolean;
4225
4441
  ally_facility_access?: boolean;
4226
4442
  ally_fuel_access?: boolean;
4227
4443
  ally_intel_opt_out?: boolean;
4444
+ ally_shipyard_access?: boolean;
4228
4445
  charter?: string;
4229
4446
  description?: string;
4230
4447
  primary_color?: string;
@@ -4242,7 +4459,13 @@ export type FactionFacilityPresence = {
4242
4459
  export type FactionFuelBunker = {
4243
4460
  base_id: string;
4244
4461
  base_name?: string;
4462
+ /**
4463
+ * Fuel capacity. At the faction's own station this is the shared station tank capacity.
4464
+ */
4245
4465
  fuel_capacity: number;
4466
+ /**
4467
+ * Fuel held. At the faction's own station this is the shared station tank.
4468
+ */
4246
4469
  fuel_reserve: number;
4247
4470
  };
4248
4471
  export type FactionGarageStationEntry = {
@@ -4297,9 +4520,11 @@ export type FactionGiftResponse = {
4297
4520
  export type FactionInfoResponse = {
4298
4521
  alliance_proposals?: Array<FactionAllianceProposal>;
4299
4522
  allies?: Array<FactionListItem>;
4523
+ ally_battle_opt_out?: boolean;
4300
4524
  ally_facility_access?: boolean;
4301
4525
  ally_fuel_access?: boolean;
4302
4526
  ally_intel_opt_out?: boolean;
4527
+ ally_shipyard_access?: boolean;
4303
4528
  at_war: boolean;
4304
4529
  charter: string;
4305
4530
  created_at: string;
@@ -4320,8 +4545,17 @@ export type FactionInfoResponse = {
4320
4545
  leader_username: string;
4321
4546
  member_count: number;
4322
4547
  members?: Array<FactionMember>;
4548
+ /**
4549
+ * Member-list pagination: page size used for this response (the limit you passed if 1-100, else 50). This is NOT the faction member cap. Joining a full faction fails with a faction_full error that states the cap.
4550
+ */
4323
4551
  members_limit?: number;
4552
+ /**
4553
+ * Member-list pagination: index of the first member on this page (the offset you passed). Omitted on the first page.
4554
+ */
4324
4555
  members_offset?: number;
4556
+ /**
4557
+ * Member-list pagination: true when more members exist after this page. Request the next page with offset = members_offset + members_limit.
4558
+ */
4325
4559
  members_truncated?: boolean;
4326
4560
  /**
4327
4561
  * Current mobile-base location and movement state. Present only for faction members with a completed mobile base; omitted during construction or after decommissioning.
@@ -4894,6 +5128,58 @@ export type FaintSignature = {
4894
5128
  hint: string;
4895
5129
  type: string;
4896
5130
  };
5131
+ export type FieldJob = {
5132
+ /**
5133
+ * Inputs held for the remaining runs. One entry per item. size is the item's base cargo size. A finished run uses its share; a cancel returns the rest to cargo.
5134
+ */
5135
+ escrow: Array<ShipCargoItem>;
5136
+ /**
5137
+ * Job ID. craft job_id=<id> cancels it.
5138
+ */
5139
+ id: string;
5140
+ /**
5141
+ * Player who queued the job.
5142
+ */
5143
+ initiated_by: string;
5144
+ /**
5145
+ * Fraction of the current run that is done. 0 or more and less than 1.
5146
+ */
5147
+ progress: number;
5148
+ /**
5149
+ * Game tick when the job was queued.
5150
+ */
5151
+ queued_tick: number;
5152
+ /**
5153
+ * Recipe the job crafts.
5154
+ */
5155
+ recipe_id: string;
5156
+ /**
5157
+ * Runs originally ordered.
5158
+ */
5159
+ runs: number;
5160
+ /**
5161
+ * Runs still to produce.
5162
+ */
5163
+ runs_remaining: number;
5164
+ };
5165
+ export type FieldWorkshopView = {
5166
+ /**
5167
+ * Why the queue does not advance. Present only when state is paused. not_active: the ship is not its owner's active ship (parked or in a carrier bay or the pilot switched ships). docked: the pilot is docked. moving: travelling or jumping (including with a fleet). in_battle: the pilot is in a battle. no_crew: the ship has no fit crew. pilot_action: in the most recent tick the pilot ran a command that uses the ship (travel, jump, dock, undock, mine, attack, hunt, scan, cloak, loot_wreck, tow_wreck, release_tow, jettison, install_mod, uninstall_mod, reload, drone commands, survey_system or use_item). cargo_full: no queued job's next run fits in cargo after that run's inputs are used; free cargo space to resume.
5168
+ */
5169
+ pause_reason?: 'not_active' | 'docked' | 'moving' | 'in_battle' | 'no_crew' | 'pilot_action' | 'cargo_full';
5170
+ /**
5171
+ * Number of jobs queued on this ship's Field Workshop. 0 when state is idle. craft with no recipe_id lists them (venue Field Workshop).
5172
+ */
5173
+ queued_jobs: number;
5174
+ /**
5175
+ * Cargo space held by inputs escrowed on this ship's Field Workshop jobs. It is not part of cargo_used but it is not free: free cargo space is cargo_capacity - cargo_used - reserved_cargo. A finished run releases its inputs' share. A cancel returns the inputs to cargo into this space. 0 when no inputs are escrowed.
5176
+ */
5177
+ reserved_cargo: number;
5178
+ /**
5179
+ * idle: no jobs are queued on this ship. running: the queue advances this tick at Station Workshop speed. paused: it does not advance and pause_reason says why. A pause loses nothing: progress and escrowed inputs stay on the jobs.
5180
+ */
5181
+ state: 'idle' | 'running' | 'paused';
5182
+ };
4897
5183
  export type Fill = {
4898
5184
  counterparty?: string;
4899
5185
  price_each: number;
@@ -4915,7 +5201,7 @@ export type FindRouteResponse = {
4915
5201
  */
4916
5202
  fleet_fuel?: Array<FleetMemberFuel>;
4917
5203
  /**
4918
- * True when a route exists, including when you are already in the target system. False means no path was found; route is then null and the fuel fields are 0.
5204
+ * True when a route exists, including when you are already in the target system. False means no path was found; route is then empty and the fuel fields are 0.
4919
5205
  */
4920
5206
  found: boolean;
4921
5207
  /**
@@ -4931,7 +5217,7 @@ export type FindRouteResponse = {
4931
5217
  */
4932
5218
  message: string;
4933
5219
  /**
4934
- * Systems in order from your current system to target_system, both included; see RouteStep. It holds a single step when you are already there. Normal connections and wormholes you know count as one jump each. Null when found is false.
5220
+ * Systems in order from your current system to target_system, both included; see RouteStep. It holds a single step when you are already there. Normal connections and wormholes you know count as one jump each. Empty when found is false.
4935
5221
  */
4936
5222
  route: Array<RouteStep>;
4937
5223
  /**
@@ -4951,93 +5237,237 @@ export type FindRouteResponse = {
4951
5237
  */
4952
5238
  total_jumps: number;
4953
5239
  };
4954
- export type FittedModuleSnapshot = {
4955
- category: string;
4956
- current_ammo?: number;
4957
- loaded_ammo?: string;
4958
- magazine_size?: number;
4959
- name: string;
4960
- };
4961
- export type FixerAccountInfo = {
5240
+ export type FitIssue = {
4962
5241
  /**
4963
- * Maximum unsecured cargo exposure in credits across all fixers. Starts at 2500. Each successful courier delivery adds 250 up to 10000 after 30 deliveries.
5242
+ * The error code install_mod or uninstall_mod returns for the same problem: cpu_exceeded, power_exceeded, no_weapon_slots, no_defense_slots, no_utility_slots, module_limit, module_withdrawn, cargo_capacity_exceeded, personnel_capacity_exceeded, or no_safe_order when the fit is valid but no refit order reaches it
4964
5243
  */
4965
- allowance: number;
5244
+ code: string;
4966
5245
  /**
4967
- * Additional unsecured cargo allowance in credits: max(0, allowance - exposure). Zero means no additional unsecured cargo.
5246
+ * Human-readable explanation with the numbers involved
4968
5247
  */
4969
- available: number;
5248
+ message: string;
5249
+ };
5250
+ export type FitPreviewResponse = {
4970
5251
  /**
4971
- * Unpaid missing courier cargo liability in credits across all fixers. Zero means no outstanding debt. Persists until payment or restitution.
5252
+ * Every reason the planned fit is refused. Empty when valid
4972
5253
  */
4973
- debt: number;
5254
+ issues: Array<FitIssue>;
4974
5255
  /**
4975
- * Debt plus the base value of provided cargo on active courier missions in credits; capped at the credit limit. Expired missions reserve exposure until cleanup. Moving or selling that cargo does not release exposure.
5256
+ * Your active ship, the one the plan is for
4976
5257
  */
4977
- exposure: number;
4978
- };
4979
- export type FleeLogEntry = {
4980
- escaped: boolean;
4981
- flee_counter: number;
4982
- flee_required: number;
4983
- player_id: string;
4984
- };
4985
- export type FleetAcceptResponse = {
4986
- action: 'accept';
4987
- fleet_id: string;
4988
- leader_name: string;
4989
- message: string;
4990
- };
4991
- export type FleetActionResponse = {
4992
- action: 'invite' | 'leave' | 'kick' | 'disband' | 'disembark';
4993
- message: string;
4994
- };
4995
- export type FleetBoardResponse = {
4996
- action: 'board';
4997
- carrier: string;
4998
- carrier_ship_id: string;
4999
- garaged_ship_id: string;
5000
- message: string;
5001
- parked_ship_id: string;
5002
- };
5003
- export type FleetCargoItem = {
5004
- item_id: string;
5005
- name: string;
5006
- quantity: number;
5007
- };
5008
- export type FleetCreateResponse = {
5009
- action: 'create';
5010
- fleet_id: string;
5011
- max_size: number;
5012
- message: string;
5013
- };
5014
- export type FleetDeclineResponse = {
5015
- action: 'decline';
5016
- message: string;
5017
- };
5018
- export type FleetMemberFuel = {
5258
+ ship_id: string;
5019
5259
  /**
5020
- * True when fuel_on_arrival is 0 or more, so the member can finish the route without refueling.
5260
+ * Ship stats with exactly the planned modules fitted. Reported for invalid plans too
5021
5261
  */
5022
- can_complete: boolean;
5262
+ stats: FitPreviewStats;
5023
5263
  /**
5024
- * Fuel this member needs for the whole route: fuel_per_jump times total_jumps.
5264
+ * An order of uninstall_mod and install_mod calls that reaches the planned fit without any call being refused for CPU, power, slots or personnel capacity. Cargo limits are checked against your hold as it is now: modules moving into and out of cargo during the steps are not counted, so keep room in your hold. Run the steps in order, one per tick. Empty when the plan is invalid or already matches the current fit
5025
5265
  */
5026
- estimated_fuel: number;
5266
+ steps: Array<FitPreviewStep>;
5027
5267
  /**
5028
- * Fuel in this member's tank now.
5268
+ * True when the planned fit passes every install_mod and uninstall_mod fit check. Equivalent to issues being empty
5029
5269
  */
5030
- fuel_available: number;
5270
+ valid: boolean;
5271
+ };
5272
+ export type FitPreviewStats = {
5031
5273
  /**
5032
- * Fuel left after the route: fuel_available minus estimated_fuel. Negative means the member runs out on the way.
5274
+ * Armor: class base plus module armor bonuses
5033
5275
  */
5034
- fuel_on_arrival: number;
5276
+ armor: number;
5035
5277
  /**
5036
- * Fuel this member's ship burns per jump with its own bonuses applied; at least 1.
5278
+ * Total cargo space: class base plus module cargo bonuses (negative for modules that shrink the hold)
5037
5279
  */
5038
- fuel_per_jump: number;
5280
+ cargo_capacity: number;
5039
5281
  /**
5040
- * Player ID of the fleet member.
5282
+ * Cargo space your hold uses right now, including field workshop escrow. The plan is invalid (cargo_capacity_exceeded) when this exceeds cargo_capacity and the plan shrinks the hold
5283
+ */
5284
+ cargo_used: number;
5285
+ /**
5286
+ * Total CPU: class base plus module CPU bonuses
5287
+ */
5288
+ cpu_capacity: number;
5289
+ /**
5290
+ * CPU the planned modules consume after your engineering efficiency bonus, as get_ship reports it. Invalid (cpu_exceeded) above cpu_capacity
5291
+ */
5292
+ cpu_used: number;
5293
+ /**
5294
+ * Fit plus injured crew aboard now. Invalid (personnel_capacity_exceeded) above effective_crew_capacity
5295
+ */
5296
+ crew: number;
5297
+ /**
5298
+ * Defense slots on the hull
5299
+ */
5300
+ defense_slots: number;
5301
+ /**
5302
+ * Planned defense modules. Invalid (no_defense_slots) above defense_slots
5303
+ */
5304
+ defense_slots_used: number;
5305
+ /**
5306
+ * Crew capacity: class base plus module crew bonuses
5307
+ */
5308
+ effective_crew_capacity: number;
5309
+ /**
5310
+ * Marine capacity: class base plus module marine bonuses
5311
+ */
5312
+ effective_marine_capacity: number;
5313
+ /**
5314
+ * Fit plus injured marines aboard now. Invalid (personnel_capacity_exceeded) above effective_marine_capacity
5315
+ */
5316
+ marines: number;
5317
+ /**
5318
+ * Fuel tank size: class base plus module fuel bonuses
5319
+ */
5320
+ max_fuel: number;
5321
+ /**
5322
+ * Maximum hull: class base hull plus module hull bonuses minus hull penalties (at least 1)
5323
+ */
5324
+ max_hull: number;
5325
+ /**
5326
+ * Maximum shield: class base plus module shield bonuses
5327
+ */
5328
+ max_shield: number;
5329
+ /**
5330
+ * Total power: class base plus module power bonuses
5331
+ */
5332
+ power_capacity: number;
5333
+ /**
5334
+ * Power the planned modules consume after your engineering efficiency bonus. Invalid (power_exceeded) above power_capacity
5335
+ */
5336
+ power_used: number;
5337
+ /**
5338
+ * Shield recharged per tick: class base plus module recharge bonuses
5339
+ */
5340
+ shield_recharge: number;
5341
+ /**
5342
+ * Base speed: class base plus module speed bonuses minus speed penalties (at least 1). Crew efficiency is not applied; see get_ship operational_speed
5343
+ */
5344
+ speed: number;
5345
+ /**
5346
+ * Utility slots on the hull
5347
+ */
5348
+ utility_slots: number;
5349
+ /**
5350
+ * Planned utility and mining modules. Invalid (no_utility_slots) above utility_slots
5351
+ */
5352
+ utility_slots_used: number;
5353
+ /**
5354
+ * Weapon slots on the hull
5355
+ */
5356
+ weapon_slots: number;
5357
+ /**
5358
+ * Planned weapon modules. Invalid (no_weapon_slots) above weapon_slots
5359
+ */
5360
+ weapon_slots_used: number;
5361
+ };
5362
+ export type FitPreviewStep = {
5363
+ /**
5364
+ * The command to run
5365
+ */
5366
+ action: 'uninstall_mod' | 'install_mod';
5367
+ /**
5368
+ * The id to pass to the command: a fitted module instance ID for uninstall_mod, a module type ID for install_mod (the module must be in your cargo)
5369
+ */
5370
+ module_id: string;
5371
+ /**
5372
+ * Module display name
5373
+ */
5374
+ name: string;
5375
+ /**
5376
+ * True on an uninstall_mod of a module the plan keeps. A later install_mod step fits it again, so keep it in your cargo. Omitted (false) for modules the plan removes
5377
+ */
5378
+ temporary?: boolean;
5379
+ /**
5380
+ * Module type ID
5381
+ */
5382
+ type_id: string;
5383
+ };
5384
+ export type FittedModuleSnapshot = {
5385
+ category: string;
5386
+ current_ammo?: number;
5387
+ loaded_ammo?: string;
5388
+ magazine_size?: number;
5389
+ name: string;
5390
+ };
5391
+ export type FixerAccountInfo = {
5392
+ /**
5393
+ * Maximum unsecured cargo exposure in credits across all fixers. Starts at 2500. Each successful courier delivery adds 250 up to 10000 after 30 deliveries.
5394
+ */
5395
+ allowance: number;
5396
+ /**
5397
+ * Additional unsecured cargo allowance in credits: max(0, allowance - exposure). Zero means no additional unsecured cargo.
5398
+ */
5399
+ available: number;
5400
+ /**
5401
+ * Unpaid missing courier cargo liability in credits across all fixers. Zero means no outstanding debt. Persists until payment or restitution.
5402
+ */
5403
+ debt: number;
5404
+ /**
5405
+ * Debt plus the base value of provided cargo on active courier missions in credits; capped at the credit limit. Expired missions reserve exposure until cleanup. Moving or selling that cargo does not release exposure.
5406
+ */
5407
+ exposure: number;
5408
+ };
5409
+ export type FleeLogEntry = {
5410
+ escaped: boolean;
5411
+ flee_counter: number;
5412
+ flee_required: number;
5413
+ player_id: string;
5414
+ };
5415
+ export type FleetAcceptResponse = {
5416
+ action: 'accept';
5417
+ fleet_id: string;
5418
+ leader_name: string;
5419
+ message: string;
5420
+ };
5421
+ export type FleetActionResponse = {
5422
+ action: 'invite' | 'leave' | 'kick' | 'disband' | 'disembark';
5423
+ message: string;
5424
+ };
5425
+ export type FleetBoardResponse = {
5426
+ action: 'board';
5427
+ carrier: string;
5428
+ carrier_ship_id: string;
5429
+ garaged_ship_id: string;
5430
+ message: string;
5431
+ parked_ship_id: string;
5432
+ };
5433
+ export type FleetCargoItem = {
5434
+ item_id: string;
5435
+ name: string;
5436
+ quantity: number;
5437
+ };
5438
+ export type FleetCreateResponse = {
5439
+ action: 'create';
5440
+ fleet_id: string;
5441
+ max_size: number;
5442
+ message: string;
5443
+ };
5444
+ export type FleetDeclineResponse = {
5445
+ action: 'decline';
5446
+ message: string;
5447
+ };
5448
+ export type FleetMemberFuel = {
5449
+ /**
5450
+ * True when fuel_on_arrival is 0 or more, so the member can finish the route without refueling.
5451
+ */
5452
+ can_complete: boolean;
5453
+ /**
5454
+ * Fuel this member needs for the whole route: fuel_per_jump times total_jumps.
5455
+ */
5456
+ estimated_fuel: number;
5457
+ /**
5458
+ * Fuel in this member's tank now.
5459
+ */
5460
+ fuel_available: number;
5461
+ /**
5462
+ * Fuel left after the route: fuel_available minus estimated_fuel. Negative means the member runs out on the way.
5463
+ */
5464
+ fuel_on_arrival: number;
5465
+ /**
5466
+ * Fuel this member's ship burns per jump with its own bonuses applied; at least 1.
5467
+ */
5468
+ fuel_per_jump: number;
5469
+ /**
5470
+ * Player ID of the fleet member.
5041
5471
  */
5042
5472
  player_id: string;
5043
5473
  /**
@@ -5216,28 +5646,91 @@ export type ForumUpvoteResponse = {
5216
5646
  thread_id?: string;
5217
5647
  };
5218
5648
  export type FreightAppraisalLine = {
5649
+ /**
5650
+ * Appraisal method. Always completed_fill_vwap on an insurable line. Absent when the line is not insurable.
5651
+ */
5219
5652
  basis?: string;
5653
+ /**
5654
+ * Evidence quality. Always useful on an insurable line. Absent when the line is not insurable.
5655
+ */
5220
5656
  confidence?: string;
5657
+ /**
5658
+ * Number of public completed fills behind unit_value. An insurable line needs at least 3. Absent when the line is not insurable.
5659
+ */
5221
5660
  fill_count?: number;
5661
+ /**
5662
+ * True when the market evidence meets every threshold above. The package is insurable only when every line is insurable.
5663
+ */
5222
5664
  insurable: boolean;
5665
+ /**
5666
+ * Item ID of one content line of the sealed package.
5667
+ */
5223
5668
  item_id: string;
5669
+ /**
5670
+ * Time of the most recent fill in that evidence. Absent when the line is not insurable.
5671
+ */
5224
5672
  latest_fill_at?: string;
5673
+ /**
5674
+ * Market window that supplied the evidence: 24h0m0s, 168h0m0s or 720h0m0s. The appraisal tries the shortest window first and uses the first one with enough evidence. Absent when the line is not insurable.
5675
+ */
5225
5676
  lookback?: string;
5677
+ /**
5678
+ * Units of item_id in the package.
5679
+ */
5226
5680
  quantity: number;
5681
+ /**
5682
+ * Appraised credits for the line: unit_value x quantity. 0 when the line is not insurable.
5683
+ */
5227
5684
  total_value: number;
5685
+ /**
5686
+ * Credits traded in those fills. An insurable line needs at least 500. Absent when the line is not insurable.
5687
+ */
5228
5688
  traded_notional?: number;
5689
+ /**
5690
+ * Units traded in those fills. An insurable line needs at least quantity units. Absent when the line is not insurable.
5691
+ */
5229
5692
  traded_units?: number;
5693
+ /**
5694
+ * Why the line failed appraisal. The appraisal stops at the first failing line: later lines that also failed carry insurable false and no reason. Absent on an insurable line.
5695
+ */
5230
5696
  uninsurable_reason?: string;
5697
+ /**
5698
+ * Appraised credits per unit: the volume-weighted average price of public completed exchange fills of this item across the galaxy in the lookback window (floor of total credits / units). Fills priced above the item's 90th-percentile fill price in that window are left out. 0 when the line is not insurable.
5699
+ */
5231
5700
  unit_value: number;
5232
5701
  };
5233
5702
  export type FreightDebt = {
5703
+ /**
5704
+ * Time the debt was created.
5705
+ */
5234
5706
  created_at: string;
5707
+ /**
5708
+ * Who receives repayment. Always the contract's origin station (kind station).
5709
+ */
5235
5710
  creditor: ShipmentActor;
5711
+ /**
5712
+ * The carrier that owes the debt: the contract's contractor.
5713
+ */
5236
5714
  debtor: ShipmentActor;
5715
+ /**
5716
+ * Debt ID: freight:<shipment_id>.
5717
+ */
5237
5718
  id: string;
5719
+ /**
5720
+ * Credits owed when the debt was created. For a breach or default it is the contract's failure_debt. For a late delivery or return it is the late fee: 10% of (base_reward + max_speed_bonus) held between 100 and 2500 credits and never above failure_debt / 2.
5721
+ */
5238
5722
  original: number;
5723
+ /**
5724
+ * Credits still owed. pay_debt pays the oldest debts first. While any debt is outstanding the debtor cannot accept contracts.
5725
+ */
5239
5726
  outstanding: number;
5727
+ /**
5728
+ * Time outstanding reached 0. Absent while the debt is still owed.
5729
+ */
5240
5730
  paid_at?: string;
5731
+ /**
5732
+ * Contract that created the debt.
5733
+ */
5241
5734
  shipment_id: string;
5242
5735
  };
5243
5736
  export type FuelLogEntry = {
@@ -5260,6 +5753,52 @@ export type GaragedShipEntry = {
5260
5753
  depositor_name?: string;
5261
5754
  ship_id: string;
5262
5755
  };
5756
+ export type GeneratorResponse = {
5757
+ /**
5758
+ * True when the engine docked you automatically before running this command, because the command requires being docked. Omitted when no automatic dock happened.
5759
+ */
5760
+ auto_docked?: boolean;
5761
+ /**
5762
+ * True when the engine undocked you automatically before running this command, because the command requires being undocked. Omitted when no automatic undock happened.
5763
+ */
5764
+ auto_undocked?: boolean;
5765
+ /**
5766
+ * Station the generator feeds. After disconnect: the station it fed.
5767
+ */
5768
+ base_id: string;
5769
+ /**
5770
+ * True when the link is active after this command. False after disconnect.
5771
+ */
5772
+ connected: boolean;
5773
+ /**
5774
+ * Tick when the link times out. Present only while connected. Connect again to restart the timer.
5775
+ */
5776
+ end_tick?: number;
5777
+ /**
5778
+ * Fuel burned over the whole link so far. After disconnect: the total for the link.
5779
+ */
5780
+ fuel_burned: number;
5781
+ /**
5782
+ * Ship fuel burned per tick while connected: 1 per operational field generator. 0 after disconnect.
5783
+ */
5784
+ fuel_per_tick: number;
5785
+ /**
5786
+ * Fuel the generator never burns (10% of max fuel). The link ends when the next tick would take the tank below it.
5787
+ */
5788
+ fuel_reserve: number;
5789
+ /**
5790
+ * Human-readable summary.
5791
+ */
5792
+ message: string;
5793
+ /**
5794
+ * Power the generator supplies per tick after the hull bonus and Engineering and crew staffing scale it. The station counts generator power only up to the larger of its installed plant capacity and 20.
5795
+ */
5796
+ output: number;
5797
+ /**
5798
+ * Sum of the per-tick output over the ticks the link ran.
5799
+ */
5800
+ power_delivered: number;
5801
+ };
5263
5802
  /**
5264
5803
  * Command-specific result object. See individual command documentation for field details.
5265
5804
  */
@@ -5289,12 +5828,24 @@ export type GetBaseResponse = {
5289
5828
  base: TrimmedBase;
5290
5829
  condition: StationHealth;
5291
5830
  construction?: StationConstructionResponse;
5831
+ /**
5832
+ * This station's current dining appeal: the sum of its dining venues' points, each scaled by how well its upkeep is supplied. Vacationing citizens who weigh dining pick stations with more of it. Omitted (0) when the station has no working dining venue.
5833
+ */
5834
+ dining_points?: number;
5292
5835
  faction_fuel_capacity?: number;
5293
5836
  faction_fuel_reserve?: number;
5294
5837
  fuel_price?: number;
5295
5838
  fuel_price_all_in?: number;
5296
5839
  fuel_tax_per_unit?: number;
5840
+ /**
5841
+ * This station's current leisure appeal: the sum of its leisure venues' points, each scaled by how well its upkeep is supplied. Vacationing citizens who weigh leisure pick stations with more of it. Omitted (0) when the station has no working leisure venue.
5842
+ */
5843
+ leisure_points?: number;
5297
5844
  life_support?: StationLifeSupportStatus;
5845
+ /**
5846
+ * Public material request or build status for the next pirate replacement hull at the docked stronghold. Omitted outside pirate strongholds or when no replacement is needed and no replacement build exists.
5847
+ */
5848
+ pirate_recovery?: PirateRecoveryNeeds;
5298
5849
  power?: StationPowerStatus;
5299
5850
  repairs?: StationRepairResponse;
5300
5851
  services: Array<string>;
@@ -5302,6 +5853,10 @@ export type GetBaseResponse = {
5302
5853
  * Explains an input shortage or internal production-stage blockage or public input-price gap that limits replenishment at this station's empire-backed trade-authenticator mint. Omitted when the mint is absent, disabled, normally capped, or ready/producing without a replenishment price gap.
5303
5854
  */
5304
5855
  sovereign_mint?: SovereignMintStatus;
5856
+ /**
5857
+ * Lifetime credits visitors, connecting passengers and residents have spent at this station's dining and leisure venues. Omitted (0) when nothing has been spent here.
5858
+ */
5859
+ tourism_revenue?: number;
5305
5860
  };
5306
5861
  export type GetBattleLogResponse = {
5307
5862
  battle_id: string;
@@ -5551,14 +6106,74 @@ export type GetSystemTransitResponse = {
5551
6106
  transit_type: string;
5552
6107
  };
5553
6108
  export type GetTradeEntry = {
6109
+ /**
6110
+ * Faction that receives the station and pays request_credits to the seller faction. Present only for faction station sales.
6111
+ */
6112
+ buyer_faction_id?: string;
6113
+ /**
6114
+ * UTC time when the pending offer expires. Tolls expire by expires_tick instead.
6115
+ */
5554
6116
  expires_at: string;
6117
+ /**
6118
+ * Tick at which the toll offer expires unpaid. Present only for tolls.
6119
+ */
6120
+ expires_tick?: number;
6121
+ /**
6122
+ * True while the offerer holds the target with a warp scrambler for this toll. Omitted when no hold stands.
6123
+ */
6124
+ hold?: boolean;
6125
+ /**
6126
+ * Seller faction labor fee in credits paid to local station citizens on acceptance; outposts use the nearest reachable station pool. Currently 1000000. Omitted for ordinary trades.
6127
+ */
6128
+ labor_cost?: number;
6129
+ /**
6130
+ * Optional note the offerer attached to the trade_offer (sanitized, up to 500 characters). Empty string when the offerer sent no note.
6131
+ */
6132
+ note: string;
6133
+ /**
6134
+ * Personal credits offered. Zero or omitted for station sales.
6135
+ */
5555
6136
  offer_credits?: number;
6137
+ /**
6138
+ * Items offered by the seller. Empty for station sales.
6139
+ */
5556
6140
  offer_items: Array<PendingTradeItemView>;
6141
+ /**
6142
+ * True when the offer is a toll: request_credits buys the target a grant of safe passage from the offerer's faction (or the offerer alone if factionless) for 2160 ticks. Accepting pays what the target has, up to request_credits. Omitted for ordinary trades.
6143
+ */
6144
+ offer_safe_passage?: boolean;
6145
+ /**
6146
+ * Seller player name. Present for incoming offers only.
6147
+ */
5557
6148
  offerer_name?: string;
6149
+ /**
6150
+ * Requested payment in credits. For station sales the buyer faction treasury pays the seller faction treasury. Zero or omission means no price.
6151
+ */
5558
6152
  request_credits?: number;
6153
+ /**
6154
+ * Items requested from the buyer. Empty for station sales.
6155
+ */
5559
6156
  request_items: Array<PendingTradeItemView>;
6157
+ /**
6158
+ * Faction that sells the station and pays the labor cost and transfer tax. Present only for faction station sales.
6159
+ */
6160
+ seller_faction_id?: string;
6161
+ /**
6162
+ * Exact Base ID of the assembled station or outpost. Includes seller-faction facilities and storage contents at acceptance. Present only for faction station sales.
6163
+ */
6164
+ station_id?: string;
6165
+ /**
6166
+ * Buyer player name. Present for outgoing offers only.
6167
+ */
5560
6168
  target_name?: string;
6169
+ /**
6170
+ * Trade offer ID used by accept and cancel commands.
6171
+ */
5561
6172
  trade_id: string;
6173
+ /**
6174
+ * Seller faction transfer tax in credits paid to its primary taxable empire on acceptance. Currently 3000000. Omitted for ordinary trades.
6175
+ */
6176
+ transfer_tax?: number;
5562
6177
  };
5563
6178
  export type GetTradesResponse = {
5564
6179
  incoming: Array<GetTradeEntry>;
@@ -5618,9 +6233,9 @@ export type GiftGoodwill = {
5618
6233
  */
5619
6234
  reputation_change: number;
5620
6235
  /**
5621
- * Outcome class that picked the reply: stranger (a pirate crew kept the gift but owes nothing to a pilot never introduced to the pirate network), bounty_partial, bounty_cleared, hostile, cooling, unwanted_items, unwanted_ship, or token/appreciated/generous/lavish/devoted followed by _credits, _items or _ship. A ship given to a pirate crew instead reports what the crew did with it: ship_scrap (no pirate design for that hull), ship_refit (rebuilt to a pirate design) or ship_pirate (a pirate-built hull) followed by _cheap, _mid or _expensive by its fitted value; or, when the boss gets involved, boss_upgrade (the boss switches to your ship because it out-fights the boss's current one), boss_hunt (the boss's flagship is in a player's hands and the boss takes your stronger ship to hunt them), boss_flagship_returned, boss_rival_flown (the boss flies another boss's flagship until the stolen one comes back), boss_rival_scrapped, boss_flagship_copy (your hull was rebuilt into a copy of the boss's stolen flagship and the boss flies it) or boss_flagship_spare (rebuilt into a spare copy of the boss's flagship), each with _cold appended when the crew does not like you. stranger, hostile and cooling still apply to ordinary pirate ship gifts.
6236
+ * Outcome class that picked the reply: stranger (a pirate crew kept the gift but owes nothing to a pilot never introduced to the pirate network), bounty_partial, bounty_cleared, hostile, cooling, unwanted_items, unwanted_ship, or token/appreciated/generous/lavish/devoted followed by _credits, _items or _ship. A ship given to a pirate crew instead reports what the crew did with it: ship_scrap (no pirate design for that hull), ship_refit (rebuilt to a pirate design) or ship_pirate (a pirate-built hull) followed by _cheap, _mid or _expensive by its fitted value; or, when the boss gets involved, boss_upgrade (the boss switches to your ship because it out-fights the boss's current one), boss_hunt (the boss's flagship is in a player's hands and the boss takes your stronger ship to hunt them), boss_flagship_returned, boss_rival_flown (the boss flies another boss's flagship while his own is away from his crew) or boss_rival_scrapped, each with _cold appended when the crew does not like you. stranger, hostile and cooling still apply to ordinary pirate ship gifts.
5622
6237
  */
5623
- situation: string;
6238
+ situation: 'stranger' | 'bounty_partial' | 'bounty_cleared' | 'hostile' | 'cooling' | 'unwanted_items' | 'unwanted_ship' | 'token_credits' | 'token_items' | 'token_ship' | 'appreciated_credits' | 'appreciated_items' | 'appreciated_ship' | 'generous_credits' | 'generous_items' | 'generous_ship' | 'lavish_credits' | 'lavish_items' | 'lavish_ship' | 'devoted_credits' | 'devoted_items' | 'devoted_ship' | 'ship_scrap_cheap' | 'ship_scrap_mid' | 'ship_scrap_expensive' | 'ship_refit_cheap' | 'ship_refit_mid' | 'ship_refit_expensive' | 'ship_pirate_cheap' | 'ship_pirate_mid' | 'ship_pirate_expensive' | 'boss_upgrade' | 'boss_upgrade_cold' | 'boss_hunt' | 'boss_hunt_cold' | 'boss_flagship_returned' | 'boss_flagship_returned_cold' | 'boss_rival_flown' | 'boss_rival_flown_cold' | 'boss_rival_scrapped' | 'boss_rival_scrapped_cold';
5624
6239
  };
5625
6240
  export type GiftShipResponse = {
5626
6241
  /**
@@ -5928,6 +6543,9 @@ export type JettisonBulkResponse = {
5928
6543
  action: 'bulk_jettison';
5929
6544
  auto_docked?: boolean;
5930
6545
  auto_undocked?: boolean;
6546
+ /**
6547
+ * Container holding recoverable cargo at the current POI. Omitted mid-flight or when the entire action dissipates; an existing unrelated container is not returned.
6548
+ */
5931
6549
  container_id?: string;
5932
6550
  failed: number;
5933
6551
  message: string;
@@ -5940,7 +6558,21 @@ export type JettisonCommandResponse = ({
5940
6558
  } & JettisonResponse) | ({
5941
6559
  action: 'bulk_jettison';
5942
6560
  } & JettisonBulkResponse);
6561
+ export type JettisonConversion = {
6562
+ /**
6563
+ * Existing item ID placed into the jettison container; identifies the potential output even when output_quantity is zero.
6564
+ */
6565
+ output_item_id: string;
6566
+ /**
6567
+ * Recoverable output units: floor(removed input quantity / input batch size) * output batch yield. Water/nitrogen/ammonia/methane use 4 to 3; oxygen uses 4 to 2; coolant uses 3 to 1 water ice. Always present including zero when less than one batch is removed. All input is consumed; losses and incomplete batches dissipate. An action with no recoverable cargo creates no container.
6568
+ */
6569
+ output_quantity: number;
6570
+ };
5943
6571
  export type JettisonItemResult = {
6572
+ /**
6573
+ * Present only for a successful converted input at a POI. Each bulk entry converts independently using its removed quantity. Omitted for unchanged cargo and failures and mid-flight losses.
6574
+ */
6575
+ conversion?: JettisonConversion;
5944
6576
  error?: string;
5945
6577
  item_id: string;
5946
6578
  item_name?: string;
@@ -5949,13 +6581,35 @@ export type JettisonItemResult = {
5949
6581
  success: boolean;
5950
6582
  };
5951
6583
  export type JettisonResponse = {
6584
+ /**
6585
+ * Single-item jettison outcome.
6586
+ */
5952
6587
  action: 'jettison';
5953
6588
  auto_docked?: boolean;
5954
6589
  auto_undocked?: boolean;
6590
+ /**
6591
+ * Container holding recoverable cargo at the current POI. Omitted mid-flight or when the entire action dissipates; an existing unrelated container is not returned.
6592
+ */
5955
6593
  container_id?: string;
6594
+ /**
6595
+ * Present only for a converted input jettisoned at a POI. Quantity is all input removed; no input remainder survives. Omitted for unchanged cargo and mid-flight losses.
6596
+ */
6597
+ conversion?: JettisonConversion;
6598
+ /**
6599
+ * Input item removed from the ship.
6600
+ */
5956
6601
  item_id: string;
6602
+ /**
6603
+ * Display name of the removed input item.
6604
+ */
5957
6605
  item_name: string;
6606
+ /**
6607
+ * Human-readable jettison outcome including conversion or mid-flight loss when applicable.
6608
+ */
5958
6609
  message: string;
6610
+ /**
6611
+ * Input units removed from cargo after clamping to the amount held; includes material lost during conversion.
6612
+ */
5959
6613
  quantity: number;
5960
6614
  };
5961
6615
  export type JobCancelResponse = {
@@ -6005,25 +6659,85 @@ export type JobRetargetResponse = {
6005
6659
  runs_remaining: number;
6006
6660
  };
6007
6661
  export type JobView = {
6662
+ /**
6663
+ * ID of the station where the job runs. Omitted when the base cannot be resolved.
6664
+ */
6008
6665
  base_id?: string;
6666
+ /**
6667
+ * Display name of the station where the job runs. Omitted when the base cannot be resolved.
6668
+ */
6009
6669
  base_name?: string;
6670
+ /**
6671
+ * Where the remaining output lands: storage or faction or faction:<bucket id> or cargo. Same values as craft deliver_to. Shown only to the player who placed the job.
6672
+ */
6010
6673
  deliver_to?: string;
6674
+ /**
6675
+ * Estimated ticks until this job finishes. Counts the work queued ahead of it at the venue. 0 when the recipe is missing or the venue has no speed.
6676
+ */
6011
6677
  eta_ticks: number;
6678
+ /**
6679
+ * True when the job rents a facility its orderer does not own. Omitted when false.
6680
+ */
6012
6681
  external?: boolean;
6682
+ /**
6683
+ * Opaque ID of the facility instance or the synthetic Station Workshop or Field Workshop ID (fieldshop:<ship_id>).
6684
+ */
6013
6685
  facility_id: string;
6686
+ /**
6687
+ * Job ID. Pass it to job_cancel or to craft job_id=<id> deliver_to=<...>.
6688
+ */
6014
6689
  job_id: string;
6690
+ /**
6691
+ * Label of the package this job packs or unpacks. Set only on package jobs that have a label.
6692
+ */
6015
6693
  label?: string;
6016
- mode: string;
6694
+ /**
6695
+ * craft builds the recipe output. recycle breaks the recipe output back into a part of its inputs.
6696
+ */
6697
+ mode: 'craft' | 'recycle';
6698
+ /**
6699
+ * Who placed the job: self when you placed it or it is not external. Otherwise the renter's username, or external when that player no longer exists.
6700
+ */
6017
6701
  orderer: string;
6702
+ /**
6703
+ * ID of the package this job packs or unpacks. Set only on package jobs.
6704
+ */
6018
6705
  package_id?: string;
6706
+ /**
6707
+ * Queue order within the venue. A lower position runs first.
6708
+ */
6019
6709
  position: number;
6710
+ /**
6711
+ * Output items per run. Set only in craft mode. Omitted for recycle jobs because their yield varies.
6712
+ */
6020
6713
  produces?: Array<ItemQuantity>;
6714
+ /**
6715
+ * Fraction of the current run that is done. 0 or more and less than 1.
6716
+ */
6021
6717
  progress: number;
6718
+ /**
6719
+ * Display name of the job's recipe, not the recipe ID you passed to craft. Falls back to the raw recipe ID only when the recipe is no longer in the catalog.
6720
+ */
6022
6721
  recipe: string;
6722
+ /**
6723
+ * Runs finished so far: runs_total minus runs_remaining.
6724
+ */
6023
6725
  runs_done: number;
6726
+ /**
6727
+ * Runs still to produce.
6728
+ */
6024
6729
  runs_remaining: number;
6730
+ /**
6731
+ * Runs originally ordered.
6732
+ */
6025
6733
  runs_total: number;
6026
- status: string;
6734
+ /**
6735
+ * queued waits for the venue. active is running now. Finished and cancelled jobs are not listed.
6736
+ */
6737
+ status: 'queued' | 'active';
6738
+ /**
6739
+ * Display name of the venue: Station Workshop, Field Workshop (hand-crafting aboard a field workshop hull) or the facility type name. Falls back to the facility ID when the facility is unknown.
6740
+ */
6027
6741
  venue?: string;
6028
6742
  };
6029
6743
  export type JoinFactionResponse = {
@@ -6042,6 +6756,9 @@ export type JumpCommandResponse = ({
6042
6756
  action: 'pathfinder_jump' | 'pathfinder_redirect';
6043
6757
  } & PathfinderJumpResponse);
6044
6758
  export type JumpResponse = {
6759
+ /**
6760
+ * jumped for a jump command result. pathfinder_arrival only on the unsolicited ok push sent when a Pathfinder drift reaches a system.
6761
+ */
6045
6762
  action: 'jumped' | 'pathfinder_arrival';
6046
6763
  /**
6047
6764
  * True when the engine docked you automatically before running this command, because the command requires being docked. Omitted when no automatic dock happened.
@@ -6051,12 +6768,33 @@ export type JumpResponse = {
6051
6768
  * True when the engine undocked you automatically before running this command, because the command requires being undocked. Omitted when no automatic undock happened.
6052
6769
  */
6053
6770
  auto_undocked?: boolean;
6771
+ /**
6772
+ * Exploration skill XP for your first visit to this system: 5. Omitted on a revisit.
6773
+ */
6054
6774
  exploration_xp?: number;
6775
+ /**
6776
+ * Display name of the system you left.
6777
+ */
6055
6778
  from_system: string;
6779
+ /**
6780
+ * Navigation skill XP for the jump: 3 for every system-to-system jump.
6781
+ */
6056
6782
  navigation_xp: number;
6783
+ /**
6784
+ * Piloting skill XP the jump awarded: three times the per-trip rate of your ship's tier. Omitted when none was awarded.
6785
+ */
6057
6786
  piloting_xp?: number;
6787
+ /**
6788
+ * ID of the POI you arrived at in the new system (the exit POI for a wormhole jump). Omitted when the system has no POIs.
6789
+ */
6058
6790
  poi?: string;
6791
+ /**
6792
+ * Display name of the system you arrived in.
6793
+ */
6059
6794
  system: string;
6795
+ /**
6796
+ * ID of the system you arrived in.
6797
+ */
6060
6798
  system_id: string;
6061
6799
  };
6062
6800
  export type KillLogEntry = {
@@ -6262,7 +7000,7 @@ export type McpNotification = {
6262
7000
  data: NotificationPayload;
6263
7001
  id: string;
6264
7002
  /**
6265
- * Specific frame subtype. Switch on this to pick the matching Notification_<msg_type> payload schema. Routing to the coarse type field: chat_message -> chat. player_died / player_kill / scan_detected / pilotless_ship / drone_update / drone_destroyed / battle_started / battle_update / battle_joined / battle_left / battle_ended / battle_alert / ship_captured / prize_update -> combat. trade_offer_received / trade_complete / trade_declined / trade_cancelled / gift_received / exchange_fill -> trade. market_update -> market. crafting_update -> crafting. observation_update -> observation. personnel_update -> system. Frames not named here also route to system - that includes battle_damage / drone_scan / drone_survey / drone_adrift / action_result / action_error / error / server_restart_warning. A types=combat filter does not carry them.
7003
+ * Specific frame subtype. Switch on this to pick the matching Notification_<msg_type> payload schema. Routing to the coarse type field: chat_message -> chat. player_died / player_kill / scan_detected / hold_update / pilotless_ship / drone_update / drone_destroyed / battle_started / battle_update / battle_joined / battle_left / battle_ended / battle_alert / ship_captured / prize_update -> combat. trade_offer_received / trade_complete / trade_declined / trade_cancelled / gift_received / exchange_fill -> trade. market_update -> market. crafting_update -> crafting. observation_update -> observation. personnel_update -> system. Frames not named here also route to system - that includes battle_damage / drone_scan / drone_survey / drone_adrift / action_result / action_error / error / server_restart_warning. A types=combat filter does not carry them.
6266
7004
  */
6267
7005
  msg_type: string;
6268
7006
  timestamp: string;
@@ -6864,6 +7602,10 @@ export type Module = {
6864
7602
  drone_capacity?: number;
6865
7603
  fleet_triage_pct?: number;
6866
7604
  fuel_efficiency?: number;
7605
+ /**
7606
+ * Station power this module adds to the station it is docked at while connected with the generator command. Each connected generator burns 1 ship fuel per tick. Hull bonuses, Engineering and crew staffing scale the delivered output.
7607
+ */
7608
+ generator_output?: number;
6867
7609
  hidden?: boolean;
6868
7610
  hull_bonus?: number;
6869
7611
  hull_penalty?: number;
@@ -7016,7 +7758,7 @@ export type NotificationChannelInfo = {
7016
7758
  /**
7017
7759
  * Frame payload shared by polling and inline notifications. Select Notification_<msg_type> using the envelope msg_type; payload shapes can overlap so this is an anyOf union. Null means the frame supplied no payload.
7018
7760
  */
7019
- export type NotificationPayload = NotificationAchievementUnlocked | NotificationActionError | NotificationActionResult | NotificationArenaChallenge | NotificationArenaObjective | NotificationBaseDestroyed | NotificationBaseRaidUpdate | NotificationBattleAlert | NotificationBattleDamage | NotificationBattleEnded | NotificationBattleJoined | NotificationBattleLeft | NotificationBattleStarted | NotificationBattleUpdate | NotificationChatMessage | NotificationCloak | NotificationCompleteMission | NotificationCraftingUpdate | NotificationDroneAdrift | NotificationDroneDestroyed | NotificationDroneScan | NotificationDroneSurvey | NotificationDroneUpdate | NotificationError | NotificationExchangeFill | NotificationFacilityReclaimed | NotificationFacilityRentWarning | NotificationFactionAllianceBroken | NotificationFactionAllianceFormed | NotificationFactionAllianceProposal | NotificationFactionMobileBaseUpdate | NotificationFactionPeaceAccepted | NotificationFactionPeaceProposal | NotificationFactionWarDeclared | NotificationFleet | NotificationGiftReceived | NotificationMarketUpdate | NotificationMiningYield | NotificationObservationUpdate | NotificationOk | NotificationPersonnelUpdate | NotificationPilotlessShip | NotificationPirateDestroyed | NotificationPirateRadio | NotificationPlayerDied | NotificationPlayerKill | NotificationPrizeUpdate | NotificationRanchPoached | NotificationReconnected | NotificationRefueledBy | NotificationRepairedBy | NotificationScanDetected | NotificationServerRestartWarning | NotificationShipCaptured | NotificationShipCommissionComplete | NotificationSkillLevelUp | NotificationStationRepaired | NotificationTradeCancelled | NotificationTradeComplete | NotificationTradeDeclined | NotificationTradeOfferReceived | null;
7761
+ export type NotificationPayload = NotificationAchievementUnlocked | NotificationActionError | NotificationActionResult | NotificationArenaChallenge | NotificationArenaObjective | NotificationBaseDestroyed | NotificationBaseRaidUpdate | NotificationBattleAlert | NotificationBattleDamage | NotificationBattleEnded | NotificationBattleJoined | NotificationBattleLeft | NotificationBattleStarted | NotificationBattleUpdate | NotificationChatMessage | NotificationCloak | NotificationCompleteMission | NotificationCraftingUpdate | NotificationDroneAdrift | NotificationDroneDestroyed | NotificationDroneScan | NotificationDroneSurvey | NotificationDroneUpdate | NotificationError | NotificationExchangeFill | NotificationFacilityReclaimed | NotificationFacilityRentWarning | NotificationFactionAllianceBroken | NotificationFactionAllianceFormed | NotificationFactionAllianceProposal | NotificationFactionMobileBaseUpdate | NotificationFactionPeaceAccepted | NotificationFactionPeaceProposal | NotificationFactionWarDeclared | NotificationFleet | NotificationGiftReceived | NotificationHoldUpdate | NotificationMarketUpdate | NotificationMiningYield | NotificationObservationUpdate | NotificationOk | NotificationPersonnelUpdate | NotificationPilotlessShip | NotificationPirateDestroyed | NotificationPirateRadio | NotificationPlayerDied | NotificationPlayerKill | NotificationPrizeUpdate | NotificationRanchPoached | NotificationReconnected | NotificationRefueledBy | NotificationRepairedBy | NotificationScanDetected | NotificationServerRestartWarning | NotificationShipCaptured | NotificationShipCommissionComplete | NotificationSkillLevelUp | NotificationStationRepaired | NotificationTradeCancelled | NotificationTradeComplete | NotificationTradeDeclined | NotificationTradeOfferReceived | null;
7020
7762
  export type NotificationSettingsResponse = {
7021
7763
  action: string;
7022
7764
  channels: Array<NotificationChannelInfo>;
@@ -7342,8 +8084,17 @@ export type NotificationCompleteMission = {
7342
8084
  */
7343
8085
  rewards: MissionAutoCompleteRewards;
7344
8086
  };
8087
+ /**
8088
+ * Pushed once per tick in which any of your facility or Station Workshop jobs deposited output. It is the completion signal for asynchronous crafting, so you do not need to poll the job queue. All of your jobs that deposited in the tick are in one message.
8089
+ */
7345
8090
  export type NotificationCraftingUpdate = {
8091
+ /**
8092
+ * One entry per job that deposited output this tick. Sorted by job_id.
8093
+ */
7346
8094
  jobs: Array<CraftingJobUpdate>;
8095
+ /**
8096
+ * Game tick in which the jobs deposited their output.
8097
+ */
7347
8098
  tick: number;
7348
8099
  };
7349
8100
  export type NotificationDroneAdrift = {
@@ -7420,8 +8171,23 @@ export type NotificationDroneUpdate = {
7420
8171
  tick: number;
7421
8172
  };
7422
8173
  export type NotificationError = {
8174
+ /**
8175
+ * Machine-readable error code. Switch on this rather than on message.
8176
+ */
7423
8177
  code: string;
8178
+ /**
8179
+ * Optional extra context. Shape depends on code. Omitted when the error carries none.
8180
+ */
8181
+ details?: {
8182
+ [key: string]: unknown;
8183
+ };
8184
+ /**
8185
+ * Human-readable explanation of the error.
8186
+ */
7424
8187
  message: string;
8188
+ /**
8189
+ * Name of the already-queued command. Present only on action_pending errors.
8190
+ */
7425
8191
  pending_command?: string;
7426
8192
  };
7427
8193
  /**
@@ -7623,6 +8389,51 @@ export type NotificationGiftReceived = {
7623
8389
  */
7624
8390
  timestamp: string;
7625
8391
  };
8392
+ /**
8393
+ * Pushed to both the holder and the held pilot when a hold starts or ends. A hold is a crime in empire space and a hostile act everywhere.
8394
+ */
8395
+ export type NotificationHoldUpdate = {
8396
+ /**
8397
+ * started when the hold begins; ended when it ends.
8398
+ */
8399
+ event: 'started' | 'ended';
8400
+ /**
8401
+ * Player whose warp scrambler holds the target.
8402
+ */
8403
+ holder_id: string;
8404
+ /**
8405
+ * Holder username.
8406
+ */
8407
+ holder_name: string;
8408
+ /**
8409
+ * Human-readable summary.
8410
+ */
8411
+ message: string;
8412
+ /**
8413
+ * Why the hold ended. Present only on ended. paid: the target accepted the toll. offer_closed: the toll was declined, cancelled or expired and the 2-tick grace ran out. holder_acted: the holder queued a command other than scan, trade_offer, attack or reload. holder_left: the holder or target left the POI, docked, jumped or died. battle: the two pilots are now in the same battle, and combat tackle applies. scan_over: a scan hold ran its 5 ticks with no toll offer.
8414
+ */
8415
+ reason?: 'paid' | 'offer_closed' | 'holder_acted' | 'holder_left' | 'battle' | 'scan_over';
8416
+ /**
8417
+ * What holds the target: toll is a trade_offer with hold=true; scan is a cargo scan from a ship with a warp scrambler. A toll offer sent during a scan hold turns it into a toll hold.
8418
+ */
8419
+ source: 'toll' | 'scan';
8420
+ /**
8421
+ * Tick the hold started.
8422
+ */
8423
+ start_tick: number;
8424
+ /**
8425
+ * Held player.
8426
+ */
8427
+ target_id: string;
8428
+ /**
8429
+ * Held player username.
8430
+ */
8431
+ target_name: string;
8432
+ /**
8433
+ * The toll offer that keeps the hold. Present for toll holds.
8434
+ */
8435
+ trade_id?: string;
8436
+ };
7626
8437
  export type NotificationMarketUpdate = {
7627
8438
  base_id: string;
7628
8439
  base_name?: string;
@@ -7683,11 +8494,11 @@ export type NotificationObservationUpdate = {
7683
8494
  unknown_signature: boolean;
7684
8495
  };
7685
8496
  /**
7686
- * Fleet movement ok notifications identify their event in action. Other ok payloads may omit action. Fleet followers receive fleet_dock (base name and base_id), fleet_undock, fleet_travel (destination POI ID and arrival_tick), or fleet_jump (destination system ID and arrival_tick) without request_id. fleet_dock is not a command or a separate message type; DockResponse describes the leader's dock command, not this push. Other actions and command-specific fields may occur. Inspect action and tolerate unknown actions. Delta-capable WebSocket followers also receive action_result with command travel or jump at arrival.
8497
+ * Fleet movement ok notifications identify their event in action. Other ok payloads may omit action. Fleet followers receive fleet_dock (base name and base_id), fleet_undock, fleet_travel (destination POI ID and arrival_tick), or fleet_jump (destination system ID and arrival_tick) without request_id. fleet_dock is not a command or a separate message type; DockResponse describes the leader's dock command, not this push. Arrivals use ok too when the WebSocket does not take state deltas: action arrived carries the TravelResponse fields (poi is the POI name there; poi_id, online_players, unknown_signature, xp_gained) and action jumped carries the JumpResponse fields (system, system_id, from_system, navigation_xp, exploration_xp, piloting_xp; poi is the POI ID there), both with the request_id of the travel or jump. action pathfinder_arrival carries the JumpResponse fields with no request_id, on every transport, when a Pathfinder drift reaches a system; the bearing jump already returned its PathfinderJumpResponse. Other actions and command-specific fields may occur. Inspect action and tolerate unknown actions. Delta-capable WebSocket followers also receive action_result with command travel or jump at arrival.
7687
8498
  */
7688
8499
  export type NotificationOk = {
7689
8500
  /**
7690
- * Event or completed command name. For coordinated docking this is fleet_dock.
8501
+ * Event or completed command name. For coordinated docking this is fleet_dock. For an arrival it is arrived, jumped or pathfinder_arrival.
7691
8502
  */
7692
8503
  action?: string;
7693
8504
  /**
@@ -7710,10 +8521,48 @@ export type NotificationOk = {
7710
8521
  * Destination POI ID for fleet_travel or system ID for fleet_jump; omitted for fleet_dock and fleet_undock.
7711
8522
  */
7712
8523
  destination?: string;
8524
+ /**
8525
+ * Exploration skill XP for your first visit to this system: 5. Omitted on a revisit.
8526
+ */
8527
+ exploration_xp?: number;
8528
+ /**
8529
+ * Display name of the system you left.
8530
+ */
8531
+ from_system?: string;
7713
8532
  /**
7714
8533
  * Human-readable event explanation.
7715
8534
  */
7716
8535
  message?: string;
8536
+ /**
8537
+ * Navigation skill XP for the jump: 3 for every system-to-system jump.
8538
+ */
8539
+ navigation_xp?: number;
8540
+ /**
8541
+ * Piloting skill XP the jump awarded: three times the per-trip rate of your ship's tier. Omitted when none was awarded.
8542
+ */
8543
+ piloting_xp?: number;
8544
+ /**
8545
+ * ID of the POI you arrived at.
8546
+ */
8547
+ poi_id?: string;
8548
+ /**
8549
+ * Display name of the system you arrived in.
8550
+ */
8551
+ system?: string;
8552
+ /**
8553
+ * ID of the system you arrived in.
8554
+ */
8555
+ system_id?: string;
8556
+ /**
8557
+ * True when a cloaked ship or cloaked creature at the arrival POI is within one sensor level of your scanner: presence only. Run an area scan (scan with no target_id) to resolve a ship; a creature resolves only with a sensor rating a full level above its cloak. Omitted when false.
8558
+ */
8559
+ unknown_signature?: boolean;
8560
+ /**
8561
+ * Skill XP the trip awarded, keyed by skill ID. Omitted when the trip awarded none.
8562
+ */
8563
+ xp_gained?: {
8564
+ [key: string]: number;
8565
+ };
7717
8566
  };
7718
8567
  export type NotificationPersonnelUpdate = {
7719
8568
  /**
@@ -7827,10 +8676,6 @@ export type NotificationPirateRadio = {
7827
8676
  * Backward-compatible alias of editorial_class. Both fields always carry the same bounded editorial class.
7828
8677
  */
7829
8678
  category: 'ambient' | 'tactical' | 'strategic' | 'outcome';
7830
- /**
7831
- * Bounded editorial delivery policy for the public pirate-radio Discord feed; it does not affect in-game delivery.
7832
- */
7833
- discord_policy: 'never' | 'batched' | 'immediate';
7834
8679
  /**
7835
8680
  * Canonical cross-channel editorial class and alias of category. Both fields always carry the same value.
7836
8681
  */
@@ -8098,12 +8943,48 @@ export type NotificationTradeCancelled = {
8098
8943
  * Pushed to the offerer when the trade recipient accepts.
8099
8944
  */
8100
8945
  export type NotificationTradeComplete = {
8946
+ /**
8947
+ * Buyer faction ID. Present only for station sales.
8948
+ */
8949
+ buyer_faction_id?: string;
8950
+ /**
8951
+ * Station sale price in credits paid by the buyer faction treasury to the seller faction treasury. Present including zero only for station sales.
8952
+ */
8953
+ credits?: number;
8954
+ /**
8955
+ * Seller faction fee in credits paid to the nearest eligible station citizen pool. Currently 1000000. Present only for station sales.
8956
+ */
8957
+ labor_cost?: number;
8101
8958
  message: string;
8959
+ /**
8960
+ * Credits the target paid for your toll: request_credits, or their whole wallet when they had less. Present including zero only for tolls.
8961
+ */
8962
+ paid_credits?: number;
8963
+ /**
8964
+ * Tick at which the grant of safe passage the target bought ends. Present only for tolls.
8965
+ */
8966
+ pass_until_tick?: number;
8967
+ /**
8968
+ * Seller faction ID. Present only for station sales.
8969
+ */
8970
+ seller_faction_id?: string;
8971
+ /**
8972
+ * Station or outpost sold with its facilities and faction storage. Present only for station sales.
8973
+ */
8974
+ station_id?: string;
8102
8975
  trade_id: string;
8976
+ /**
8977
+ * Seller faction tax in credits paid to its primary taxable empire. Currently 3000000. Present only for station sales.
8978
+ */
8979
+ transfer_tax?: number;
8103
8980
  /**
8104
8981
  * Offerer's credit balance after the trade settled.
8105
8982
  */
8106
8983
  your_credits?: number;
8984
+ /**
8985
+ * Seller faction treasury balance in credits after the price and seller fees settle. Present including zero only for station sales.
8986
+ */
8987
+ your_faction_credits?: number;
8107
8988
  };
8108
8989
  /**
8109
8990
  * Pushed to the offerer when the trade recipient declines.
@@ -8116,7 +8997,30 @@ export type NotificationTradeDeclined = {
8116
8997
  * Direct player-to-player trade offer received.
8117
8998
  */
8118
8999
  export type NotificationTradeOfferReceived = {
9000
+ /**
9001
+ * Buyer faction ID. Present only for station sales.
9002
+ */
9003
+ buyer_faction_id?: string;
9004
+ /**
9005
+ * Wall-clock expiry of an ordinary offer. Tolls expire by expires_tick instead.
9006
+ */
8119
9007
  expires_at?: string;
9008
+ /**
9009
+ * Tick at which the toll offer expires unpaid. Present only for tolls.
9010
+ */
9011
+ expires_tick?: number;
9012
+ /**
9013
+ * True when the offerer's warp scrambler holds you while the toll stands: your jump and travel wait, and dock, emergency warps, self-destruct, fleet moves and other fights are refused. Attacking the offerer is lawful defense. False otherwise.
9014
+ */
9015
+ hold?: boolean;
9016
+ /**
9017
+ * Seller faction fee in credits paid to the nearest eligible station citizen pool. Currently 1000000. Present only for station sales.
9018
+ */
9019
+ labor_cost?: number;
9020
+ /**
9021
+ * Optional note the offerer attached to the offer (sanitized, up to 500 characters). Empty string when the offerer sent no note.
9022
+ */
9023
+ note?: string;
8120
9024
  offer_credits?: number;
8121
9025
  /**
8122
9026
  * Items the offerer is giving.
@@ -8124,8 +9028,16 @@ export type NotificationTradeOfferReceived = {
8124
9028
  offer_items?: Array<{
8125
9029
  [key: string]: unknown;
8126
9030
  }>;
9031
+ /**
9032
+ * True when the offer is a toll: request_credits buys you a grant of safe passage from the offerer's faction (or the offerer alone if factionless). Accepting pays what you have, up to request_credits. False for ordinary trades.
9033
+ */
9034
+ offer_safe_passage?: boolean;
8127
9035
  offerer_id: string;
8128
9036
  offerer_name?: string;
9037
+ /**
9038
+ * Length in ticks of the grant of safe passage the toll buys, counted from acceptance. Currently 2160. Present only for tolls.
9039
+ */
9040
+ pass_until_ticks?: number;
8129
9041
  request_credits?: number;
8130
9042
  /**
8131
9043
  * Items the offerer wants in return.
@@ -8133,7 +9045,19 @@ export type NotificationTradeOfferReceived = {
8133
9045
  request_items?: Array<{
8134
9046
  [key: string]: unknown;
8135
9047
  }>;
9048
+ /**
9049
+ * Seller faction ID. Present only for station sales.
9050
+ */
9051
+ seller_faction_id?: string;
9052
+ /**
9053
+ * Station or outpost sold with its facilities and faction storage. Present only for station sales.
9054
+ */
9055
+ station_id?: string;
8136
9056
  trade_id: string;
9057
+ /**
9058
+ * Seller faction tax in credits paid to its primary taxable empire. Currently 3000000. Present only for station sales.
9059
+ */
9060
+ transfer_tax?: number;
8137
9061
  };
8138
9062
  export type ObjectiveInfo = {
8139
9063
  description: string;
@@ -8434,6 +9358,9 @@ export type PassengerView = {
8434
9358
  ticks_remaining: number;
8435
9359
  };
8436
9360
  export type PathfinderJumpResponse = {
9361
+ /**
9362
+ * pathfinder_jump when the drive launched you from a system; pathfinder_redirect when you replotted while already drifting. Either way the command is finished: when the drift reaches a system you get an unsolicited ok notification with action pathfinder_arrival.
9363
+ */
8437
9364
  action: 'pathfinder_jump' | 'pathfinder_redirect';
8438
9365
  /**
8439
9366
  * True when the engine docked you automatically before running this command, because the command requires being docked. Omitted when no automatic dock happened.
@@ -8443,9 +9370,21 @@ export type PathfinderJumpResponse = {
8443
9370
  * True when the engine undocked you automatically before running this command, because the command requires being undocked. Omitted when no automatic undock happened.
8444
9371
  */
8445
9372
  auto_undocked?: boolean;
9373
+ /**
9374
+ * The heading you are now drifting on, in degrees normalized to 0 up to (not including) 360. 0 points along galactic +X and the angle increases counter-clockwise: 90 points along +Y.
9375
+ */
8446
9376
  bearing: number;
9377
+ /**
9378
+ * Human-readable confirmation with the next steps: poll get_location to track the drift, or send another numeric bearing to replot.
9379
+ */
8447
9380
  message: string;
9381
+ /**
9382
+ * Galactic X coordinate (GU) the new heading starts from: your drifting position when you replotted. Present only on pathfinder_redirect; a pathfinder_jump starts from the system you launched from.
9383
+ */
8448
9384
  origin_x?: number;
9385
+ /**
9386
+ * Galactic Y coordinate (GU) the new heading starts from. Present exactly when origin_x is present.
9387
+ */
8449
9388
  origin_y?: number;
8450
9389
  };
8451
9390
  export type PayBountyOutstandingRow = {
@@ -8533,6 +9472,62 @@ export type PirateInfo = {
8533
9472
  status: string;
8534
9473
  tier: string;
8535
9474
  };
9475
+ export type PirateRecoveryMaterial = {
9476
+ /**
9477
+ * Best current public station bid in credits per unit. Zero means no bid.
9478
+ */
9479
+ bid_price: number;
9480
+ /**
9481
+ * Remaining public station bid quantity at bid_price. This can differ from the construction shortage.
9482
+ */
9483
+ bid_quantity: number;
9484
+ /**
9485
+ * Material item identifier.
9486
+ */
9487
+ item_id: string;
9488
+ /**
9489
+ * Material display name.
9490
+ */
9491
+ name: string;
9492
+ /**
9493
+ * Physical manager warehouse stock in item units. Zero means none on hand.
9494
+ */
9495
+ quantity_in_storage: number;
9496
+ /**
9497
+ * Supply already committed through station freight in item units. Zero means none inbound.
9498
+ */
9499
+ quantity_incoming: number;
9500
+ /**
9501
+ * max(quantity_required - quantity_in_storage, 0) in item units. Zero means physically stocked.
9502
+ */
9503
+ quantity_missing: number;
9504
+ /**
9505
+ * One hull recipe plus the next station upkeep cycle.
9506
+ */
9507
+ quantity_required: number;
9508
+ /**
9509
+ * max(quantity_missing - quantity_incoming, 0) in item units. Zero means no additional delivery is needed.
9510
+ */
9511
+ quantity_to_supply: number;
9512
+ };
9513
+ export type PirateRecoveryNeeds = {
9514
+ /**
9515
+ * Material bill for one hull plus its protected next upkeep cycle. Omitted after a build is commissioned. Bids are current public orders rather than promised payment.
9516
+ */
9517
+ materials?: Array<PirateRecoveryMaterial>;
9518
+ /**
9519
+ * Replacement hull class requested by this station.
9520
+ */
9521
+ ship_class_id: string;
9522
+ /**
9523
+ * Display name of the requested hull.
9524
+ */
9525
+ ship_name: string;
9526
+ /**
9527
+ * awaiting_materials or awaiting_delivery or materials_ready or queued or building or ready. materials_ready confirms physical inputs only; shipyard scheduling can still delay construction.
9528
+ */
9529
+ status: string;
9530
+ };
8536
9531
  export type PlaceShipBuyOrderResponse = {
8537
9532
  /**
8538
9533
  * True when the engine docked you automatically before running this command, because the command requires being docked. Omitted when no automatic dock happened.
@@ -8661,6 +9656,21 @@ export type Player = {
8661
9656
  * Hex color
8662
9657
  */
8663
9658
  primary_color?: string;
9659
+ /**
9660
+ * Players this player refueled ship-to-ship for piloting XP today (UTC). Each target pays piloting XP once per UTC day. Omitted until the first such refuel. Resets when the day changes.
9661
+ */
9662
+ refuel_xp?: {
9663
+ /**
9664
+ * UTC day the ledger covers (YYYY-MM-DD)
9665
+ */
9666
+ day?: string;
9667
+ /**
9668
+ * Player IDs refueled for piloting XP today; a missing ID has not paid yet today
9669
+ */
9670
+ targets?: {
9671
+ [key: string]: boolean;
9672
+ };
9673
+ };
8664
9674
  /**
8665
9675
  * Current reputation score per empire ID, range [-100, 100]
8666
9676
  */
@@ -8677,6 +9687,36 @@ export type Player = {
8677
9687
  * Ship ID the player is riding aboard as a passenger (empty if piloting their own ship)
8678
9688
  */
8679
9689
  riding_ship_id?: string;
9690
+ /**
9691
+ * Grants of safe passage you hold, longest-running first, at most 16. Until until_tick, members of grantor_faction_id (or grantor_player_id alone when the grantor has no faction) cannot attack, target or board you; attacking a bound pilot yourself ends the grant. Expired grants may remain until the list next changes. Omitted when you hold none.
9692
+ */
9693
+ safe_passages?: Array<{
9694
+ granted_tick?: number;
9695
+ /**
9696
+ * Faction bound by the grant. Omitted when the grantor had no faction.
9697
+ */
9698
+ grantor_faction_id?: string;
9699
+ /**
9700
+ * Player who granted the pass.
9701
+ */
9702
+ grantor_player_id?: string;
9703
+ /**
9704
+ * The toll's trade ID, when the grant came from a toll.
9705
+ */
9706
+ ref_id?: string;
9707
+ /**
9708
+ * toll: bought with a trade_offer toll. robbery: left by a robbery.
9709
+ */
9710
+ source?: 'toll' | 'robbery';
9711
+ /**
9712
+ * System where the grant was made.
9713
+ */
9714
+ system_id?: string;
9715
+ /**
9716
+ * First tick at which the grant no longer binds.
9717
+ */
9718
+ until_tick?: number;
9719
+ }>;
8680
9720
  /**
8681
9721
  * Hex color
8682
9722
  */
@@ -8838,6 +9878,10 @@ export type PlayerProfileStats = {
8838
9878
  * Lifetime ore mined, in units.
8839
9879
  */
8840
9880
  ore_mined: number;
9881
+ /**
9882
+ * Lifetime passengers delivered to their destination.
9883
+ */
9884
+ passengers_delivered: number;
8841
9885
  /**
8842
9886
  * Lifetime pirate ships destroyed.
8843
9887
  */
@@ -9009,6 +10053,7 @@ export type PlayerStats = {
9009
10053
  modules_installed?: number;
9010
10054
  npcs_destroyed?: number;
9011
10055
  ore_mined?: number;
10056
+ passengers_delivered?: number;
9012
10057
  pirate_boss_prizes_delivered?: number;
9013
10058
  pirate_prizes_delivered?: number;
9014
10059
  pirates_destroyed?: number;
@@ -9483,6 +10528,10 @@ export type RefuelResponse = {
9483
10528
  market_cost?: number;
9484
10529
  members?: Array<FleetShipFuel>;
9485
10530
  message?: string;
10531
+ /**
10532
+ * Piloting skill XP earned for a ship-to-ship refuel: 25 × the piloting XP per action of your active ship tier (tier 1: 1 / tier 2: 2 / tier 3: 4 / tier 4: 7 / tier 5: 12). Each target pays once per UTC day. Omitted (0) for a station refuel and for a repeat target on the same UTC day.
10533
+ */
10534
+ piloting_xp?: number;
9486
10535
  rescue_completed?: boolean;
9487
10536
  rescue_reward?: number;
9488
10537
  source: string;
@@ -9492,6 +10541,12 @@ export type RefuelResponse = {
9492
10541
  target_player_name?: string;
9493
10542
  tax_amount?: number;
9494
10543
  };
10544
+ export type RefuelXpLedger = {
10545
+ day: string;
10546
+ targets: {
10547
+ [key: string]: boolean;
10548
+ };
10549
+ };
9495
10550
  export type RegenLogEntry = {
9496
10551
  armor_repair: number;
9497
10552
  hull_after: number;
@@ -9553,6 +10608,10 @@ export type RepairResponse = {
9553
10608
  max_hull?: number;
9554
10609
  members?: Array<FleetShipHull>;
9555
10610
  message?: string;
10611
+ /**
10612
+ * Piloting skill XP earned for a ship-to-ship repair: 1 per 10 hull repaired (rounded down) × the piloting XP per action of your active ship tier (tier 1: 1 / tier 2: 2 / tier 3: 4 / tier 4: 7 / tier 5: 12). Omitted (0) for every other repair source and when less than 10 hull was repaired.
10613
+ */
10614
+ piloting_xp?: number;
9556
10615
  repaired?: number;
9557
10616
  source: string;
9558
10617
  target_hull_max?: number;
@@ -9639,6 +10698,15 @@ export type RouteStep = {
9639
10698
  */
9640
10699
  via_wormhole?: boolean;
9641
10700
  };
10701
+ export type SafePassage = {
10702
+ granted_tick: number;
10703
+ grantor_faction_id?: string;
10704
+ grantor_player_id: string;
10705
+ ref_id?: string;
10706
+ source: string;
10707
+ system_id: string;
10708
+ until_tick: number;
10709
+ };
9642
10710
  export type SalvageMaterial = {
9643
10711
  item: string;
9644
10712
  name: string;
@@ -9671,7 +10739,18 @@ export type ScanResponse = {
9671
10739
  * True when the scanned creature is branded livestock of a player faction's wildlife ranch. Killing it is legal. It draws down the owners' herd, the owners are told who killed it, and it gives no hunt mission credit. Omitted for wild animals and for scans of anything else.
9672
10740
  */
9673
10741
  branded?: boolean;
9674
- cargo_types?: Array<string>;
10742
+ /**
10743
+ * The target's ship cargo in the get_cargo item shape (item_id, name, quantity, size). Present when a cargo scan succeeds and the hold is not empty. A successful cargo scan without cargo means an empty hold. A cargo scan never reveals credits.
10744
+ */
10745
+ cargo?: Array<ShipCargoItem>;
10746
+ /**
10747
+ * The target ship's cargo capacity. Present when a cargo scan succeeds.
10748
+ */
10749
+ cargo_capacity?: number;
10750
+ /**
10751
+ * Cargo space the target uses. Present when a cargo scan succeeds and the hold is not empty.
10752
+ */
10753
+ cargo_used?: number;
9675
10754
  cloaked?: boolean;
9676
10755
  /**
9677
10756
  * Players the scan resolved, each with the tiered reveal its contest margin allows (10 username, 20 ship class, 30 hull and shield, 40 cloaked flag, 50 faction). A cloaked player is listed only from margin 10. Omitted when none.
@@ -9679,12 +10758,24 @@ export type ScanResponse = {
9679
10758
  contacts?: Array<ScanContact>;
9680
10759
  description?: string;
9681
10760
  faction_id?: string;
10761
+ /**
10762
+ * True when your warp scrambler held the target for the cargo scan: 5 ticks from the scan start. Omitted when false.
10763
+ */
10764
+ hold?: boolean;
10765
+ /**
10766
+ * True when you carry a warp scrambler but the target's warp stabilizer cancelled the hold. The scan still ran. Omitted when false.
10767
+ */
10768
+ hold_cancelled?: boolean;
9682
10769
  hull?: number;
9683
10770
  /**
9684
10771
  * Leviathans at the POI. Omitted when none are there.
9685
10772
  */
9686
10773
  leviathans?: Array<LeviathanContact>;
9687
10774
  message?: string;
10775
+ /**
10776
+ * cargo when this result is a cargo scan (scan with mode=cargo). success is true when the scan read the cargo. Omitted for other scans.
10777
+ */
10778
+ mode?: 'cargo';
9688
10779
  /**
9689
10780
  * Empire NPC ships that passed the contest (listed from margin 10, ship class from 20). Omitted when none. Area sweeps never fill it.
9690
10781
  */
@@ -9697,9 +10788,13 @@ export type ScanResponse = {
9697
10788
  * The POI a remote POI scan read. Present only when target_id was a POI in your system; a client branches on it to read the result as a POI scan.
9698
10789
  */
9699
10790
  poi_id?: string;
10791
+ /**
10792
+ * Why a cargo scan failed. evaded: scan power was 0 against the target's stealth and scan evasion. target_left: the target left your POI, docked or boarded a carrier. target_lost: the target cloaked beyond your sensors. scanner_left: you left the POI, docked or boarded a carrier. Omitted when the scan succeeded and for other scans.
10793
+ */
10794
+ reason?: 'evaded' | 'target_left' | 'target_lost' | 'scanner_left';
9700
10795
  revealed_info: Array<string>;
9701
10796
  /**
9702
- * Scan power of a remote POI scan: your sensor rating at your own POI, or your sensor rating minus 10 at another POI in your system. Each ship there is contested at this power minus its stealth rating. Omitted for other scans and when the power is 0.
10797
+ * Scan power of a remote POI scan: your sensor rating at your own POI, or your sensor rating minus 10 at another POI in your system. Each ship there is contested at this power minus its stealth rating. For a cargo scan: your sensor rating minus the target's stealth rating and scan evasion skill (Piracy, Smuggling, Stealth). Omitted for other scans and when the power is 0.
9703
10798
  */
9704
10799
  scan_power?: number;
9705
10800
  shield?: number;
@@ -9736,6 +10831,10 @@ export type ScrapWreckResponse = {
9736
10831
  * True when the engine undocked you automatically before running this command, because the command requires being undocked. Omitted when no automatic undock happened.
9737
10832
  */
9738
10833
  auto_undocked?: boolean;
10834
+ /**
10835
+ * scrap_wreck mode=field only: recovered items that did not fit in your cargo hold and were destroyed with the wreck. Omitted when everything fit. Materials lists what went into the hold; total_value covers only that.
10836
+ */
10837
+ lost?: Array<SalvageMaterial>;
9739
10838
  materials: Array<SalvageMaterial>;
9740
10839
  message: string;
9741
10840
  ship_class?: string;
@@ -9853,7 +10952,7 @@ export type SellWreckResponse = {
9853
10952
  };
9854
10953
  export type SendGiftResponse = {
9855
10954
  /**
9856
- * Completed gift operation including station material donations or fixer debt repayment.
10955
+ * Completed gift of items or credits: to a player, a station:<base ID> donation (NPC empire station or pirate stronghold), a pirate:<crew> credit wire, or fixer:tab debt repayment. A donation to an empire alias returns EmpireGiftResponse instead, and a ship gift returns GiftShipResponse.
9857
10956
  */
9858
10957
  action: 'send_gift';
9859
10958
  /**
@@ -9865,7 +10964,7 @@ export type SendGiftResponse = {
9865
10964
  */
9866
10965
  auto_undocked?: boolean;
9867
10966
  /**
9868
- * Canonical Base ID where gifted items were deposited. A station gift or fixer payment names the station at which the sender is docked; a pirate:<crew> credit wire names the crew's stronghold.
10967
+ * Canonical Base ID where gifted items were deposited. A station gift or fixer payment names the station at which the sender is docked; a pirate:<crew> credit wire names the crew's stronghold. Empty for a credit-only gift to a player sent away from a storage station.
9869
10968
  */
9870
10969
  base_id: string;
9871
10970
  /**
@@ -9881,7 +10980,7 @@ export type SendGiftResponse = {
9881
10980
  */
9882
10981
  fixer?: FixerAccountInfo;
9883
10982
  /**
9884
- * How the empire or pirate crew received this gift: value to them, bounty paid, reputation change and their reply. Present on gifts to empires, NPC empire stations and pirate strongholds; omitted for gifts to players, factions and the fixer.
10983
+ * How the empire or pirate crew received this gift: value to them, bounty paid, reputation change and their reply. Present on station:<base ID> donations and pirate:<crew> credit wires; omitted for gifts to players and fixer:tab payments.
9885
10984
  */
9886
10985
  goodwill?: GiftGoodwill;
9887
10986
  /**
@@ -10016,14 +11115,18 @@ export type Ship = {
10016
11115
  defense_slots?: number;
10017
11116
  disruption_ticks_remaining?: number;
10018
11117
  docked_at_base?: string;
11118
+ /**
11119
+ * Jobs queued on this ship's Field Workshop (field workshop hulls only), in run order. Their escrowed inputs are not in cargo or cargo_used but still take hold space. Omitted when the ship has none.
11120
+ */
11121
+ field_jobs?: Array<FieldJob>;
10019
11122
  fuel: number;
10020
11123
  /**
10021
- * % of normal cargo space for gases (0=normal, 50=half)
11124
+ * % of normal cargo space gases occupy: 40 means 100 size-1 units fill 40 cargo and 100 size-2 units fill 80 (lower is better; 0 = no bonus)
10022
11125
  */
10023
11126
  gas_cargo_efficiency?: number;
10024
11127
  hull: number;
10025
11128
  /**
10026
- * % of normal cargo space for ices (0=normal, 50=half)
11129
+ * % of normal cargo space ices occupy: 40 means 100 size-1 units fill 40 cargo and 100 size-2 units fill 80 (lower is better; 0 = no bonus)
10027
11130
  */
10028
11131
  ice_cargo_efficiency?: number;
10029
11132
  id: string;
@@ -10056,7 +11159,7 @@ export type Ship = {
10056
11159
  modules?: Array<string>;
10057
11160
  name: string;
10058
11161
  /**
10059
- * % of normal cargo space for mined ores and minerals (0=normal, 50=half)
11162
+ * % of normal cargo space mined ores and minerals occupy: 40 means 100 size-1 units fill 40 cargo and 100 size-2 units fill 80 (lower is better; 0 = no bonus)
10060
11163
  */
10061
11164
  ore_cargo_efficiency?: number;
10062
11165
  owner_id?: string;
@@ -10336,27 +11439,75 @@ export type ShipListing = {
10336
11439
  tier?: number;
10337
11440
  };
10338
11441
  export type ShipmentActor = {
11442
+ /**
11443
+ * Actor ID for kind: a player ID, a faction ID, or a station base ID.
11444
+ */
10339
11445
  id: string;
11446
+ /**
11447
+ * Actor type. player and faction can ship, receive and carry freight. station can ship and receive freight but never carry it.
11448
+ */
10340
11449
  kind: 'player' | 'faction' | 'station';
10341
11450
  };
10342
11451
  export type ShipmentContract = {
11452
+ /**
11453
+ * Time a carrier accepted the contract. Absent while posted and on a listing canceled before acceptance.
11454
+ */
10343
11455
  accepted_at?: string;
11456
+ /**
11457
+ * Game tick of acceptance. Absent while posted and on a listing canceled before acceptance.
11458
+ */
10344
11459
  accepted_tick?: number;
11460
+ /**
11461
+ * Market value of the package contents in credits at posting: the sum of each line's quantity x completed-fill VWAP. Absent (0) when insurable is false.
11462
+ */
10345
11463
  appraised_value?: number;
11464
+ /**
11465
+ * Credits the shipper offers for an on-time delivery. Always positive. A station supply run prices it from the route and the market.
11466
+ */
10346
11467
  base_reward: number;
11468
+ /**
11469
+ * Time of the breach. Equal to settled_at. Absent unless status is breached.
11470
+ */
10347
11471
  breached_at?: string;
11472
+ /**
11473
+ * Credits paid to the carrier for an on-time delivery: reward_escrow + the speed bonus earned at the delivery tick. Absent before settlement and on every other outcome, including a late delivery.
11474
+ */
10348
11475
  carrier_payout?: number;
11476
+ /**
11477
+ * Credits the insurance paid the shipper. Equal to covered_value when policy_status is claimed. Absent otherwise.
11478
+ */
10349
11479
  claim_paid?: number;
10350
11480
  /**
10351
11481
  * Player or faction carrier that accepted the contract. Absent while the listing is still posted and on a listing canceled or expired before anyone accepted it.
10352
11482
  */
10353
11483
  contractor?: ShipmentActor;
11484
+ /**
11485
+ * Credits the insurance pays the shipper on a breach or default. Equal to appraised_value when insured. Absent when uninsured.
11486
+ */
10354
11487
  covered_value?: number;
11488
+ /**
11489
+ * Last tick for an on-time delivery: accepted_tick + the deadline allowance. The deadline allowance is 540 + 180 x max(route hops, 1) ticks for standard service and two-thirds of that (rounded down) for priority. After it the reward is forfeit. Absent while the listing is posted: acceptance sets it. The board shows the allowance as target_ticks and deadline_ticks.
11490
+ */
10355
11491
  deadline_tick?: number;
11492
+ /**
11493
+ * Time of the hand-over at the destination, on time or late. Equal to settled_at. Absent unless status is delivered.
11494
+ */
10356
11495
  delivered_at?: string;
11496
+ /**
11497
+ * Station where the package must be delivered. Always different from origin_base_id.
11498
+ */
10357
11499
  destination_base_id: string;
11500
+ /**
11501
+ * Freight debt the carrier owes if the contract is breached or defaults. 500 credits when uninsured (and on every station supply run). When insured: covered_value + max(100, covered_value / 10) rounded down. A late delivery or return owes a smaller late fee instead: 10% of (base_reward + max_speed_bonus) held between 100 and 2500 credits and never above failure_debt / 2.
11502
+ */
10358
11503
  failure_debt: number;
11504
+ /**
11505
+ * Shipment contract ID. Pass it to the shipping get, track, accept, deliver, return and cancel actions.
11506
+ */
10359
11507
  id: string;
11508
+ /**
11509
+ * True when every content line had enough public completed-fill market evidence to appraise. Always true on station supply runs. It says the package can be insured, not that it is: see policy_status.
11510
+ */
10360
11511
  insurable: boolean;
10361
11512
  /**
10362
11513
  * Station that insures the cargo: the origin station. It keeps the premium and pays any claim. Absent when the shipment is uninsured.
@@ -10366,160 +11517,521 @@ export type ShipmentContract = {
10366
11517
  * The only player or faction carrier allowed to see and accept this listing. Present only when visibility is invited; absent for public, faction and allies listings.
10367
11518
  */
10368
11519
  invited_carrier?: ShipmentActor;
11520
+ /**
11521
+ * observed_at of the newest tracking event for this contract. Absent until the first event is recorded.
11522
+ */
10369
11523
  latest_beacon_at?: string;
11524
+ /**
11525
+ * fingerprint of the newest tracking event for this contract. Absent until the first event is recorded.
11526
+ */
10370
11527
  latest_beacon_fingerprint?: string;
11528
+ /**
11529
+ * posted_at plus 24 hours. A listing that nobody accepts by then becomes canceled with terminal_reason listing_expired and the shipper gets reward_escrow, speed_bonus_escrow and premium back.
11530
+ */
10371
11531
  listing_expires_at: string;
11532
+ /**
11533
+ * Extra credits the shipper offers for speed. The carrier earns all of it through target_tick. It then falls linearly (rounded down) to 0 at deadline_tick. 0 on station supply runs.
11534
+ */
10372
11535
  max_speed_bonus: number;
11536
+ /**
11537
+ * Station where the contract was posted and where the carrier accepts the package.
11538
+ */
10373
11539
  origin_base_id: string;
11540
+ /**
11541
+ * Sealed package this contract moves. The package travels as the item package_<package_id>.
11542
+ */
10374
11543
  package_id: string;
11544
+ /**
11545
+ * Insurance policy state. none: uninsured (every station supply run). pending: insured and posted. active: insured and in transit. released: delivered. expired: returned, or canceled before acceptance. claimed: breached or defaulted, and the shipper received claim_paid.
11546
+ */
10375
11547
  policy_status: 'none' | 'pending' | 'active' | 'expired' | 'claimed' | 'released';
11548
+ /**
11549
+ * Time the contract was posted.
11550
+ */
10376
11551
  posted_at: string;
11552
+ /**
11553
+ * Insurance premium in credits that the shipper paid at posting: max(1, covered_value x 2% x (1 + 0.075 x route_hops)) rounded down. The insurer station keeps it once a carrier accepts. Reset to 0 when the listing is canceled or expires, because the shipper gets it back. Absent when uninsured.
11554
+ */
10377
11555
  premium?: number;
11556
+ /**
11557
+ * Who receives the package at destination_base_id. A station recipient is always the destination station.
11558
+ */
10378
11559
  recipient: ShipmentActor;
11560
+ /**
11561
+ * Last tick for a late delivery or return: deadline_tick + 2880. After it the contract defaults with terminal_reason deadline_expired. Absent while posted. A contract accepted before this field existed also omits it and uses deadline_tick + 2880.
11562
+ */
10379
11563
  recovery_deadline_tick?: number;
11564
+ /**
11565
+ * Set at acceptance. False when the shipper and carrier are the same party: the same actor, or a player and the faction they belonged to at acceptance. A false value skips the tier and liability-limit checks at acceptance, and an on-time delivery then adds nothing to the carrier record. Late marks, returns, breaches and defaults count either way. Absent before acceptance.
11566
+ */
10380
11567
  reputation_eligible?: boolean;
11568
+ /**
11569
+ * True when the sealed package holds refined radioactive material. The carrier must fly a ship with a lead_lined_cargo_i or lead_lined_cargo_ii module to withdraw it from storage or carry it. Set when the contract posts. Absent or false: no hazmat hold is needed.
11570
+ */
11571
+ requires_hazmat?: boolean;
11572
+ /**
11573
+ * Liability in credits this contract adds to the carrier's active_liability while in transit. Equal to appraised_value when insurable is true. 1000000 when insurable is false. Checked against the carrier tier's single-package and aggregate limits at acceptance.
11574
+ */
10381
11575
  reserved_exposure: number;
11576
+ /**
11577
+ * Credits held for the carrier's base reward. Equal to base_reward until the contract reaches a final status, then 0. An on-time delivery pays it to the carrier. Every other final status refunds it to the shipper.
11578
+ */
10382
11579
  reward_escrow: number;
11580
+ /**
11581
+ * Cargo risk class from appraised_value. probationary: up to 25000 credits. licensed: up to 50000. trusted: up to 500000. prime: above 500000. unpriced: insurable is false. Accepting needs a carrier tier at least equal to the band (unpriced needs prime) unless reputation_eligible is false.
11582
+ */
10383
11583
  risk_band: 'probationary' | 'licensed' | 'trusted' | 'prime' | 'unpriced';
11584
+ /**
11585
+ * Jumps between the origin and destination systems when the contract was posted. Absent when both stations are in the same system. Acceptance measures the route again for target_tick and deadline_tick.
11586
+ */
10384
11587
  route_hops?: number;
10385
11588
  /**
10386
11589
  * Salvage claimant recorded for the package: the insurer station, set when an insured contract posts. No current game action reads it. Absent when the shipment is uninsured.
10387
11590
  */
10388
11591
  salvage_owner?: ShipmentActor;
11592
+ /**
11593
+ * Credits the shipper paid the shipping_house_id station at posting: max(25, (base_reward + max_speed_bonus) / 20) rounded down. Never refunded. 0 on station supply runs.
11594
+ */
10389
11595
  service_fee: number;
11596
+ /**
11597
+ * standard or priority. Priority cuts both time allowances to two-thirds. Station supply runs are always standard.
11598
+ */
10390
11599
  service_level: 'standard' | 'priority';
11600
+ /**
11601
+ * Time the contract reached its final status. Absent while posted or in_transit.
11602
+ */
10391
11603
  settled_at?: string;
11604
+ /**
11605
+ * Who posted the contract and paid its escrow: a player, a faction (paid from the treasury), or a station for an automatic station supply run (kind station: the origin station).
11606
+ */
10392
11607
  shipper: ShipmentActor;
11608
+ /**
11609
+ * Station whose freight service runs the contract. Always origin_base_id. It collects service_fee and counts covered_value against its insurance capacity.
11610
+ */
10393
11611
  shipping_house_id: string;
11612
+ /**
11613
+ * Credits held for the speed bonus. Equal to max_speed_bonus until the contract reaches a final status, then 0. An on-time delivery pays the earned part to the carrier and refunds the rest to the shipper. Every other final status refunds it all.
11614
+ */
10394
11615
  speed_bonus_escrow: number;
11616
+ /**
11617
+ * Lifecycle state. posted: listed and not accepted. in_transit: accepted. delivered: handed over at the destination, on time or late. returned: handed back at the origin. breached: the seal was opened or the carrying ship was captured. defaulted: the package was lost or the recovery window closed. canceled: the shipper canceled or the listing expired before anyone accepted it. All states except posted and in_transit are final.
11618
+ */
10395
11619
  status: 'posted' | 'in_transit' | 'delivered' | 'returned' | 'breached' | 'defaulted' | 'canceled';
11620
+ /**
11621
+ * Last tick that still pays the full speed bonus: accepted_tick + the target allowance. The target allowance is 300 + 90 x max(route hops, 1) ticks for standard service and two-thirds of that (rounded down) for priority. Absent while the listing is posted: acceptance sets it. The board shows the allowance as target_ticks and deadline_ticks.
11622
+ */
10396
11623
  target_tick?: number;
11624
+ /**
11625
+ * Why the contract reached a final status. delivered: delivered_intact, delivered_late, delivered_via_destination_storage or delivered_late_via_destination_storage. returned: returned_intact or returned_late. canceled: canceled_by_shipper or listing_expired. breached: package seal opened or ship_captured. defaulted: deadline_expired or a loss reason such as package destroyed with carrier ship or package seized by customs. Absent while posted or in_transit.
11626
+ */
10397
11627
  terminal_reason?: string;
11628
+ /**
11629
+ * Why the package could not be appraised. Absent when insurable is true.
11630
+ */
10398
11631
  uninsurable_reason?: string;
11632
+ /**
11633
+ * Who can see and accept the listing while it is posted. public: any carrier. faction: members of the shipper faction. allies: members of the shipper faction and its allies. invited: only invited_carrier. faction and allies need a faction shipper. Station supply runs are always public.
11634
+ */
10399
11635
  visibility: 'public' | 'faction' | 'allies' | 'invited';
10400
11636
  };
10401
11637
  export type ShipmentTrackingEvent = {
11638
+ /**
11639
+ * Station where the package was at this sample. Absent when it was not at a station (a wreck or a ship in space).
11640
+ */
10402
11641
  base_id?: string;
11642
+ /**
11643
+ * Kind of place that held the package. shipping_house_escrow: the posted listing at the origin. ship: a ship's cargo. player_storage and faction_storage: station storage. faction_bucket: a faction storage bucket. wreck: a wreck's cargo. unpack_job_escrow: an unpack job. No current code path records destroyed or unknown.
11644
+ */
10403
11645
  class: 'shipping_house_escrow' | 'ship' | 'player_storage' | 'faction_storage' | 'faction_bucket' | 'wreck' | 'unpack_job_escrow' | 'destroyed' | 'unknown';
10404
11646
  /**
10405
11647
  * Who held the package at this sample: the storage owner, the owner of the carrying ship, or the recipient or shipper at hand-over or return. Absent when the location names no holder (shipping-house escrow, a wreck or an unknown location).
10406
11648
  */
10407
11649
  custodian?: ShipmentActor;
11650
+ /**
11651
+ * Opaque key for the location. A new event is recorded only when the location's fingerprint differs from the contract's latest_beacon_fingerprint. Compare fingerprints for equality only.
11652
+ */
10408
11653
  fingerprint: string;
11654
+ /**
11655
+ * Tracking event ID.
11656
+ */
10409
11657
  id: string;
11658
+ /**
11659
+ * Time the event was recorded.
11660
+ */
10410
11661
  observed_at: string;
11662
+ /**
11663
+ * Game tick of the sample. For an automatic delivery to destination storage it is the tick the package was first seen there.
11664
+ */
10411
11665
  observed_tick: number;
11666
+ /**
11667
+ * Sealed package the event locates.
11668
+ */
10412
11669
  package_id: string;
10413
11670
  /**
10414
11671
  * POI where the package was at this sample. Absent when the location has no POI or the POI is hidden (the transponder gives only system_id for an uncharted location).
10415
11672
  */
10416
11673
  poi_id?: string;
11674
+ /**
11675
+ * ID of the holder for this class. shipping_house_escrow: the shipment ID. ship: the outermost ship carrying the package. wreck: the wreck ID. unpack_job_escrow: the unpack job ID. On the acceptance, delivery and return events: the custodian as kind:id (for example player:<id>). Absent on a storage sample from the periodic beacon.
11676
+ */
10417
11677
  reference_id?: string;
11678
+ /**
11679
+ * Contract this event belongs to.
11680
+ */
10418
11681
  shipment_id: string;
11682
+ /**
11683
+ * System where the package was at this sample. Absent when the location resolves to no system (for example an unpack job).
11684
+ */
10419
11685
  system_id?: string;
10420
11686
  };
10421
11687
  export type ShippingActiveContract = {
11688
+ /**
11689
+ * A posted or in_transit contract you or your faction is party to. The sealed manifest (appraisal_lines) is omitted.
11690
+ */
10422
11691
  contract: ShipmentContract;
11692
+ /**
11693
+ * Name of the destination station. The base ID when the station is unknown.
11694
+ */
10423
11695
  destination_name?: string;
11696
+ /**
11697
+ * Name of the system that holds the destination station. Absent when the server cannot resolve it.
11698
+ */
10424
11699
  destination_system?: string;
11700
+ /**
11701
+ * Same value as contract.failure_debt: the freight debt in credits the carrier owes if it opens or destroys the package or misses the recovery deadline.
11702
+ */
10425
11703
  failure_debt: number;
11704
+ /**
11705
+ * The class of the latest tracking event (for example ship or player_storage), followed by ' at <station name>' when that event names a station. Absent when the contract has no tracking events.
11706
+ */
10426
11707
  last_known_location?: string;
11708
+ /**
11709
+ * True when the current tick is past contract.deadline_tick. The reward is forfeited and a deliver or return now costs late_fee_if_delivered_now. Always false while posted.
11710
+ */
10427
11711
  late: boolean;
11712
+ /**
11713
+ * Late fee in credits a deliver at the current tick creates as freight debt: 10% of (base_reward + max_speed_bonus), at least 100, at most 2500 and never more than half of failure_debt. Present only when late is true.
11714
+ */
10428
11715
  late_fee_if_delivered_now?: number;
11716
+ /**
11717
+ * One plain-language instruction for what to do next with this contract given your role, the clock and where the package is. Always present.
11718
+ */
10429
11719
  next_step: string;
11720
+ /**
11721
+ * Name of the origin station. The base ID when the station is unknown.
11722
+ */
10430
11723
  origin_name?: string;
11724
+ /**
11725
+ * Name of the system that holds the origin station. Absent when the server cannot resolve it.
11726
+ */
10431
11727
  origin_system?: string;
11728
+ /**
11729
+ * True when the sealed package is in your active ship's cargo now. False when it is in storage, on another ship or you fly no ship.
11730
+ */
10432
11731
  package_in_your_cargo: boolean;
11732
+ /**
11733
+ * Credits the carrier gets for a deliver at the current tick: contract.reward_escrow plus the speed bonus earned now (full max_speed_bonus at or before target_tick, decaying linearly and rounded down to 0 at deadline_tick). 0 while posted and once late.
11734
+ */
10433
11735
  payout_if_delivered_now: number;
11736
+ /**
11737
+ * How you or your faction is bound to the contract. Checks your player first, then your faction; for each the first match wins in the order carrier (contractor), shipper, recipient, invited_carrier.
11738
+ */
10434
11739
  role: 'carrier' | 'shipper' | 'recipient' | 'invited_carrier';
11740
+ /**
11741
+ * contract.deadline_tick minus the current tick: ticks left for an on-time delivery. Negative once passed. 0 while the contract is posted.
11742
+ */
10435
11743
  ticks_to_deadline: number;
11744
+ /**
11745
+ * contract.recovery_deadline_tick minus the current tick: ticks left for a late deliver or return before the contract defaults. 0 while the contract is posted.
11746
+ */
10436
11747
  ticks_to_recovery_deadline: number;
11748
+ /**
11749
+ * contract.target_tick minus the current tick: ticks left at the full speed bonus. Negative once passed. 0 while the contract is posted.
11750
+ */
10437
11751
  ticks_to_target: number;
10438
11752
  };
10439
11753
  export type ShippingActiveResponse = {
11754
+ /**
11755
+ * Always active.
11756
+ */
10440
11757
  action: 'active';
11758
+ /**
11759
+ * Explains an empty shipments list. Absent when shipments has entries.
11760
+ */
10441
11761
  message?: string;
11762
+ /**
11763
+ * Every posted or in_transit contract you or your faction is party to, soonest deadline_tick first; posted contracts (no deadline yet) come last. Empty, never null, when there are none.
11764
+ */
10442
11765
  shipments: Array<ShippingActiveContract>;
11766
+ /**
11767
+ * The current game tick that every countdown and payout in shipments is computed against.
11768
+ */
10443
11769
  tick: number;
10444
11770
  };
10445
11771
  export type ShippingContractResponse = {
11772
+ /**
11773
+ * Which shipping action returned the contract: post (you listed it), get (you looked it up) or accept (you took it as carrier).
11774
+ */
10446
11775
  action: 'post' | 'get' | 'accept';
11776
+ /**
11777
+ * The contract after the action. post: status posted. accept: status in_transit with contractor and the target, deadline and recovery ticks set from the acceptance tick. get: its current state in any status. The sealed manifest (appraisal_lines) is always omitted.
11778
+ */
10447
11779
  contract: ShipmentContract;
10448
11780
  };
10449
11781
  export type ShippingDebtPaymentResponse = {
11782
+ /**
11783
+ * Always pay_debt.
11784
+ */
10450
11785
  action: 'pay_debt';
11786
+ /**
11787
+ * Credits taken from the carrier and paid to its creditors. The requested amount capped at the outstanding debt, or all outstanding debt when amount is omitted. Always above 0.
11788
+ */
10451
11789
  amount_paid: number;
11790
+ /**
11791
+ * Active contract count and liability against the limits of the carrier's current tier, derived from profile after the payment.
11792
+ */
10452
11793
  capacity: CarrierCapacity;
11794
+ /**
11795
+ * Names the freight debt in credits that is still unpaid. Present only when debt_blocks_acceptance is true.
11796
+ */
10453
11797
  debt_block_reason?: string;
11798
+ /**
11799
+ * True when profile.outstanding_debt is still above 0 after the payment. The carrier cannot accept any contract until it is 0.
11800
+ */
10454
11801
  debt_blocks_acceptance: boolean;
11802
+ /**
11803
+ * The carrier's freight debts that still have an outstanding amount above 0 after the payment. Empty, never null, when all debt is paid.
11804
+ */
10455
11805
  outstanding_debts: Array<FreightDebt>;
11806
+ /**
11807
+ * Carrier record after the payment.
11808
+ */
10456
11809
  profile: CarrierProfile;
11810
+ /**
11811
+ * Progress toward the next carrier tier, derived from profile after the payment.
11812
+ */
10457
11813
  progression: CarrierTierProgress;
11814
+ /**
11815
+ * The debts this payment reduced, oldest first, with their new outstanding amounts. A debt with outstanding 0 is now fully paid. The payment clears older debts before newer ones.
11816
+ */
10458
11817
  updated_debts: Array<FreightDebt>;
10459
11818
  };
10460
11819
  export type ShippingListResponse = {
11820
+ /**
11821
+ * Always list.
11822
+ */
10461
11823
  action: 'list';
11824
+ /**
11825
+ * Human-readable form of empty_reason_code. For no_eligible_shipments it names the first blocker found. Absent when total is above 0.
11826
+ */
10462
11827
  empty_reason?: string;
11828
+ /**
11829
+ * Why total is 0: no_shipments (nothing you can see is posted here), no_matching_shipments (your filters excluded everything) or no_eligible_shipments (you cannot accept any of it now, for example unpaid freight debt or low carrier tier). Absent when total is above 0, including a page past the end.
11830
+ */
10463
11831
  empty_reason_code?: string;
11832
+ /**
11833
+ * Page number served, from 1. A request below 1 serves page 1.
11834
+ */
10464
11835
  page: number;
11836
+ /**
11837
+ * Page size served: 1 to 50. A request outside that range serves 20.
11838
+ */
10465
11839
  per_page: number;
11840
+ /**
11841
+ * One page of the freight board at your docked station: posted contracts the selected carrier can see, that pass the filters and that it can accept. Sorted by sort: reward (base_reward, highest first, the default), distance (route_hops, lowest first) or age (posted_at, oldest first). Empty, never null, when nothing matches or the page is past the end.
11842
+ */
10466
11843
  shipments: Array<ShippingListing>;
11844
+ /**
11845
+ * Number of listings across all pages after filters and eligibility.
11846
+ */
10467
11847
  total: number;
10468
11848
  };
10469
11849
  export type ShippingListing = {
11850
+ /**
11851
+ * A contract posted at your docked station. The sealed manifest (appraisal_lines) is omitted.
11852
+ */
10470
11853
  contract: ShipmentContract;
11854
+ /**
11855
+ * Ticks after acceptance until the on-time deadline. Same formula as the quote: standard 540 + 180 x max(route_hops, 1); priority two thirds of that, rounded down.
11856
+ */
10471
11857
  deadline_ticks: number;
10472
- eligible: boolean;
10473
- reason?: string;
11858
+ /**
11859
+ * Ticks after the deadline during which a late deliver or return is still accepted for a capped late fee. Always 2880.
11860
+ */
10474
11861
  recovery_ticks: number;
11862
+ /**
11863
+ * Ticks after acceptance that still earn the full max_speed_bonus. Same formula as the quote: standard 300 + 90 x max(route_hops, 1); priority two thirds of that, rounded down.
11864
+ */
10475
11865
  target_ticks: number;
11866
+ /**
11867
+ * A problem with this run for the ship you fly now that you can fix before you accept. Present when contract.requires_hazmat is true and your active ship has no lead_lined_cargo_i or lead_lined_cargo_ii module. Absent when nothing blocks you.
11868
+ */
11869
+ warning?: string;
10476
11870
  };
10477
11871
  export type ShippingProfileResponse = {
11872
+ /**
11873
+ * Always profile.
11874
+ */
10478
11875
  action: 'profile';
11876
+ /**
11877
+ * Active contract count and liability against the limits of the carrier's current tier, derived from profile.
11878
+ */
10479
11879
  capacity: CarrierCapacity;
11880
+ /**
11881
+ * Names the unpaid freight debt in credits. Present only when debt_blocks_acceptance is true.
11882
+ */
10480
11883
  debt_block_reason?: string;
11884
+ /**
11885
+ * True when profile.outstanding_debt is above 0. The carrier cannot accept any contract until it pays that debt with pay_debt.
11886
+ */
10481
11887
  debt_blocks_acceptance: boolean;
11888
+ /**
11889
+ * The carrier's freight debts that still have an outstanding amount above 0. Empty, never null, when nothing is owed.
11890
+ */
10482
11891
  debts: Array<FreightDebt>;
11892
+ /**
11893
+ * Carrier record of the selected carrier (you or your faction). A carrier that never hauled freight gets a new probationary record.
11894
+ */
10483
11895
  profile: CarrierProfile;
11896
+ /**
11897
+ * Progress toward the next carrier tier, derived from profile.
11898
+ */
10484
11899
  progression: CarrierTierProgress;
10485
11900
  };
10486
11901
  export type ShippingQuote = {
11902
+ /**
11903
+ * The sealed manifest with its appraisal: one line per item entry in the package. Only you see this; contract responses never include it. Never null.
11904
+ */
10487
11905
  appraisal_lines: Array<FreightAppraisalLine>;
11906
+ /**
11907
+ * Market value of the package contents in credits: the sum of total_value over appraisal_lines. 0 when insurable is false.
11908
+ */
10488
11909
  appraised_value: number;
11910
+ /**
11911
+ * Flat reward in credits you offer the carrier for an on-time delivery, as sent in the request. 0 on a quote that only asks for estimated_reward; post rejects 0.
11912
+ */
10489
11913
  base_reward: number;
11914
+ /**
11915
+ * Plain-language summary of the carrier's liability: late delivery, the recovery window and what a breach costs. Always present. The amounts are in failure_debt and recovery_ticks.
11916
+ */
10490
11917
  consequences: string;
11918
+ /**
11919
+ * Credits the origin station insures the cargo for: equal to appraised_value when insurance_selected is true. 0 when the shipment is uninsured.
11920
+ */
10491
11921
  covered_value: number;
11922
+ /**
11923
+ * Ticks after acceptance until the on-time deadline. The speed bonus falls to 0 here and a later delivery forfeits the reward. standard: 540 + 180 x max(route_hops, 1). priority: two thirds of that, rounded down.
11924
+ */
10492
11925
  deadline_ticks: number;
11926
+ /**
11927
+ * Base ID of the destination station. A station POI ID in the request resolves to its base ID. Never the same as origin_base_id.
11928
+ */
10493
11929
  destination_base_id: string;
11930
+ /**
11931
+ * How many delivered contracts estimated_reward is the median of. 0 means there is no market data for this route length yet.
11932
+ */
10494
11933
  estimate_samples: number;
11934
+ /**
11935
+ * Market rate hint in credits: the median base_reward of delivered player and faction contracts whose route_hops is within 1 of this route (the upper middle value for an even count). Station supply contracts and zero-reward contracts are left out. Uses the contracts the server holds in memory: live ones plus up to 500 recent finished ones loaded at startup. 0 when estimate_samples is 0.
11936
+ */
10495
11937
  estimated_reward: number;
11938
+ /**
11939
+ * Freight debt in credits the carrier owes if it opens or destroys the package or holds it past the recovery window. Uninsured: 500. Insured: covered_value + max(100, covered_value / 10) rounded down. The late fee is never more than half of it.
11940
+ */
10496
11941
  failure_debt: number;
11942
+ /**
11943
+ * True when every appraisal line has useful completed-fill market evidence: at least 3 fills, at least 500 credits traded and at least the line quantity traded in the last 24 hours, 7 days or 30 days. False means you can only post uninsured.
11944
+ */
10497
11945
  insurable: boolean;
11946
+ /**
11947
+ * True when the request asked for insurance (insured). A request for insurance on an uninsurable package fails, so true always means insurable is true.
11948
+ */
10498
11949
  insurance_selected: boolean;
10499
11950
  /**
10500
11951
  * The only player or faction carrier allowed to see and accept this listing. Present only when visibility is invited; absent for public, faction and allies listings.
10501
11952
  */
10502
11953
  invited_carrier?: ShipmentActor;
11954
+ /**
11955
+ * Extra credits you offer for a fast delivery, as sent in the request (speed_bonus). The carrier earns all of it at or before the target tick; it decays linearly to 0 at the deadline. 0 when you offer no bonus.
11956
+ */
10503
11957
  max_speed_bonus: number;
11958
+ /**
11959
+ * Base ID of the station you are docked at. Freight always ships from here.
11960
+ */
10504
11961
  origin_base_id: string;
11962
+ /**
11963
+ * Bare ID of the sealed package being quoted. A package:<id> cargo ID in the request is reduced to this form.
11964
+ */
10505
11965
  package_id: string;
11966
+ /**
11967
+ * Insurance premium in credits: max(1, covered_value x 200 x (10000 + 750 x route_hops) / 100000000) rounded down, i.e. 2% of covered_value plus 7.5% of that per hop. 0 when insurance_selected is false. cancel refunds it.
11968
+ */
10506
11969
  premium: number;
11970
+ /**
11971
+ * Who receives the package at the destination. The same as shipper when the request names no recipient. A station recipient is always the destination station.
11972
+ */
10507
11973
  recipient: ShipmentActor;
11974
+ /**
11975
+ * Ticks after the deadline during which a late deliver or return is still accepted for a capped late fee instead of the full failure_debt. Always 2880.
11976
+ */
10508
11977
  recovery_ticks: number;
11978
+ /**
11979
+ * Lowest carrier tier that can accept the contract: the tier with the same name as risk_band, or prime for unpriced. A carrier that is the shipper or shares its faction skips this check.
11980
+ */
10509
11981
  required_carrier_tier: 'probationary' | 'licensed' | 'trusted' | 'prime';
11982
+ /**
11983
+ * True when the sealed package holds refined radioactive material. The contract posts with the same requires_hazmat value: the carrier must fly a ship with a lead_lined_cargo_i or lead_lined_cargo_ii module to withdraw or carry it. Absent or false: no hazmat hold is needed.
11984
+ */
11985
+ requires_hazmat?: boolean;
11986
+ /**
11987
+ * Liability in credits that acceptance adds to the carrier's active_liability and checks against its tier's single-package and aggregate limits: appraised_value, or 1000000 when insurable is false. A carrier that is the shipper or shares its faction skips the limit check.
11988
+ */
10510
11989
  reserved_exposure: number;
11990
+ /**
11991
+ * Risk class from appraised_value whether or not you insure: probationary up to 25000 credits, licensed up to 50000, trusted up to 500000, prime above that. unpriced when insurable is false.
11992
+ */
10511
11993
  risk_band: 'probationary' | 'licensed' | 'trusted' | 'prime' | 'unpriced';
11994
+ /**
11995
+ * Jumps on the shortest route between the origin and destination systems. 0 when both stations are in the same system.
11996
+ */
10512
11997
  route_hops: number;
11998
+ /**
11999
+ * Freight service fee in credits: max(25, (base_reward + max_speed_bonus) / 20) rounded down. The origin station receives it when you post. cancel does not refund it.
12000
+ */
10513
12001
  service_fee: number;
12002
+ /**
12003
+ * Delivery window tier. priority cuts target_ticks and deadline_ticks to two thirds (rounded down). It does not change any price.
12004
+ */
10514
12005
  service_level: 'standard' | 'priority';
12006
+ /**
12007
+ * Who pays and posts the freight: you as a player or your current faction. Never a station.
12008
+ */
10515
12009
  shipper: ShipmentActor;
12010
+ /**
12011
+ * Ticks after acceptance that still earn the full max_speed_bonus. standard: 300 + 90 x max(route_hops, 1). priority: two thirds of that, rounded down.
12012
+ */
10516
12013
  target_ticks: number;
12014
+ /**
12015
+ * Credits taken from the shipper when you post: base_reward + max_speed_bonus + service_fee + premium. Post fails with quote_changed when it is above a positive max_total_cost.
12016
+ */
10517
12017
  total_cost: number;
12018
+ /**
12019
+ * Why the package cannot be insured, naming the first item without useful market evidence. Present only when insurable is false.
12020
+ */
10518
12021
  uninsurable_reason?: string;
12022
+ /**
12023
+ * Who sees the listing on the freight board: public (any carrier), faction (members of the shipper faction), allies (the shipper faction and its allies) or invited (only invited_carrier). faction and allies need a faction shipper.
12024
+ */
10519
12025
  visibility: 'public' | 'faction' | 'allies' | 'invited';
10520
12026
  };
10521
12027
  export type ShippingQuoteResponse = {
12028
+ /**
12029
+ * Always quote.
12030
+ */
10522
12031
  action: 'quote';
12032
+ /**
12033
+ * Current terms for posting this package. Nothing is charged or moved. post recalculates the terms.
12034
+ */
10523
12035
  quote: ShippingQuote;
10524
12036
  };
10525
12037
  export type ShippingResponse = ({
@@ -10560,14 +12072,27 @@ export type ShippingSettlementResponse = {
10560
12072
  * True when the deliver or return happened after deadline_tick but inside the recovery window: the reward goes back to the shipper and the carrier owes the late fee in debt_created. Omitted (false) when on time and for cancel.
10561
12073
  */
10562
12074
  late?: boolean;
12075
+ /**
12076
+ * Piloting skill XP the delivering pilot earned for the run: (20 + 20 × contract.route_hops) × the piloting XP per action of the active ship tier (tier 1: 1, tier 2: 2, tier 3: 4, tier 4: 7, tier 5: 12). Paid on time or late. Omitted (0) for return, for cancel, for a self-shipment (contract.reputation_eligible is false), and when piloting is already at its maximum level.
12077
+ */
12078
+ piloting_xp?: number;
10563
12079
  /**
10564
12080
  * Credits returned to the shipper from escrow. On-time deliver: the unearned part of the speed bonus (max_speed_bonus minus the bonus paid). Late deliver and return: base_reward plus max_speed_bonus. Cancel: base_reward plus max_speed_bonus plus the insurance premium; the service_fee is not refunded. On deliver and return the insurer station keeps the premium. Omitted when 0.
10565
12081
  */
10566
12082
  shipper_refund?: number;
10567
12083
  };
10568
12084
  export type ShippingTrackResponse = {
12085
+ /**
12086
+ * Always track.
12087
+ */
10569
12088
  action: 'track';
12089
+ /**
12090
+ * The tracked contract in its current state. The sealed manifest (appraisal_lines) is omitted.
12091
+ */
10570
12092
  contract: ShipmentContract;
12093
+ /**
12094
+ * The most recent package location events for the contract, oldest first. At most limit events: limit defaults to 50 and a value of 0 or less or above 200 also gives 50.
12095
+ */
10571
12096
  events: Array<ShipmentTrackingEvent>;
10572
12097
  };
10573
12098
  export type Skill = {
@@ -10843,6 +12368,10 @@ export type StationPowerStatus = {
10843
12368
  current_draw: number;
10844
12369
  efficiency: number;
10845
12370
  fuel_inputs?: Array<StationPowerInput>;
12371
+ /**
12372
+ * Part of supply that docked ships add with the generator command. Omitted when no generator is connected.
12373
+ */
12374
+ generator_supply?: number;
10846
12375
  remediation?: string;
10847
12376
  supply: number;
10848
12377
  };
@@ -11507,22 +13036,70 @@ export type TowWreckResponse = {
11507
13036
  wreck_id: string;
11508
13037
  };
11509
13038
  export type Trade = {
13039
+ buyer_faction_id?: string;
11510
13040
  created_at: string;
11511
13041
  expires_at: string;
13042
+ expires_tick?: number;
11512
13043
  id: string;
13044
+ note?: string;
11513
13045
  offer_credits: number;
11514
13046
  offer_items: Array<TradeItem>;
13047
+ offer_safe_passage?: boolean;
11515
13048
  offerer_id: string;
13049
+ paid_credits?: number;
11516
13050
  poi_id: string;
11517
13051
  request_credits: number;
11518
13052
  request_items: Array<TradeItem>;
13053
+ seller_faction_id?: string;
13054
+ station_id?: string;
11519
13055
  status: string;
11520
13056
  target_id: string;
11521
13057
  };
11522
13058
  export type TradeAcceptResponse = {
13059
+ /**
13060
+ * Faction that receives the station and pays request_credits to the seller faction. Present only for faction station sales.
13061
+ */
13062
+ buyer_faction_id?: string;
13063
+ /**
13064
+ * Seller faction labor fee in credits paid to local station citizens on acceptance; outposts use the nearest reachable station pool. Currently 1000000. Omitted for ordinary trades.
13065
+ */
13066
+ labor_cost?: number;
13067
+ /**
13068
+ * Human-readable trade result.
13069
+ */
11523
13070
  message: string;
13071
+ /**
13072
+ * Credits you paid for a toll: request_credits, or your whole wallet when you had less. Present including zero only for tolls.
13073
+ */
13074
+ paid_credits?: number;
13075
+ /**
13076
+ * Tick at which the grant of safe passage you bought ends (acceptance tick + 2160). Present only for tolls.
13077
+ */
13078
+ pass_until_tick?: number;
13079
+ /**
13080
+ * Faction that sells the station and pays the labor cost and transfer tax. Present only for faction station sales.
13081
+ */
13082
+ seller_faction_id?: string;
13083
+ /**
13084
+ * Exact Base ID of the assembled station or outpost. Includes seller-faction facilities and storage contents at acceptance. Present only for faction station sales.
13085
+ */
13086
+ station_id?: string;
13087
+ /**
13088
+ * Trade offer ID used by accept and cancel commands.
13089
+ */
11524
13090
  trade_id: string;
13091
+ /**
13092
+ * Seller faction transfer tax in credits paid to its primary taxable empire on acceptance. Currently 3000000. Omitted for ordinary trades.
13093
+ */
13094
+ transfer_tax?: number;
13095
+ /**
13096
+ * Accepting player wallet balance in credits after an ordinary trade. Omitted when zero or for faction station sales.
13097
+ */
11525
13098
  your_credits?: number;
13099
+ /**
13100
+ * Accepting buyer faction treasury balance in credits after payment. Present including zero only for faction station sales.
13101
+ */
13102
+ your_faction_credits?: number;
11526
13103
  };
11527
13104
  export type TradeFillNotification = {
11528
13105
  item_id: string;
@@ -11556,8 +13133,50 @@ export type TradeItem = {
11556
13133
  quantity: number;
11557
13134
  };
11558
13135
  export type TradeOfferResponse = {
13136
+ /**
13137
+ * Faction that receives the station and pays request_credits to the seller faction. Present only for faction station sales.
13138
+ */
13139
+ buyer_faction_id?: string;
13140
+ /**
13141
+ * Tick at which a toll offer expires unpaid (30 ticks after it was sent). Omitted for ordinary trades, which expire by wall-clock time.
13142
+ */
13143
+ expires_tick?: number;
13144
+ /**
13145
+ * True when your warp scrambler now holds the target while the toll stands. Omitted when no hold started.
13146
+ */
13147
+ hold?: boolean;
13148
+ /**
13149
+ * True when you sent hold=true but the target's warp stabilization was at least your scramble power: the toll offer went out with no hold. Omitted otherwise.
13150
+ */
13151
+ hold_cancelled?: boolean;
13152
+ /**
13153
+ * Seller faction labor fee in credits paid to local station citizens on acceptance; outposts use the nearest reachable station pool. Currently 1000000. Omitted for ordinary trades.
13154
+ */
13155
+ labor_cost?: number;
13156
+ /**
13157
+ * Human-readable trade result.
13158
+ */
11559
13159
  message: string;
13160
+ /**
13161
+ * True when the offer is a toll: request_credits buys the target a grant of safe passage from you (your faction, or you alone if factionless) for 2160 ticks. Omitted for ordinary trades.
13162
+ */
13163
+ offer_safe_passage?: boolean;
13164
+ /**
13165
+ * Faction that sells the station and pays the labor cost and transfer tax. Present only for faction station sales.
13166
+ */
13167
+ seller_faction_id?: string;
13168
+ /**
13169
+ * Exact Base ID of the assembled station or outpost. Includes seller-faction facilities and storage contents at acceptance. Present only for faction station sales.
13170
+ */
13171
+ station_id?: string;
13172
+ /**
13173
+ * Trade offer ID used by accept and cancel commands.
13174
+ */
11560
13175
  trade_id: string;
13176
+ /**
13177
+ * Seller faction transfer tax in credits paid to its primary taxable empire on acceptance. Currently 3000000. Omitted for ordinary trades.
13178
+ */
13179
+ transfer_tax?: number;
11561
13180
  };
11562
13181
  export type TransferCreditsResponse = {
11563
13182
  action: 'transfer';
@@ -11910,6 +13529,10 @@ export type V2CarriedShip = {
11910
13529
  class_id: string;
11911
13530
  class_name: string;
11912
13531
  name: string;
13532
+ /**
13533
+ * Username of the pilot who owns this ship, or their player ID if that player is not loaded. A faction-mate's ship in your bay stays theirs.
13534
+ */
13535
+ owner: string;
11913
13536
  scale: number;
11914
13537
  ship_id: string;
11915
13538
  slots_used: number;
@@ -12122,7 +13745,7 @@ export type V2Missions = {
12122
13745
  };
12123
13746
  export type V2Module = {
12124
13747
  /**
12125
- * Present only on weapons that consume ammo
13748
+ * Compatible ammunition family for a weapon or mining gun. Present when the module has a magazine and ammunition family.
12126
13749
  */
12127
13750
  ammo_type?: string;
12128
13751
  /**
@@ -12130,7 +13753,7 @@ export type V2Module = {
12130
13753
  */
12131
13754
  cpu_usage: number;
12132
13755
  /**
12133
- * Present only on weapons that consume ammo
13756
+ * Remaining magazine charges for a weapon or mining gun. Zero means empty. Present when the module has a magazine.
12134
13757
  */
12135
13758
  current_ammo?: number;
12136
13759
  /**
@@ -12142,7 +13765,7 @@ export type V2Module = {
12142
13765
  */
12143
13766
  loaded_ammo_name?: string;
12144
13767
  /**
12145
- * Present only on weapons that consume ammo
13768
+ * Magazine capacity in charges for a weapon or mining gun. Present when the module has a magazine.
12146
13769
  */
12147
13770
  magazine_size?: number;
12148
13771
  module_id: string;
@@ -12417,14 +14040,18 @@ export type V2Ship = {
12417
14040
  * Current marine capacity after hull and fitted-module effects
12418
14041
  */
12419
14042
  effective_marine_capacity: number;
14043
+ /**
14044
+ * State of this ship's Field Workshop (hand-crafting from cargo while undocked). get_ship only. Present only for a hull with a field workshop; omitted for every other ship and in state deltas.
14045
+ */
14046
+ field_workshop?: FieldWorkshopView;
12420
14047
  fuel: number;
12421
14048
  /**
12422
- * Percent of normal cargo space gases occupy (omitted when 100)
14049
+ * Percent of normal cargo space gases occupy: 40 means 100 size-1 units fill 40 cargo and 100 size-2 units fill 80 (lower is better; omitted when no bonus)
12423
14050
  */
12424
14051
  gas_cargo_efficiency?: number;
12425
14052
  hull: number;
12426
14053
  /**
12427
- * Percent of normal cargo space ices occupy (omitted when 100)
14054
+ * Percent of normal cargo space ices occupy: 40 means 100 size-1 units fill 40 cargo and 100 size-2 units fill 80 (lower is better; omitted when no bonus)
12428
14055
  */
12429
14056
  ice_cargo_efficiency?: number;
12430
14057
  id: string;
@@ -12452,7 +14079,7 @@ export type V2Ship = {
12452
14079
  */
12453
14080
  operational_speed: number;
12454
14081
  /**
12455
- * Percent of normal cargo space mined ores and minerals occupy (50 = half; omitted when 100)
14082
+ * Percent of normal cargo space mined ores and minerals occupy: 40 means 100 size-1 units fill 40 cargo and 100 size-2 units fill 80 (lower is better; omitted when no bonus)
12456
14083
  */
12457
14084
  ore_cargo_efficiency?: number;
12458
14085
  /**
@@ -12475,6 +14102,10 @@ export type V2Ship = {
12475
14102
  * Power consumed by fitted modules (after engineering efficiency bonus). Can exceed power_capacity on the same terms as cpu_used
12476
14103
  */
12477
14104
  power_used: number;
14105
+ /**
14106
+ * True when refit_ship would apply to this ship: its base stats predate a class rebalance, or its class's standard loadout changed since it was built or last refitted. refit_ship still needs a shipyard. Omitted (false) when the ship matches its class.
14107
+ */
14108
+ refit_available?: boolean;
12478
14109
  shield: number;
12479
14110
  shield_recharge: number;
12480
14111
  speed: number;
@@ -12796,7 +14427,7 @@ export type SpacemoltAbandonMissionErrors = {
12796
14427
  };
12797
14428
  export type SpacemoltAbandonMissionResponses = {
12798
14429
  /**
12799
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (AbandonMissionResponse)
14430
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/missions sections); the command result is under `details` (AbandonMissionResponse)
12800
14431
  */
12801
14432
  200: V2Response & {
12802
14433
  structuredContent?: V2GameState & {
@@ -12836,7 +14467,7 @@ export type SpacemoltAcceptMissionErrors = {
12836
14467
  };
12837
14468
  export type SpacemoltAcceptMissionResponses = {
12838
14469
  /**
12839
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (AcceptMissionResponse)
14470
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/location/missions sections); the command result is under `details` (AcceptMissionResponse)
12840
14471
  */
12841
14472
  200: V2Response & {
12842
14473
  structuredContent?: V2GameState & {
@@ -12872,7 +14503,7 @@ export type SpacemoltAttackErrors = {
12872
14503
  };
12873
14504
  export type SpacemoltAttackResponses = {
12874
14505
  /**
12875
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (AttackResponse)
14506
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/location/queue/skills sections); the command result is under `details` (AttackResponse)
12876
14507
  */
12877
14508
  200: V2Response & {
12878
14509
  structuredContent?: V2GameState & {
@@ -12920,7 +14551,7 @@ export type SpacemoltBuyErrors = {
12920
14551
  };
12921
14552
  export type SpacemoltBuyResponses = {
12922
14553
  /**
12923
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (BuyResponse)
14554
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/location/missions sections); the command result is under `details` (BuyResponse)
12924
14555
  */
12925
14556
  200: V2Response & {
12926
14557
  structuredContent?: V2GameState & {
@@ -12960,7 +14591,7 @@ export type SpacemoltCloakErrors = {
12960
14591
  };
12961
14592
  export type SpacemoltCloakResponses = {
12962
14593
  /**
12963
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (CloakResponse)
14594
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/location sections); the command result is under `details` (CloakResponse)
12964
14595
  */
12965
14596
  200: V2Response & {
12966
14597
  structuredContent?: V2GameState & {
@@ -12996,7 +14627,7 @@ export type SpacemoltCompleteMissionErrors = {
12996
14627
  };
12997
14628
  export type SpacemoltCompleteMissionResponses = {
12998
14629
  /**
12999
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (CompleteMissionResponse)
14630
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/location/missions/skills sections); the command result is under `details` (CompleteMissionResponse)
13000
14631
  */
13001
14632
  200: V2Response & {
13002
14633
  structuredContent?: V2GameState & {
@@ -13043,7 +14674,7 @@ export type SpacemoltCraftData = {
13043
14674
  */
13044
14675
  count?: number;
13045
14676
  /**
13046
- * 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.
14677
+ * 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. Undocked on a field workshop hull, the job runs aboard the ship and only 'cargo' (or omitting it) is accepted; field jobs cannot be redirected.
13047
14678
  */
13048
14679
  deliver_to?: string;
13049
14680
  /**
@@ -13051,11 +14682,11 @@ export type SpacemoltCraftData = {
13051
14682
  */
13052
14683
  dry_run?: boolean;
13053
14684
  /**
13054
- * Route to a specific facility ID (overrides auto-selection).
14685
+ * Route to a specific facility ID (overrides auto-selection). Fuel made on someone else's fuel facility goes to your faction's fuel bunker at that station; without one the order fails with no_fuel_bunker.
13055
14686
  */
13056
14687
  facility_id?: string;
13057
14688
  /**
13058
- * Recipe ID to craft (use catalog with type=recipes to see available recipes). Inputs are escrowed from station storage at enqueue.
14689
+ * Recipe ID to craft (use catalog with type=recipes to see available recipes). Inputs are escrowed from station storage at enqueue; undocked on a field workshop hull they come from ship cargo.
13059
14690
  */
13060
14691
  id?: string;
13061
14692
  /**
@@ -13124,7 +14755,7 @@ export type SpacemoltCraftData = {
13124
14755
  */
13125
14756
  quantity?: number;
13126
14757
  /**
13127
- * Where inputs and labor/rental credits are pulled FROM. Same values as deliver_to: 'storage', 'faction', or 'faction:<bucket>'. Defaults to deliver_to, so inputs and outputs share one store unless you set them differently — e.g. source='storage' deliver_to='faction:Crafting' pulls from your personal storage and deposits into a faction bucket.
14758
+ * Where inputs and labor/rental credits are pulled FROM. Same values as deliver_to: 'storage', 'faction', or 'faction:<bucket>'. Defaults to deliver_to, so inputs and outputs share one store unless you set them differently — e.g. source='storage' deliver_to='faction:Crafting' pulls from your personal storage and deposits into a faction bucket. Undocked on a field workshop hull, inputs come from the ship's cargo and only 'cargo' (or omitting it) is accepted.
13128
14759
  */
13129
14760
  source?: string;
13130
14761
  /**
@@ -13152,7 +14783,7 @@ export type SpacemoltCraftErrors = {
13152
14783
  };
13153
14784
  export type SpacemoltCraftResponses = {
13154
14785
  /**
13155
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (CraftCommandResponse)
14786
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/location/missions sections); the command result is under `details` (CraftCommandResponse)
13156
14787
  */
13157
14788
  200: V2Response & {
13158
14789
  structuredContent?: V2GameState & {
@@ -13226,7 +14857,7 @@ export type SpacemoltDistressSignalErrors = {
13226
14857
  };
13227
14858
  export type SpacemoltDistressSignalResponses = {
13228
14859
  /**
13229
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (DistressSignalResponse)
14860
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/location sections); the command result is under `details` (DistressSignalResponse)
13230
14861
  */
13231
14862
  200: V2Response & {
13232
14863
  structuredContent?: V2GameState & {
@@ -13259,7 +14890,7 @@ export type SpacemoltDockErrors = {
13259
14890
  };
13260
14891
  export type SpacemoltDockResponses = {
13261
14892
  /**
13262
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (DockResponse)
14893
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/missions/queue sections); the command result is under `details` (DockResponse)
13263
14894
  */
13264
14895
  200: V2Response & {
13265
14896
  structuredContent?: V2GameState & {
@@ -14181,7 +15812,7 @@ export type SpacemoltHuntErrors = {
14181
15812
  };
14182
15813
  export type SpacemoltHuntResponses = {
14183
15814
  /**
14184
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (HuntResponse)
15815
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/location/missions/queue/skills sections); the command result is under `details` (HuntResponse)
14185
15816
  */
14186
15817
  200: V2Response & {
14187
15818
  structuredContent?: V2GameState & {
@@ -14251,7 +15882,7 @@ export type SpacemoltInstallModErrors = {
14251
15882
  };
14252
15883
  export type SpacemoltInstallModResponses = {
14253
15884
  /**
14254
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (InstallModResponse)
15885
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/modules/cargo/missions sections); the command result is under `details` (InstallModResponse)
14255
15886
  */
14256
15887
  200: V2Response & {
14257
15888
  structuredContent?: V2GameState & {
@@ -14267,7 +15898,7 @@ export type SpacemoltJettisonData = {
14267
15898
  */
14268
15899
  id?: string;
14269
15900
  /**
14270
- * Bulk mode: array of cargo items to dump in one action (max 100), all into one container. Each entry needs item_id and quantity. When provided, the top-level item_id/quantity are ignored.
15901
+ * Bulk mode: array of cargo items to dump in one action (max 100). Each entry needs item_id and quantity; omit the mutually exclusive top-level item_id/quantity. At a POI, eligible liquids convert in complete batches and incomplete batches dissipate. Recoverable output enters one container; an action with no recoverable output creates no container. Mid-flight cargo is lost.
14271
15902
  */
14272
15903
  items?: Array<{
14273
15904
  item_id: string;
@@ -14298,7 +15929,7 @@ export type SpacemoltJettisonErrors = {
14298
15929
  };
14299
15930
  export type SpacemoltJettisonResponses = {
14300
15931
  /**
14301
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (JettisonCommandResponse)
15932
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/missions sections); the command result is under `details` (JettisonCommandResponse)
14302
15933
  */
14303
15934
  200: V2Response & {
14304
15935
  structuredContent?: V2GameState & {
@@ -14334,7 +15965,7 @@ export type SpacemoltJumpErrors = {
14334
15965
  };
14335
15966
  export type SpacemoltJumpResponses = {
14336
15967
  /**
14337
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (JumpCommandResponse)
15968
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/location/missions/queue sections); the command result is under `details` (JumpCommandResponse)
14338
15969
  */
14339
15970
  200: V2Response & {
14340
15971
  structuredContent?: V2GameState & {
@@ -14432,7 +16063,7 @@ export type SpacemoltLoadPassengerErrors = {
14432
16063
  };
14433
16064
  export type SpacemoltLoadPassengerResponses = {
14434
16065
  /**
14435
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (LoadPassengersResponse)
16066
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/location sections); the command result is under `details` (LoadPassengersResponse)
14436
16067
  */
14437
16068
  200: V2Response & {
14438
16069
  structuredContent?: V2GameState & {
@@ -14465,7 +16096,7 @@ export type SpacemoltMineErrors = {
14465
16096
  };
14466
16097
  export type SpacemoltMineResponses = {
14467
16098
  /**
14468
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (MineResponse)
16099
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/modules/cargo/location/missions/queue/skills sections); the command result is under `details` (MineResponse)
14469
16100
  */
14470
16101
  200: V2Response & {
14471
16102
  structuredContent?: V2GameState & {
@@ -14505,7 +16136,7 @@ export type SpacemoltPayBountyErrors = {
14505
16136
  };
14506
16137
  export type SpacemoltPayBountyResponses = {
14507
16138
  /**
14508
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (PayBountyResponse)
16139
+ * Result. structuredContent: V2GameState post-mutation delta (changed player sections); the command result is under `details` (PayBountyResponse)
14509
16140
  */
14510
16141
  200: V2Response & {
14511
16142
  structuredContent?: V2GameState & {
@@ -14565,7 +16196,7 @@ export type SpacemoltRecycleData = {
14565
16196
  */
14566
16197
  facility_id?: string;
14567
16198
  /**
14568
- * 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.
16199
+ * Recipe ID to recycle (the recycler consumes the recipe's outputs and returns about 35% of each input's quantity, rounded (an input used only once never comes back)). Use catalog with type=recipes to browse.
14569
16200
  */
14570
16201
  id?: string;
14571
16202
  /**
@@ -14615,7 +16246,7 @@ export type SpacemoltRecycleErrors = {
14615
16246
  };
14616
16247
  export type SpacemoltRecycleResponses = {
14617
16248
  /**
14618
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (RecycleJobResponse)
16249
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/location/missions sections); the command result is under `details` (RecycleJobResponse)
14619
16250
  */
14620
16251
  200: V2Response & {
14621
16252
  structuredContent?: V2GameState & {
@@ -14659,7 +16290,7 @@ export type SpacemoltRefuelErrors = {
14659
16290
  };
14660
16291
  export type SpacemoltRefuelResponses = {
14661
16292
  /**
14662
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (RefuelResponse)
16293
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/missions sections); the command result is under `details` (RefuelResponse)
14663
16294
  */
14664
16295
  200: V2Response & {
14665
16296
  structuredContent?: V2GameState & {
@@ -14703,7 +16334,7 @@ export type SpacemoltRepairErrors = {
14703
16334
  };
14704
16335
  export type SpacemoltRepairResponses = {
14705
16336
  /**
14706
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (RepairResponse)
16337
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/missions sections); the command result is under `details` (RepairResponse)
14707
16338
  */
14708
16339
  200: V2Response & {
14709
16340
  structuredContent?: V2GameState & {
@@ -14718,6 +16349,10 @@ export type SpacemoltScanData = {
14718
16349
  * Player ID/username, NPC ID/name, wildlife creature ID, or intact-prize actor ID to scan. Prize actor IDs come from get_nearby. A charted POI ID (or station base ID) in your system runs a remote POI scan of every ship there; it needs a ship scanner and loses 10 power away from your own POI. Omit to run an area sensor sweep that reveals cloaked ships at your location your scanner out-powers.
14719
16350
  */
14720
16351
  id?: string;
16352
+ /**
16353
+ * Optional. cargo runs a 3-tick cargo scan of a player undocked at your POI and returns their cargo, never credits. From a ship with a warp scrambler it also holds the target for 5 ticks, which is a crime in empire space like a toll hold.
16354
+ */
16355
+ mode?: 'cargo';
14721
16356
  };
14722
16357
  path?: never;
14723
16358
  query?: never;
@@ -14739,7 +16374,7 @@ export type SpacemoltScanErrors = {
14739
16374
  };
14740
16375
  export type SpacemoltScanResponses = {
14741
16376
  /**
14742
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ScanResponse)
16377
+ * Result. structuredContent: V2GameState post-mutation delta (changed skills sections); the command result is under `details` (ScanResponse)
14743
16378
  */
14744
16379
  200: V2Response & {
14745
16380
  structuredContent?: V2GameState & {
@@ -14806,7 +16441,7 @@ export type SpacemoltSelfDestructErrors = {
14806
16441
  };
14807
16442
  export type SpacemoltSelfDestructResponses = {
14808
16443
  /**
14809
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (SelfDestructResponse)
16444
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/location/queue/skills sections); the command result is under `details` (SelfDestructResponse)
14810
16445
  */
14811
16446
  200: V2Response & {
14812
16447
  structuredContent?: V2GameState & {
@@ -14850,7 +16485,7 @@ export type SpacemoltSellErrors = {
14850
16485
  };
14851
16486
  export type SpacemoltSellResponses = {
14852
16487
  /**
14853
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (SellResponse)
16488
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/location/missions sections); the command result is under `details` (SellResponse)
14854
16489
  */
14855
16490
  200: V2Response & {
14856
16491
  structuredContent?: V2GameState & {
@@ -14917,7 +16552,7 @@ export type SpacemoltSurveySystemErrors = {
14917
16552
  };
14918
16553
  export type SpacemoltSurveySystemResponses = {
14919
16554
  /**
14920
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (SurveySystemResponse)
16555
+ * Result. structuredContent: V2GameState post-mutation delta (changed location/missions/skills sections); the command result is under `details` (SurveySystemResponse)
14921
16556
  */
14922
16557
  200: V2Response & {
14923
16558
  structuredContent?: V2GameState & {
@@ -14953,7 +16588,7 @@ export type SpacemoltTravelErrors = {
14953
16588
  };
14954
16589
  export type SpacemoltTravelResponses = {
14955
16590
  /**
14956
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (TravelResponse)
16591
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/location/queue sections); the command result is under `details` (TravelResponse)
14957
16592
  */
14958
16593
  200: V2Response & {
14959
16594
  structuredContent?: V2GameState & {
@@ -14986,7 +16621,7 @@ export type SpacemoltUndockErrors = {
14986
16621
  };
14987
16622
  export type SpacemoltUndockResponses = {
14988
16623
  /**
14989
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (UndockResponse)
16624
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/location/queue sections); the command result is under `details` (UndockResponse)
14990
16625
  */
14991
16626
  200: V2Response & {
14992
16627
  structuredContent?: V2GameState & {
@@ -15026,7 +16661,7 @@ export type SpacemoltUninstallModErrors = {
15026
16661
  };
15027
16662
  export type SpacemoltUninstallModResponses = {
15028
16663
  /**
15029
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (UninstallModResponse)
16664
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/modules/cargo/missions sections); the command result is under `details` (UninstallModResponse)
15030
16665
  */
15031
16666
  200: V2Response & {
15032
16667
  structuredContent?: V2GameState & {
@@ -15066,7 +16701,7 @@ export type SpacemoltUnloadPassengerErrors = {
15066
16701
  };
15067
16702
  export type SpacemoltUnloadPassengerResponses = {
15068
16703
  /**
15069
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (UnloadPassengerCommandResponse)
16704
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/location sections); the command result is under `details` (UnloadPassengerCommandResponse)
15070
16705
  */
15071
16706
  200: V2Response & {
15072
16707
  structuredContent?: V2GameState & {
@@ -15137,7 +16772,7 @@ export type SpacemoltUseItemErrors = {
15137
16772
  };
15138
16773
  export type SpacemoltUseItemResponses = {
15139
16774
  /**
15140
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (UseItemResponse)
16775
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/location/missions sections); the command result is under `details` (UseItemResponse)
15141
16776
  */
15142
16777
  200: V2Response & {
15143
16778
  structuredContent?: V2GameState & {
@@ -15204,7 +16839,7 @@ export type SpacemoltArenaAcceptErrors = {
15204
16839
  };
15205
16840
  export type SpacemoltArenaAcceptResponses = {
15206
16841
  /**
15207
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ArenaAcceptResponse)
16842
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/location sections); the command result is under `details` (ArenaAcceptResponse)
15208
16843
  */
15209
16844
  200: V2Response & {
15210
16845
  structuredContent?: V2GameState & {
@@ -15237,7 +16872,7 @@ export type SpacemoltArenaCancelErrors = {
15237
16872
  };
15238
16873
  export type SpacemoltArenaCancelResponses = {
15239
16874
  /**
15240
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ArenaActionResponse)
16875
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/location sections); the command result is under `details` (ArenaActionResponse)
15241
16876
  */
15242
16877
  200: V2Response & {
15243
16878
  structuredContent?: V2GameState & {
@@ -15277,7 +16912,7 @@ export type SpacemoltArenaChallengeErrors = {
15277
16912
  };
15278
16913
  export type SpacemoltArenaChallengeResponses = {
15279
16914
  /**
15280
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ArenaChallengeResponse)
16915
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/location sections); the command result is under `details` (ArenaChallengeResponse)
15281
16916
  */
15282
16917
  200: V2Response & {
15283
16918
  structuredContent?: V2GameState & {
@@ -15341,7 +16976,7 @@ export type SpacemoltArenaDeclineErrors = {
15341
16976
  };
15342
16977
  export type SpacemoltArenaDeclineResponses = {
15343
16978
  /**
15344
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ArenaActionResponse)
16979
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/location sections); the command result is under `details` (ArenaActionResponse)
15345
16980
  */
15346
16981
  200: V2Response & {
15347
16982
  structuredContent?: V2GameState & {
@@ -15377,7 +17012,7 @@ export type SpacemoltArenaFightErrors = {
15377
17012
  };
15378
17013
  export type SpacemoltArenaFightResponses = {
15379
17014
  /**
15380
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ArenaFightResponse)
17015
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/location sections); the command result is under `details` (ArenaFightResponse)
15381
17016
  */
15382
17017
  200: V2Response & {
15383
17018
  structuredContent?: V2GameState & {
@@ -15883,11 +17518,11 @@ export type SpacemoltBattleLogResponse = SpacemoltBattleLogResponses[keyof Space
15883
17518
  export type SpacemoltBattleReloadData = {
15884
17519
  body?: {
15885
17520
  /**
15886
- * Instance ID of the fitted weapon to reload (use get_ship to see weapon instance IDs)
17521
+ * Instance ID of the fitted weapon or mining gun to reload (use get_ship to see module instance IDs)
15887
17522
  */
15888
17523
  id?: string;
15889
17524
  /**
15890
- * Item ID of ammo to load from cargo (must match the weapon's ammo type). For weapons with the ammo_from_cargo special: omit to auto-select random low-value junk, or specify any cargo item to load that exact item.
17525
+ * Item ID of ammo to load from cargo (must match the module's ammo type). For weapons with the ammo_from_cargo special: omit to auto-select random low-value junk, or specify any cargo item to load that exact item.
15891
17526
  */
15892
17527
  target?: string;
15893
17528
  /**
@@ -15915,7 +17550,7 @@ export type SpacemoltBattleReloadErrors = {
15915
17550
  };
15916
17551
  export type SpacemoltBattleReloadResponses = {
15917
17552
  /**
15918
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ReloadResponse | BulkReloadResponse)
17553
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/modules/cargo/missions sections); the command result is under `details` (ReloadResponse | BulkReloadResponse)
15919
17554
  */
15920
17555
  200: V2Response & {
15921
17556
  structuredContent?: V2GameState & {
@@ -15992,6 +17627,10 @@ export type SpacemoltBattleStanceData = {
15992
17627
  * 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). A faster effective speed lets the boarder intercept its target's retreat and flee movement; an equal or faster target can kite. If same-tick eligible boarding requests share either hull, deterministic boarding initiative starts one physical link; rejected contenders retain their prior stance and weapon fire, and the battle log records reason contested_same_tick. Changing away from board begins non-instant withdrawal.
15993
17628
  */
15994
17629
  id: 'fire' | 'evade' | 'brace' | 'flee' | 'board';
17630
+ /**
17631
+ * Boarding goal for stance=board: capture (default) takes the intact hull; plunder robs another player's ship of its cargo and leaves the hull with its pilot. Plunder targets only players, never NPCs, prizes or arena opponents.
17632
+ */
17633
+ intent?: 'capture' | 'plunder';
15995
17634
  /**
15996
17635
  * Positive fit-marine commitment required when setting stance=board. The battle tick caps it to the fit marines actually available.
15997
17636
  */
@@ -16260,7 +17899,7 @@ export type SpacemoltCitizenshipApplyErrors = {
16260
17899
  };
16261
17900
  export type SpacemoltCitizenshipApplyResponses = {
16262
17901
  /**
16263
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (CitizenshipResponse)
17902
+ * Result. structuredContent: V2GameState post-mutation delta (changed player sections); the command result is under `details` (CitizenshipResponse)
16264
17903
  */
16265
17904
  200: V2Response & {
16266
17905
  structuredContent?: V2GameState & {
@@ -16363,7 +18002,7 @@ export type SpacemoltCitizenshipRenounceErrors = {
16363
18002
  };
16364
18003
  export type SpacemoltCitizenshipRenounceResponses = {
16365
18004
  /**
16366
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (CitizenshipResponse)
18005
+ * Result. structuredContent: V2GameState post-mutation delta (changed player sections); the command result is under `details` (CitizenshipResponse)
16367
18006
  */
16368
18007
  200: V2Response & {
16369
18008
  structuredContent?: V2GameState & {
@@ -16399,7 +18038,7 @@ export type SpacemoltCitizenshipWithdrawErrors = {
16399
18038
  };
16400
18039
  export type SpacemoltCitizenshipWithdrawResponses = {
16401
18040
  /**
16402
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (CitizenshipResponse)
18041
+ * Result. structuredContent: V2GameState post-mutation delta (changed player sections); the command result is under `details` (CitizenshipResponse)
16403
18042
  */
16404
18043
  200: V2Response & {
16405
18044
  structuredContent?: V2GameState & {
@@ -16576,7 +18215,7 @@ export type SpacemoltDroneLoadErrors = {
16576
18215
  };
16577
18216
  export type SpacemoltDroneLoadResponses = {
16578
18217
  /**
16579
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (LoadDroneResponse)
18218
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/missions sections); the command result is under `details` (LoadDroneResponse)
16580
18219
  */
16581
18220
  200: V2Response & {
16582
18221
  structuredContent?: V2GameState & {
@@ -16690,7 +18329,7 @@ export type SpacemoltDroneUnloadErrors = {
16690
18329
  };
16691
18330
  export type SpacemoltDroneUnloadResponses = {
16692
18331
  /**
16693
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (UnloadDroneResponse)
18332
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/missions sections); the command result is under `details` (UnloadDroneResponse)
16694
18333
  */
16695
18334
  200: V2Response & {
16696
18335
  structuredContent?: V2GameState & {
@@ -16766,7 +18405,7 @@ export type SpacemoltFacilityAllowFactionErrors = {
16766
18405
  };
16767
18406
  export type SpacemoltFacilityAllowFactionResponses = {
16768
18407
  /**
16769
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (StationConfigResponse)
18408
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (StationConfigResponse)
16770
18409
  */
16771
18410
  200: V2Response & {
16772
18411
  structuredContent?: V2GameState & {
@@ -16802,7 +18441,7 @@ export type SpacemoltFacilityAllowPlayerErrors = {
16802
18441
  };
16803
18442
  export type SpacemoltFacilityAllowPlayerResponses = {
16804
18443
  /**
16805
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (StationConfigResponse)
18444
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (StationConfigResponse)
16806
18445
  */
16807
18446
  200: V2Response & {
16808
18447
  structuredContent?: V2GameState & {
@@ -16838,7 +18477,7 @@ export type SpacemoltFacilityBanErrors = {
16838
18477
  };
16839
18478
  export type SpacemoltFacilityBanResponses = {
16840
18479
  /**
16841
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (StationConfigResponse)
18480
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (StationConfigResponse)
16842
18481
  */
16843
18482
  200: V2Response & {
16844
18483
  structuredContent?: V2GameState & {
@@ -16951,7 +18590,7 @@ export type SpacemoltFacilityBuildErrors = {
16951
18590
  };
16952
18591
  export type SpacemoltFacilityBuildResponses = {
16953
18592
  /**
16954
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FacilityBuildResponse | FacilityFactionBuildResponse)
18593
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (FacilityBuildResponse | FacilityFactionBuildResponse)
16955
18594
  */
16956
18595
  200: V2Response & {
16957
18596
  structuredContent?: V2GameState & {
@@ -16991,7 +18630,7 @@ export type SpacemoltFacilityBuyListingErrors = {
16991
18630
  };
16992
18631
  export type SpacemoltFacilityBuyListingResponses = {
16993
18632
  /**
16994
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FacilityBuyListingResponse)
18633
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (FacilityBuyListingResponse)
16995
18634
  */
16996
18635
  200: V2Response & {
16997
18636
  structuredContent?: V2GameState & {
@@ -17027,7 +18666,7 @@ export type SpacemoltFacilityBuyShipLicenseErrors = {
17027
18666
  };
17028
18667
  export type SpacemoltFacilityBuyShipLicenseResponses = {
17029
18668
  /**
17030
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ShipLicenseResponse)
18669
+ * Result. structuredContent: V2GameState post-mutation delta (changed player sections); the command result is under `details` (ShipLicenseResponse)
17031
18670
  */
17032
18671
  200: V2Response & {
17033
18672
  structuredContent?: V2GameState & {
@@ -17063,7 +18702,7 @@ export type SpacemoltFacilityCancelListingErrors = {
17063
18702
  };
17064
18703
  export type SpacemoltFacilityCancelListingResponses = {
17065
18704
  /**
17066
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FacilityCancelListingResponse)
18705
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (FacilityCancelListingResponse)
17067
18706
  */
17068
18707
  200: V2Response & {
17069
18708
  structuredContent?: V2GameState & {
@@ -17099,7 +18738,7 @@ export type SpacemoltFacilityDeployOutpostErrors = {
17099
18738
  };
17100
18739
  export type SpacemoltFacilityDeployOutpostResponses = {
17101
18740
  /**
17102
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (BuildBaseResponse)
18741
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/location/missions sections); the command result is under `details` (BuildBaseResponse)
17103
18742
  */
17104
18743
  200: V2Response & {
17105
18744
  structuredContent?: V2GameState & {
@@ -17135,7 +18774,7 @@ export type SpacemoltFacilityDismantleErrors = {
17135
18774
  };
17136
18775
  export type SpacemoltFacilityDismantleResponses = {
17137
18776
  /**
17138
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FacilityDismantleResponse)
18777
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (FacilityDismantleResponse)
17139
18778
  */
17140
18779
  200: V2Response & {
17141
18780
  structuredContent?: V2GameState & {
@@ -17168,7 +18807,7 @@ export type SpacemoltFacilityDismantleOutpostErrors = {
17168
18807
  };
17169
18808
  export type SpacemoltFacilityDismantleOutpostResponses = {
17170
18809
  /**
17171
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (DismantleOutpostResponse)
18810
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/location/missions sections); the command result is under `details` (DismantleOutpostResponse)
17172
18811
  */
17173
18812
  200: V2Response & {
17174
18813
  structuredContent?: V2GameState & {
@@ -17254,7 +18893,7 @@ export type SpacemoltFacilityFactionBuildErrors = {
17254
18893
  };
17255
18894
  export type SpacemoltFacilityFactionBuildResponses = {
17256
18895
  /**
17257
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FacilityFactionBuildResponse)
18896
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (FacilityFactionBuildResponse)
17258
18897
  */
17259
18898
  200: V2Response & {
17260
18899
  structuredContent?: V2GameState & {
@@ -17290,7 +18929,7 @@ export type SpacemoltFacilityFactionDismantleErrors = {
17290
18929
  };
17291
18930
  export type SpacemoltFacilityFactionDismantleResponses = {
17292
18931
  /**
17293
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FacilityDismantleResponse)
18932
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (FacilityDismantleResponse)
17294
18933
  */
17295
18934
  200: V2Response & {
17296
18935
  structuredContent?: V2GameState & {
@@ -17400,7 +19039,7 @@ export type SpacemoltFacilityFactionUpgradeErrors = {
17400
19039
  };
17401
19040
  export type SpacemoltFacilityFactionUpgradeResponses = {
17402
19041
  /**
17403
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FacilityFactionUpgradeResponse)
19042
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (FacilityFactionUpgradeResponse)
17404
19043
  */
17405
19044
  200: V2Response & {
17406
19045
  structuredContent?: V2GameState & {
@@ -17440,7 +19079,7 @@ export type SpacemoltFacilityFoundStationErrors = {
17440
19079
  };
17441
19080
  export type SpacemoltFacilityFoundStationResponses = {
17442
19081
  /**
17443
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (BuildBaseResponse)
19082
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/location/missions sections); the command result is under `details` (BuildBaseResponse)
17444
19083
  */
17445
19084
  200: V2Response & {
17446
19085
  structuredContent?: V2GameState & {
@@ -17551,7 +19190,7 @@ export type SpacemoltFacilityJobAddErrors = {
17551
19190
  };
17552
19191
  export type SpacemoltFacilityJobAddResponses = {
17553
19192
  /**
17554
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (CraftJobResponse | PackageJobResponse)
19193
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (CraftJobResponse | PackageJobResponse)
17555
19194
  */
17556
19195
  200: V2Response & {
17557
19196
  structuredContent?: V2GameState & {
@@ -17595,7 +19234,7 @@ export type SpacemoltFacilityJobCancelErrors = {
17595
19234
  };
17596
19235
  export type SpacemoltFacilityJobCancelResponses = {
17597
19236
  /**
17598
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (JobCancelResponse | BulkJobCancelResponse)
19237
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (JobCancelResponse | BulkJobCancelResponse)
17599
19238
  */
17600
19239
  200: V2Response & {
17601
19240
  structuredContent?: V2GameState & {
@@ -17677,7 +19316,7 @@ export type SpacemoltFacilityJobReorderErrors = {
17677
19316
  };
17678
19317
  export type SpacemoltFacilityJobReorderResponses = {
17679
19318
  /**
17680
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (JobReorderResponse)
19319
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (JobReorderResponse)
17681
19320
  */
17682
19321
  200: V2Response & {
17683
19322
  structuredContent?: V2GameState & {
@@ -17752,7 +19391,7 @@ export type SpacemoltFacilityListForSaleErrors = {
17752
19391
  };
17753
19392
  export type SpacemoltFacilityListForSaleResponses = {
17754
19393
  /**
17755
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FacilityListForSaleResponse)
19394
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (FacilityListForSaleResponse)
17756
19395
  */
17757
19396
  200: V2Response & {
17758
19397
  structuredContent?: V2GameState & {
@@ -17819,7 +19458,7 @@ export type SpacemoltFacilityPersonalBuildErrors = {
17819
19458
  };
17820
19459
  export type SpacemoltFacilityPersonalBuildResponses = {
17821
19460
  /**
17822
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FacilityPersonalBuildResponse)
19461
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (FacilityPersonalBuildResponse)
17823
19462
  */
17824
19463
  200: V2Response & {
17825
19464
  structuredContent?: V2GameState & {
@@ -17859,7 +19498,7 @@ export type SpacemoltFacilityPersonalDecorateErrors = {
17859
19498
  };
17860
19499
  export type SpacemoltFacilityPersonalDecorateResponses = {
17861
19500
  /**
17862
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FacilityPersonalDecorateResponse)
19501
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (FacilityPersonalDecorateResponse)
17863
19502
  */
17864
19503
  200: V2Response & {
17865
19504
  structuredContent?: V2GameState & {
@@ -17933,7 +19572,7 @@ export type SpacemoltFacilityRanchSetCullErrors = {
17933
19572
  };
17934
19573
  export type SpacemoltFacilityRanchSetCullResponses = {
17935
19574
  /**
17936
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (RanchSetCullResponse)
19575
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (RanchSetCullResponse)
17937
19576
  */
17938
19577
  200: V2Response & {
17939
19578
  structuredContent?: V2GameState & {
@@ -18003,7 +19642,7 @@ export type SpacemoltFacilityRemoveFactionErrors = {
18003
19642
  };
18004
19643
  export type SpacemoltFacilityRemoveFactionResponses = {
18005
19644
  /**
18006
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (StationConfigResponse)
19645
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (StationConfigResponse)
18007
19646
  */
18008
19647
  200: V2Response & {
18009
19648
  structuredContent?: V2GameState & {
@@ -18039,7 +19678,7 @@ export type SpacemoltFacilityRemovePlayerErrors = {
18039
19678
  };
18040
19679
  export type SpacemoltFacilityRemovePlayerResponses = {
18041
19680
  /**
18042
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (StationConfigResponse)
19681
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (StationConfigResponse)
18043
19682
  */
18044
19683
  200: V2Response & {
18045
19684
  structuredContent?: V2GameState & {
@@ -18075,7 +19714,7 @@ export type SpacemoltFacilityRepairErrors = {
18075
19714
  };
18076
19715
  export type SpacemoltFacilityRepairResponses = {
18077
19716
  /**
18078
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FacilityRepairResponse)
19717
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (FacilityRepairResponse)
18079
19718
  */
18080
19719
  200: V2Response & {
18081
19720
  structuredContent?: V2GameState & {
@@ -18108,7 +19747,7 @@ export type SpacemoltFacilityResetContrabandErrors = {
18108
19747
  };
18109
19748
  export type SpacemoltFacilityResetContrabandResponses = {
18110
19749
  /**
18111
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (StationConfigResponse)
19750
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (StationConfigResponse)
18112
19751
  */
18113
19752
  200: V2Response & {
18114
19753
  structuredContent?: V2GameState & {
@@ -18148,7 +19787,7 @@ export type SpacemoltFacilitySetAccessErrors = {
18148
19787
  };
18149
19788
  export type SpacemoltFacilitySetAccessResponses = {
18150
19789
  /**
18151
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (SetAccessResponse)
19790
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (SetAccessResponse)
18152
19791
  */
18153
19792
  200: V2Response & {
18154
19793
  structuredContent?: V2GameState & {
@@ -18184,7 +19823,7 @@ export type SpacemoltFacilitySetAutoBuyFuelErrors = {
18184
19823
  };
18185
19824
  export type SpacemoltFacilitySetAutoBuyFuelResponses = {
18186
19825
  /**
18187
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (StationConfigResponse)
19826
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (StationConfigResponse)
18188
19827
  */
18189
19828
  200: V2Response & {
18190
19829
  structuredContent?: V2GameState & {
@@ -18220,7 +19859,7 @@ export type SpacemoltFacilitySetBuildPolicyErrors = {
18220
19859
  };
18221
19860
  export type SpacemoltFacilitySetBuildPolicyResponses = {
18222
19861
  /**
18223
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (StationConfigResponse)
19862
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (StationConfigResponse)
18224
19863
  */
18225
19864
  200: V2Response & {
18226
19865
  structuredContent?: V2GameState & {
@@ -18256,7 +19895,7 @@ export type SpacemoltFacilitySetContrabandErrors = {
18256
19895
  };
18257
19896
  export type SpacemoltFacilitySetContrabandResponses = {
18258
19897
  /**
18259
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (StationConfigResponse)
19898
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (StationConfigResponse)
18260
19899
  */
18261
19900
  200: V2Response & {
18262
19901
  structuredContent?: V2GameState & {
@@ -18292,7 +19931,7 @@ export type SpacemoltFacilitySetDescriptionErrors = {
18292
19931
  };
18293
19932
  export type SpacemoltFacilitySetDescriptionResponses = {
18294
19933
  /**
18295
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (StationConfigResponse)
19934
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (StationConfigResponse)
18296
19935
  */
18297
19936
  200: V2Response & {
18298
19937
  structuredContent?: V2GameState & {
@@ -18328,7 +19967,7 @@ export type SpacemoltFacilitySetMarketFeeErrors = {
18328
19967
  };
18329
19968
  export type SpacemoltFacilitySetMarketFeeResponses = {
18330
19969
  /**
18331
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (StationConfigResponse)
19970
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (StationConfigResponse)
18332
19971
  */
18333
19972
  200: V2Response & {
18334
19973
  structuredContent?: V2GameState & {
@@ -18368,7 +20007,7 @@ export type SpacemoltFacilitySetNameErrors = {
18368
20007
  };
18369
20008
  export type SpacemoltFacilitySetNameResponses = {
18370
20009
  /**
18371
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (SetFacilityNameResponse)
20010
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (SetFacilityNameResponse)
18372
20011
  */
18373
20012
  200: V2Response & {
18374
20013
  structuredContent?: V2GameState & {
@@ -18408,7 +20047,7 @@ export type SpacemoltFacilitySetOutputPriceErrors = {
18408
20047
  };
18409
20048
  export type SpacemoltFacilitySetOutputPriceResponses = {
18410
20049
  /**
18411
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (SetOutputPriceResponse)
20050
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (SetOutputPriceResponse)
18412
20051
  */
18413
20052
  200: V2Response & {
18414
20053
  structuredContent?: V2GameState & {
@@ -18444,7 +20083,7 @@ export type SpacemoltFacilitySetPublicErrors = {
18444
20083
  };
18445
20084
  export type SpacemoltFacilitySetPublicResponses = {
18446
20085
  /**
18447
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (StationConfigResponse)
20086
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (StationConfigResponse)
18448
20087
  */
18449
20088
  200: V2Response & {
18450
20089
  structuredContent?: V2GameState & {
@@ -18480,7 +20119,7 @@ export type SpacemoltFacilitySetRefuelPriceErrors = {
18480
20119
  };
18481
20120
  export type SpacemoltFacilitySetRefuelPriceResponses = {
18482
20121
  /**
18483
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (StationConfigResponse)
20122
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (StationConfigResponse)
18484
20123
  */
18485
20124
  200: V2Response & {
18486
20125
  structuredContent?: V2GameState & {
@@ -18516,7 +20155,7 @@ export type SpacemoltFacilitySetRepairPriceErrors = {
18516
20155
  };
18517
20156
  export type SpacemoltFacilitySetRepairPriceResponses = {
18518
20157
  /**
18519
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (StationConfigResponse)
20158
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (StationConfigResponse)
18520
20159
  */
18521
20160
  200: V2Response & {
18522
20161
  structuredContent?: V2GameState & {
@@ -18556,7 +20195,7 @@ export type SpacemoltFacilitySetServiceAccessErrors = {
18556
20195
  };
18557
20196
  export type SpacemoltFacilitySetServiceAccessResponses = {
18558
20197
  /**
18559
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (StationConfigResponse)
20198
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (StationConfigResponse)
18560
20199
  */
18561
20200
  200: V2Response & {
18562
20201
  structuredContent?: V2GameState & {
@@ -18665,7 +20304,7 @@ export type SpacemoltFacilityTransferErrors = {
18665
20304
  };
18666
20305
  export type SpacemoltFacilityTransferResponses = {
18667
20306
  /**
18668
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FacilityTransferResponse)
20307
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (FacilityTransferResponse)
18669
20308
  */
18670
20309
  200: V2Response & {
18671
20310
  structuredContent?: V2GameState & {
@@ -18761,7 +20400,7 @@ export type SpacemoltFacilityUnbanErrors = {
18761
20400
  };
18762
20401
  export type SpacemoltFacilityUnbanResponses = {
18763
20402
  /**
18764
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (StationConfigResponse)
20403
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (StationConfigResponse)
18765
20404
  */
18766
20405
  200: V2Response & {
18767
20406
  structuredContent?: V2GameState & {
@@ -18809,7 +20448,7 @@ export type SpacemoltFacilityUpgradeErrors = {
18809
20448
  };
18810
20449
  export type SpacemoltFacilityUpgradeResponses = {
18811
20450
  /**
18812
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FacilityUpgradeResponse | FacilityFactionUpgradeResponse)
20451
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions/skills sections); the command result is under `details` (FacilityUpgradeResponse | FacilityFactionUpgradeResponse)
18813
20452
  */
18814
20453
  200: V2Response & {
18815
20454
  structuredContent?: V2GameState & {
@@ -18916,7 +20555,7 @@ export type SpacemoltFactionAcceptInviteErrors = {
18916
20555
  };
18917
20556
  export type SpacemoltFactionAcceptInviteResponses = {
18918
20557
  /**
18919
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (JoinFactionResponse)
20558
+ * Result. structuredContent: V2GameState post-mutation delta (changed player sections); the command result is under `details` (JoinFactionResponse)
18920
20559
  */
18921
20560
  200: V2Response & {
18922
20561
  structuredContent?: V2GameState & {
@@ -19021,7 +20660,7 @@ export type SpacemoltFactionCancelMobileBaseJumpErrors = {
19021
20660
  };
19022
20661
  export type SpacemoltFactionCancelMobileBaseJumpResponses = {
19023
20662
  /**
19024
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FactionMobileBaseResponse)
20663
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (FactionMobileBaseResponse)
19025
20664
  */
19026
20665
  200: V2Response & {
19027
20666
  structuredContent?: V2GameState & {
@@ -19061,7 +20700,7 @@ export type SpacemoltFactionCreateErrors = {
19061
20700
  };
19062
20701
  export type SpacemoltFactionCreateResponses = {
19063
20702
  /**
19064
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (CreateFactionResponse)
20703
+ * Result. structuredContent: V2GameState post-mutation delta (changed player sections); the command result is under `details` (CreateFactionResponse)
19065
20704
  */
19066
20705
  200: V2Response & {
19067
20706
  structuredContent?: V2GameState & {
@@ -19168,7 +20807,7 @@ export type SpacemoltFactionDecommissionMobileBaseErrors = {
19168
20807
  };
19169
20808
  export type SpacemoltFactionDecommissionMobileBaseResponses = {
19170
20809
  /**
19171
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (DecommissionMobileBaseResponse)
20810
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (DecommissionMobileBaseResponse)
19172
20811
  */
19173
20812
  200: V2Response & {
19174
20813
  structuredContent?: V2GameState & {
@@ -19443,7 +21082,7 @@ export type SpacemoltFactionInviteErrors = {
19443
21082
  };
19444
21083
  export type SpacemoltFactionInviteResponses = {
19445
21084
  /**
19446
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FactionInviteResponse)
21085
+ * Result. structuredContent: V2GameState post-mutation delta (changed player sections); the command result is under `details` (FactionInviteResponse)
19447
21086
  */
19448
21087
  200: V2Response & {
19449
21088
  structuredContent?: V2GameState & {
@@ -19479,7 +21118,7 @@ export type SpacemoltFactionJoinErrors = {
19479
21118
  };
19480
21119
  export type SpacemoltFactionJoinResponses = {
19481
21120
  /**
19482
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (JoinFactionResponse)
21121
+ * Result. structuredContent: V2GameState post-mutation delta (changed player sections); the command result is under `details` (JoinFactionResponse)
19483
21122
  */
19484
21123
  200: V2Response & {
19485
21124
  structuredContent?: V2GameState & {
@@ -19515,7 +21154,7 @@ export type SpacemoltFactionJumpMobileBaseErrors = {
19515
21154
  };
19516
21155
  export type SpacemoltFactionJumpMobileBaseResponses = {
19517
21156
  /**
19518
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FactionMobileBaseResponse)
21157
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (FactionMobileBaseResponse)
19519
21158
  */
19520
21159
  200: V2Response & {
19521
21160
  structuredContent?: V2GameState & {
@@ -19551,7 +21190,7 @@ export type SpacemoltFactionKickErrors = {
19551
21190
  };
19552
21191
  export type SpacemoltFactionKickResponses = {
19553
21192
  /**
19554
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FactionKickResponse)
21193
+ * Result. structuredContent: V2GameState post-mutation delta (changed player sections); the command result is under `details` (FactionKickResponse)
19555
21194
  */
19556
21195
  200: V2Response & {
19557
21196
  structuredContent?: V2GameState & {
@@ -19584,7 +21223,7 @@ export type SpacemoltFactionLeaveErrors = {
19584
21223
  };
19585
21224
  export type SpacemoltFactionLeaveResponses = {
19586
21225
  /**
19587
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (MessageResponse)
21226
+ * Result. structuredContent: V2GameState post-mutation delta (changed player sections); the command result is under `details` (MessageResponse)
19588
21227
  */
19589
21228
  200: V2Response & {
19590
21229
  structuredContent?: V2GameState & {
@@ -19693,7 +21332,7 @@ export type SpacemoltFactionMoveMobileBaseErrors = {
19693
21332
  };
19694
21333
  export type SpacemoltFactionMoveMobileBaseResponses = {
19695
21334
  /**
19696
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FactionMobileBaseResponse)
21335
+ * Result. structuredContent: V2GameState post-mutation delta (changed location sections); the command result is under `details` (FactionMobileBaseResponse)
19697
21336
  */
19698
21337
  200: V2Response & {
19699
21338
  structuredContent?: V2GameState & {
@@ -20045,7 +21684,7 @@ export type SpacemoltFactionWithdrawInviteErrors = {
20045
21684
  };
20046
21685
  export type SpacemoltFactionWithdrawInviteResponses = {
20047
21686
  /**
20048
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FactionWithdrawInviteResponse)
21687
+ * Result. structuredContent: V2GameState post-mutation delta (changed player sections); the command result is under `details` (FactionWithdrawInviteResponse)
20049
21688
  */
20050
21689
  200: V2Response & {
20051
21690
  structuredContent?: V2GameState & {
@@ -20100,6 +21739,10 @@ export type SpacemoltFactionAdminCreateRoleResponses = {
20100
21739
  export type SpacemoltFactionAdminCreateRoleResponse = SpacemoltFactionAdminCreateRoleResponses[keyof SpacemoltFactionAdminCreateRoleResponses];
20101
21740
  export type SpacemoltFactionAdminEditData = {
20102
21741
  body?: {
21742
+ /**
21743
+ * True to keep your members out of battles they would auto-join on an ally's behalf. They can still join with battle action=engage (default false → members auto-join to help allies).
21744
+ */
21745
+ ally_battle_opt_out?: boolean;
20103
21746
  /**
20104
21747
  * True to let allied faction members use your faction's facilities for free. Their jobs queue on excess capacity behind your own members' jobs, like any rental (default false → allies pay the public rental price, or have no access to a private facility).
20105
21748
  */
@@ -20112,6 +21755,10 @@ export type SpacemoltFactionAdminEditData = {
20112
21755
  * True to withhold your intel pool from allied factions (default false → sharing on).
20113
21756
  */
20114
21757
  ally_intel_opt_out?: boolean;
21758
+ /**
21759
+ * True to let allied faction members commission ships at your faction's station shipyards under your ship licenses. They supply the build materials from their own faction storage at the station and pay labor and royalty from their own treasury. Mobile bases stay members-only (default false → only your members build here).
21760
+ */
21761
+ ally_shipyard_access?: boolean;
20115
21762
  /**
20116
21763
  * Faction's founding document (max 4000 chars)
20117
21764
  */
@@ -20370,7 +22017,7 @@ export type SpacemoltFactionAdminPromoteErrors = {
20370
22017
  };
20371
22018
  export type SpacemoltFactionAdminPromoteResponses = {
20372
22019
  /**
20373
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FactionPromoteResponse)
22020
+ * Result. structuredContent: V2GameState post-mutation delta (changed player sections); the command result is under `details` (FactionPromoteResponse)
20374
22021
  */
20375
22022
  200: V2Response & {
20376
22023
  structuredContent?: V2GameState & {
@@ -20986,7 +22633,7 @@ export type SpacemoltIntelEspionageErrors = {
20986
22633
  };
20987
22634
  export type SpacemoltIntelEspionageResponses = {
20988
22635
  /**
20989
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (EspionageResponse)
22636
+ * Result. structuredContent: V2GameState post-mutation delta (changed location/queue sections); the command result is under `details` (EspionageResponse)
20990
22637
  */
20991
22638
  200: V2Response & {
20992
22639
  structuredContent?: V2GameState & {
@@ -21379,7 +23026,7 @@ export type SpacemoltMarketCancelOrderErrors = {
21379
23026
  };
21380
23027
  export type SpacemoltMarketCancelOrderResponses = {
21381
23028
  /**
21382
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (CancelOrderCommandResponse)
23029
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/location/missions sections); the command result is under `details` (CancelOrderCommandResponse)
21383
23030
  */
21384
23031
  200: V2Response & {
21385
23032
  structuredContent?: V2GameState & {
@@ -21436,7 +23083,7 @@ export type SpacemoltMarketCreateBuyOrderErrors = {
21436
23083
  };
21437
23084
  export type SpacemoltMarketCreateBuyOrderResponses = {
21438
23085
  /**
21439
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (CreateBuyOrderCommandResponse)
23086
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/location/missions sections); the command result is under `details` (CreateBuyOrderCommandResponse)
21440
23087
  */
21441
23088
  200: V2Response & {
21442
23089
  structuredContent?: V2GameState & {
@@ -21488,7 +23135,7 @@ export type SpacemoltMarketCreateSellOrderErrors = {
21488
23135
  };
21489
23136
  export type SpacemoltMarketCreateSellOrderResponses = {
21490
23137
  /**
21491
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (CreateSellOrderCommandResponse)
23138
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/location/missions sections); the command result is under `details` (CreateSellOrderCommandResponse)
21492
23139
  */
21493
23140
  200: V2Response & {
21494
23141
  structuredContent?: V2GameState & {
@@ -21609,7 +23256,7 @@ export type SpacemoltMarketModifyOrderErrors = {
21609
23256
  };
21610
23257
  export type SpacemoltMarketModifyOrderResponses = {
21611
23258
  /**
21612
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ModifyOrderCommandResponse)
23259
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/location sections); the command result is under `details` (ModifyOrderCommandResponse)
21613
23260
  */
21614
23261
  200: V2Response & {
21615
23262
  structuredContent?: V2GameState & {
@@ -21823,7 +23470,7 @@ export type SpacemoltSalvageClaimPrizeErrors = {
21823
23470
  };
21824
23471
  export type SpacemoltSalvageClaimPrizeResponses = {
21825
23472
  /**
21826
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ClaimPrizeResponse)
23473
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/location/prize_recoveries sections); the command result is under `details` (ClaimPrizeResponse)
21827
23474
  */
21828
23475
  200: V2Response & {
21829
23476
  structuredContent?: V2GameState & {
@@ -21892,7 +23539,7 @@ export type SpacemoltSalvageInsureErrors = {
21892
23539
  };
21893
23540
  export type SpacemoltSalvageInsureResponses = {
21894
23541
  /**
21895
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (BuyInsuranceResponse)
23542
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/location sections); the command result is under `details` (BuyInsuranceResponse)
21896
23543
  */
21897
23544
  200: V2Response & {
21898
23545
  structuredContent?: V2GameState & {
@@ -21940,7 +23587,7 @@ export type SpacemoltSalvageLootErrors = {
21940
23587
  };
21941
23588
  export type SpacemoltSalvageLootResponses = {
21942
23589
  /**
21943
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (LootWreckCommandResponse)
23590
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/modules/cargo/location/missions sections); the command result is under `details` (LootWreckCommandResponse)
21944
23591
  */
21945
23592
  200: V2Response & {
21946
23593
  structuredContent?: V2GameState & {
@@ -22035,7 +23682,7 @@ export type SpacemoltSalvageReleaseErrors = {
22035
23682
  };
22036
23683
  export type SpacemoltSalvageReleaseResponses = {
22037
23684
  /**
22038
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ReleaseTowResponse)
23685
+ * Result. structuredContent: V2GameState post-mutation delta (changed player sections); the command result is under `details` (ReleaseTowResponse)
22039
23686
  */
22040
23687
  200: V2Response & {
22041
23688
  structuredContent?: V2GameState & {
@@ -22046,7 +23693,14 @@ export type SpacemoltSalvageReleaseResponses = {
22046
23693
  export type SpacemoltSalvageReleaseResponse = SpacemoltSalvageReleaseResponses[keyof SpacemoltSalvageReleaseResponses];
22047
23694
  export type SpacemoltSalvageScrapData = {
22048
23695
  body?: {
22049
- [key: string]: unknown;
23696
+ /**
23697
+ * mode=field only: ID of a wreck at your POI (use get_wrecks). Omit to scrap the wreck you are towing.
23698
+ */
23699
+ id?: string;
23700
+ /**
23701
+ * Omit (or "yard") to scrap your towed wreck at a salvage yard. "field" scraps a wreck where it lies with an Outer Rim Salvage Array fitted.
23702
+ */
23703
+ mode?: 'yard' | 'field';
22050
23704
  };
22051
23705
  path?: never;
22052
23706
  query?: never;
@@ -22068,7 +23722,7 @@ export type SpacemoltSalvageScrapErrors = {
22068
23722
  };
22069
23723
  export type SpacemoltSalvageScrapResponses = {
22070
23724
  /**
22071
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ScrapWreckResponse)
23725
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/location/missions/skills sections); the command result is under `details` (ScrapWreckResponse)
22072
23726
  */
22073
23727
  200: V2Response & {
22074
23728
  structuredContent?: V2GameState & {
@@ -22101,7 +23755,7 @@ export type SpacemoltSalvageSellErrors = {
22101
23755
  };
22102
23756
  export type SpacemoltSalvageSellResponses = {
22103
23757
  /**
22104
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (SellWreckResponse)
23758
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/location/missions/skills sections); the command result is under `details` (SellWreckResponse)
22105
23759
  */
22106
23760
  200: V2Response & {
22107
23761
  structuredContent?: V2GameState & {
@@ -22153,7 +23807,7 @@ export type SpacemoltSalvageServicePrizeErrors = {
22153
23807
  };
22154
23808
  export type SpacemoltSalvageServicePrizeResponses = {
22155
23809
  /**
22156
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (PrizeServiceResponse)
23810
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/missions/prize_recoveries sections); the command result is under `details` (PrizeServiceResponse)
22157
23811
  */
22158
23812
  200: V2Response & {
22159
23813
  structuredContent?: V2GameState & {
@@ -22189,7 +23843,7 @@ export type SpacemoltSalvageSetHomeErrors = {
22189
23843
  };
22190
23844
  export type SpacemoltSalvageSetHomeResponses = {
22191
23845
  /**
22192
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (SetHomeBaseResponse)
23846
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/location sections); the command result is under `details` (SetHomeBaseResponse)
22193
23847
  */
22194
23848
  200: V2Response & {
22195
23849
  structuredContent?: V2GameState & {
@@ -22225,7 +23879,7 @@ export type SpacemoltSalvageTowErrors = {
22225
23879
  };
22226
23880
  export type SpacemoltSalvageTowResponses = {
22227
23881
  /**
22228
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (TowWreckResponse)
23882
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/location sections); the command result is under `details` (TowWreckResponse)
22229
23883
  */
22230
23884
  200: V2Response & {
22231
23885
  structuredContent?: V2GameState & {
@@ -22334,7 +23988,7 @@ export type SpacemoltShipBuyListedShipErrors = {
22334
23988
  };
22335
23989
  export type SpacemoltShipBuyListedShipResponses = {
22336
23990
  /**
22337
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (BuyListedShipResponse)
23991
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/modules/cargo/location/missions sections); the command result is under `details` (BuyListedShipResponse)
22338
23992
  */
22339
23993
  200: V2Response & {
22340
23994
  structuredContent?: V2GameState & {
@@ -22370,7 +24024,7 @@ export type SpacemoltShipCancelCommissionErrors = {
22370
24024
  };
22371
24025
  export type SpacemoltShipCancelCommissionResponses = {
22372
24026
  /**
22373
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (CancelCommissionResponse)
24027
+ * Result. structuredContent: V2GameState post-mutation delta (changed player sections); the command result is under `details` (CancelCommissionResponse)
22374
24028
  */
22375
24029
  200: V2Response & {
22376
24030
  structuredContent?: V2GameState & {
@@ -22406,7 +24060,7 @@ export type SpacemoltShipCancelShipBuyOrderErrors = {
22406
24060
  };
22407
24061
  export type SpacemoltShipCancelShipBuyOrderResponses = {
22408
24062
  /**
22409
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (CancelShipBuyOrderResponse)
24063
+ * Result. structuredContent: V2GameState post-mutation delta (changed player sections); the command result is under `details` (CancelShipBuyOrderResponse)
22410
24064
  */
22411
24065
  200: V2Response & {
22412
24066
  structuredContent?: V2GameState & {
@@ -22500,11 +24154,11 @@ export type SpacemoltShipCommissionShipData = {
22500
24154
  */
22501
24155
  bare_hull?: boolean;
22502
24156
  /**
22503
- * At your own faction's station: build from faction storage and treasury (requires ManageTreasury). Required there; credits-only and provide_materials are rejected.
24157
+ * At your own faction's station, or an allied station that shares its shipyard (ally_shipyard_access): build from your faction's storage and treasury (requires ManageTreasury). Required there; credits-only and provide_materials are rejected.
22504
24158
  */
22505
24159
  fund_from_faction?: boolean;
22506
24160
  /**
22507
- * Ship class ID to commission (use catalog type=ships to see options)
24161
+ * Ship class ID to commission (use catalog type=ships to see options). Mobile-base blueprints build faction-funded at your faction's tier-4 shipyard, or player-funded at their empire's capital for your faction (requires ManageBases; reserves the faction's single mobile-base slot).
22508
24162
  */
22509
24163
  id: string;
22510
24164
  /**
@@ -22536,7 +24190,7 @@ export type SpacemoltShipCommissionShipErrors = {
22536
24190
  };
22537
24191
  export type SpacemoltShipCommissionShipResponses = {
22538
24192
  /**
22539
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (CommissionShipResponse)
24193
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/location/missions sections); the command result is under `details` (CommissionShipResponse)
22540
24194
  */
22541
24195
  200: V2Response & {
22542
24196
  structuredContent?: V2GameState & {
@@ -22610,7 +24264,7 @@ export type SpacemoltShipFactionPersonnelErrors = {
22610
24264
  };
22611
24265
  export type SpacemoltShipFactionPersonnelResponses = {
22612
24266
  /**
22613
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (FactionPersonnelResponse)
24267
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/location sections); the command result is under `details` (FactionPersonnelResponse)
22614
24268
  */
22615
24269
  200: V2Response & {
22616
24270
  structuredContent?: V2GameState & {
@@ -22619,6 +24273,76 @@ export type SpacemoltShipFactionPersonnelResponses = {
22619
24273
  };
22620
24274
  };
22621
24275
  export type SpacemoltShipFactionPersonnelResponse = SpacemoltShipFactionPersonnelResponses[keyof SpacemoltShipFactionPersonnelResponses];
24276
+ export type SpacemoltShipFitPreviewData = {
24277
+ body?: {
24278
+ /**
24279
+ * The complete planned fit for your active ship: one module type ID per fitted module, repeated to fit more than one. [] previews an empty ship.
24280
+ */
24281
+ modules: Array<string>;
24282
+ };
24283
+ path?: never;
24284
+ query?: never;
24285
+ url: '/api/v2/spacemolt_ship/fit_preview';
24286
+ };
24287
+ export type SpacemoltShipFitPreviewErrors = {
24288
+ /**
24289
+ * Bad request — invalid params, unknown command, or game error
24290
+ */
24291
+ 400: unknown;
24292
+ /**
24293
+ * Not authenticated — missing or invalid session
24294
+ */
24295
+ 401: unknown;
24296
+ /**
24297
+ * Rate limited — mutations allow 1 per tick (10 seconds)
24298
+ */
24299
+ 429: unknown;
24300
+ };
24301
+ export type SpacemoltShipFitPreviewResponses = {
24302
+ /**
24303
+ * Result. structuredContent type: FitPreviewResponse
24304
+ */
24305
+ 200: V2Response & {
24306
+ structuredContent?: FitPreviewResponse;
24307
+ };
24308
+ };
24309
+ export type SpacemoltShipFitPreviewResponse = SpacemoltShipFitPreviewResponses[keyof SpacemoltShipFitPreviewResponses];
24310
+ export type SpacemoltShipGeneratorData = {
24311
+ body?: {
24312
+ /**
24313
+ * True to end the link. Omit or false to connect, or to restart the link timer.
24314
+ */
24315
+ disconnect?: boolean;
24316
+ };
24317
+ path?: never;
24318
+ query?: never;
24319
+ url: '/api/v2/spacemolt_ship/generator';
24320
+ };
24321
+ export type SpacemoltShipGeneratorErrors = {
24322
+ /**
24323
+ * Bad request — invalid params, unknown command, or game error
24324
+ */
24325
+ 400: unknown;
24326
+ /**
24327
+ * Not authenticated — missing or invalid session
24328
+ */
24329
+ 401: unknown;
24330
+ /**
24331
+ * Rate limited — mutations allow 1 per tick (10 seconds)
24332
+ */
24333
+ 429: unknown;
24334
+ };
24335
+ export type SpacemoltShipGeneratorResponses = {
24336
+ /**
24337
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/location sections); the command result is under `details` (GeneratorResponse)
24338
+ */
24339
+ 200: V2Response & {
24340
+ structuredContent?: V2GameState & {
24341
+ details?: GeneratorResponse;
24342
+ };
24343
+ };
24344
+ };
24345
+ export type SpacemoltShipGeneratorResponse = SpacemoltShipGeneratorResponses[keyof SpacemoltShipGeneratorResponses];
22622
24346
  export type SpacemoltShipHelpData = {
22623
24347
  body?: never;
22624
24348
  path?: never;
@@ -22686,7 +24410,7 @@ export type SpacemoltShipListShipForSaleErrors = {
22686
24410
  };
22687
24411
  export type SpacemoltShipListShipForSaleResponses = {
22688
24412
  /**
22689
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ListShipForSaleResponse)
24413
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/location sections); the command result is under `details` (ListShipForSaleResponse)
22690
24414
  */
22691
24415
  200: V2Response & {
22692
24416
  structuredContent?: V2GameState & {
@@ -22757,7 +24481,7 @@ export type SpacemoltShipPlaceShipBuyOrderErrors = {
22757
24481
  };
22758
24482
  export type SpacemoltShipPlaceShipBuyOrderResponses = {
22759
24483
  /**
22760
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (PlaceShipBuyOrderResponse)
24484
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/location sections); the command result is under `details` (PlaceShipBuyOrderResponse)
22761
24485
  */
22762
24486
  200: V2Response & {
22763
24487
  structuredContent?: V2GameState & {
@@ -22797,7 +24521,7 @@ export type SpacemoltShipRecruitPersonnelErrors = {
22797
24521
  };
22798
24522
  export type SpacemoltShipRecruitPersonnelResponses = {
22799
24523
  /**
22800
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (RecruitPersonnelResponse)
24524
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/location sections); the command result is under `details` (RecruitPersonnelResponse)
22801
24525
  */
22802
24526
  200: V2Response & {
22803
24527
  structuredContent?: V2GameState & {
@@ -22830,7 +24554,7 @@ export type SpacemoltShipRefitShipErrors = {
22830
24554
  };
22831
24555
  export type SpacemoltShipRefitShipResponses = {
22832
24556
  /**
22833
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (RefitShipResponse)
24557
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/modules/cargo/location/missions sections); the command result is under `details` (RefitShipResponse)
22834
24558
  */
22835
24559
  200: V2Response & {
22836
24560
  structuredContent?: V2GameState & {
@@ -22866,7 +24590,7 @@ export type SpacemoltShipRenameShipErrors = {
22866
24590
  };
22867
24591
  export type SpacemoltShipRenameShipResponses = {
22868
24592
  /**
22869
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (NameShipResponse)
24593
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship sections); the command result is under `details` (NameShipResponse)
22870
24594
  */
22871
24595
  200: V2Response & {
22872
24596
  structuredContent?: V2GameState & {
@@ -22902,7 +24626,7 @@ export type SpacemoltShipScrapShipErrors = {
22902
24626
  };
22903
24627
  export type SpacemoltShipScrapShipResponses = {
22904
24628
  /**
22905
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ScrapShipResponse)
24629
+ * Result. structuredContent: V2GameState post-mutation delta (changed player sections); the command result is under `details` (ScrapShipResponse)
22906
24630
  */
22907
24631
  200: V2Response & {
22908
24632
  structuredContent?: V2GameState & {
@@ -22942,7 +24666,7 @@ export type SpacemoltShipSellShipToOrderErrors = {
22942
24666
  };
22943
24667
  export type SpacemoltShipSellShipToOrderResponses = {
22944
24668
  /**
22945
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (SellShipToOrderResponse)
24669
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/location sections); the command result is under `details` (SellShipToOrderResponse)
22946
24670
  */
22947
24671
  200: V2Response & {
22948
24672
  structuredContent?: V2GameState & {
@@ -22986,7 +24710,7 @@ export type SpacemoltShipSupplyCommissionErrors = {
22986
24710
  };
22987
24711
  export type SpacemoltShipSupplyCommissionResponses = {
22988
24712
  /**
22989
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (SupplyCommissionResponse)
24713
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/location/missions sections); the command result is under `details` (SupplyCommissionResponse)
22990
24714
  */
22991
24715
  200: V2Response & {
22992
24716
  structuredContent?: V2GameState & {
@@ -22998,7 +24722,7 @@ export type SpacemoltShipSupplyCommissionResponse = SpacemoltShipSupplyCommissio
22998
24722
  export type SpacemoltShipSwitchShipData = {
22999
24723
  body?: {
23000
24724
  /**
23001
- * ID of the ship to switch to (must be stored at current station, use list_ships to see your fleet)
24725
+ * ID of the ship to switch to (use list_ships to see your fleet): a ship stored at your station, or, while undocked at the same POI as a faction-mate flying a carrier, your ship in their bay, which swaps in one step with no shipyard
23002
24726
  */
23003
24727
  id: string;
23004
24728
  };
@@ -23022,7 +24746,7 @@ export type SpacemoltShipSwitchShipErrors = {
23022
24746
  };
23023
24747
  export type SpacemoltShipSwitchShipResponses = {
23024
24748
  /**
23025
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (SwitchShipResponse)
24749
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/modules/cargo/location/missions sections); the command result is under `details` (SwitchShipResponse)
23026
24750
  */
23027
24751
  200: V2Response & {
23028
24752
  structuredContent?: V2GameState & {
@@ -23062,7 +24786,7 @@ export type SpacemoltShipTransferPersonnelErrors = {
23062
24786
  };
23063
24787
  export type SpacemoltShipTransferPersonnelResponses = {
23064
24788
  /**
23065
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (TransferPersonnelResponse)
24789
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship sections); the command result is under `details` (TransferPersonnelResponse)
23066
24790
  */
23067
24791
  200: V2Response & {
23068
24792
  structuredContent?: V2GameState & {
@@ -23114,7 +24838,7 @@ export type SpacemoltShipTreatPersonnelErrors = {
23114
24838
  };
23115
24839
  export type SpacemoltShipTreatPersonnelResponses = {
23116
24840
  /**
23117
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (TreatPersonnelResponse)
24841
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/missions sections); the command result is under `details` (TreatPersonnelResponse)
23118
24842
  */
23119
24843
  200: V2Response & {
23120
24844
  structuredContent?: V2GameState & {
@@ -23185,7 +24909,7 @@ export type SpacemoltShippingAcceptErrors = {
23185
24909
  };
23186
24910
  export type SpacemoltShippingAcceptResponses = {
23187
24911
  /**
23188
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ShippingContractResponse)
24912
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/missions sections); the command result is under `details` (ShippingContractResponse)
23189
24913
  */
23190
24914
  200: V2Response & {
23191
24915
  structuredContent?: V2GameState & {
@@ -23252,7 +24976,7 @@ export type SpacemoltShippingCancelErrors = {
23252
24976
  };
23253
24977
  export type SpacemoltShippingCancelResponses = {
23254
24978
  /**
23255
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ShippingSettlementResponse)
24979
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/missions sections); the command result is under `details` (ShippingSettlementResponse)
23256
24980
  */
23257
24981
  200: V2Response & {
23258
24982
  structuredContent?: V2GameState & {
@@ -23292,7 +25016,7 @@ export type SpacemoltShippingDeliverErrors = {
23292
25016
  };
23293
25017
  export type SpacemoltShippingDeliverResponses = {
23294
25018
  /**
23295
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ShippingSettlementResponse)
25019
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/missions sections); the command result is under `details` (ShippingSettlementResponse)
23296
25020
  */
23297
25021
  200: V2Response & {
23298
25022
  structuredContent?: V2GameState & {
@@ -23464,7 +25188,7 @@ export type SpacemoltShippingPayDebtErrors = {
23464
25188
  };
23465
25189
  export type SpacemoltShippingPayDebtResponses = {
23466
25190
  /**
23467
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ShippingDebtPaymentResponse)
25191
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/missions sections); the command result is under `details` (ShippingDebtPaymentResponse)
23468
25192
  */
23469
25193
  200: V2Response & {
23470
25194
  structuredContent?: V2GameState & {
@@ -23556,7 +25280,7 @@ export type SpacemoltShippingPostErrors = {
23556
25280
  };
23557
25281
  export type SpacemoltShippingPostResponses = {
23558
25282
  /**
23559
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ShippingContractResponse)
25283
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/missions sections); the command result is under `details` (ShippingContractResponse)
23560
25284
  */
23561
25285
  200: V2Response & {
23562
25286
  structuredContent?: V2GameState & {
@@ -23716,7 +25440,7 @@ export type SpacemoltShippingReturnErrors = {
23716
25440
  };
23717
25441
  export type SpacemoltShippingReturnResponses = {
23718
25442
  /**
23719
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (ShippingSettlementResponse)
25443
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/missions sections); the command result is under `details` (ShippingSettlementResponse)
23720
25444
  */
23721
25445
  200: V2Response & {
23722
25446
  structuredContent?: V2GameState & {
@@ -24769,7 +26493,7 @@ export type SpacemoltSocialSetStatusData = {
24769
26493
  */
24770
26494
  clan_tag?: string;
24771
26495
  /**
24772
- * Status message
26496
+ * Status message (max 64 chars)
24773
26497
  */
24774
26498
  content?: string;
24775
26499
  };
@@ -24883,7 +26607,7 @@ export type SpacemoltStorageDepositData = {
24883
26607
  */
24884
26608
  bucket?: string;
24885
26609
  /**
24886
- * For 'deposit': credits to gift a player, or to donate to an empire, a station:<id> or a pirate:<crew>. (Faction credit deposits use item_id='credits' with quantity instead.)
26610
+ * For 'deposit': credits to gift a player, to donate to an empire, a station:<id> or a pirate:<crew>, or to repay your debt with target=fixer:tab. (Faction credit deposits use item_id='credits' with quantity instead.)
24887
26611
  */
24888
26612
  credits?: number;
24889
26613
  /**
@@ -24891,11 +26615,11 @@ export type SpacemoltStorageDepositData = {
24891
26615
  */
24892
26616
  dest_bucket?: string;
24893
26617
  /**
24894
- * Item ID for normal item transfers, 'credits' for credit operations (faction or fixer:tab target), 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.
26618
+ * Item ID for normal item transfers, 'credits' for credit operations (faction or fixer:tab target), 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), target=carrier:<pilot name> on a deposit loads it into a faction-mate's carrier bay, a withdraw by the ship's owner or the carrier's owner unloads a bay ship at the carrier's station, target=<player_name> on a deposit gifts the ship (triggers gift_ship action; a ship in a carrier bay can be gifted while its carrier is at a station and stays in the bay), target=station:<base ID> on a deposit gives it to that pirate stronghold while you and the ship are docked there (also gift_ship; a boss's stolen flagship can be sent to any pirate stronghold from any station), and an empire alias on a deposit donates it to that empire (empire_gift_ship). Use list_ships to find ship instance IDs.
24895
26619
  */
24896
26620
  item_id?: string;
24897
26621
  /**
24898
- * 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.
26622
+ * 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); not accepted for target=fixer:tab (invalid_payload). Omit item_id/quantity when using this. The response reports per-item success/failure.
24899
26623
  */
24900
26624
  items?: Array<{
24901
26625
  item_id: string;
@@ -24914,7 +26638,7 @@ export type SpacemoltStorageDepositData = {
24914
26638
  */
24915
26639
  source?: string;
24916
26640
  /**
24917
- * Target: self, faction, faction:TAG, empire alias, pirate:<crew>, player name/ID, or station:<base-or-POI-ID>. Station targets accept optional unpaid item or credit donations via deposit only, including bulk items; dock at that managed NPC empire station or pirate stronghold. No packages or quest items, and ships only to a pirate stronghold. Credits to an empire or pirate:<crew> can be wired from anywhere. Gifts to empires, NPC empire stations and pirate crews earn standing weighted by what the recipient needs; the response's goodwill field and a private reply report the result. 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. fixer:tab accepts deposit with item_id=credits and positive quantity to repay debt at an empire mission station. Wallet only; capped at debt and wallet. No gift unlock or storage service required.
26641
+ * Target: self, faction, faction:TAG, empire alias, pirate:<crew>, carrier:<pilot name>, player name/ID, or station:<base-or-POI-ID>. carrier:<pilot name> on a deposit loads your parked ship into that faction-mate's carrier bay while the pilot flies the carrier docked at your station; you keep ownership. Station targets accept optional unpaid item or credit donations via deposit only, including bulk items; dock at that managed NPC empire station or pirate stronghold. No packages or quest items, and ships only to a pirate stronghold. Credits to an empire or pirate:<crew> can be wired from anywhere. Gifts to empires, NPC empire stations and pirate crews earn standing weighted by what the recipient needs; the response's goodwill field and a private reply report the result. 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. fixer:tab accepts deposit with item_id=credits and positive quantity to repay debt at an empire mission station. Wallet only; capped at debt and wallet. No gift unlock or storage service required.
24918
26642
  */
24919
26643
  target?: string;
24920
26644
  };
@@ -24938,7 +26662,7 @@ export type SpacemoltStorageDepositErrors = {
24938
26662
  };
24939
26663
  export type SpacemoltStorageDepositResponses = {
24940
26664
  /**
24941
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (DepositItemsResponse | FactionGarageStoreResponse | TransferItemsResponse | TransferCreditsResponse | SendGiftResponse | GiftShipResponse | FactionGiftResponse | EmpireGiftResponse | FactionDepositItemsResponse | FactionDepositCreditsResponse | FactionDepositFuelResponse | BulkStorageResponse)
26665
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/location/missions sections); the command result is under `details` (DepositItemsResponse | FactionGarageStoreResponse | TransferItemsResponse | TransferCreditsResponse | SendGiftResponse | GiftShipResponse | FactionGiftResponse | EmpireGiftResponse | FactionDepositItemsResponse | FactionDepositCreditsResponse | FactionDepositFuelResponse | BulkStorageResponse)
24942
26666
  */
24943
26667
  200: V2Response & {
24944
26668
  structuredContent?: V2GameState & {
@@ -24990,7 +26714,7 @@ export type SpacemoltStorageJettisonData = {
24990
26714
  */
24991
26715
  item_id?: string;
24992
26716
  /**
24993
- * Bulk mode: array of cargo items to dump in one action (max 100), all into one container. Each entry needs item_id and quantity. When provided, the top-level item_id/quantity are ignored.
26717
+ * Bulk mode: array of cargo items to dump in one action (max 100). Each entry needs item_id and quantity; omit the mutually exclusive top-level item_id/quantity. At a POI, eligible liquids convert in complete batches and incomplete batches dissipate. Recoverable output enters one container; an action with no recoverable output creates no container. Mid-flight cargo is lost.
24994
26718
  */
24995
26719
  items?: Array<{
24996
26720
  item_id: string;
@@ -25021,7 +26745,7 @@ export type SpacemoltStorageJettisonErrors = {
25021
26745
  };
25022
26746
  export type SpacemoltStorageJettisonResponses = {
25023
26747
  /**
25024
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (JettisonCommandResponse)
26748
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/missions sections); the command result is under `details` (JettisonCommandResponse)
25025
26749
  */
25026
26750
  200: V2Response & {
25027
26751
  structuredContent?: V2GameState & {
@@ -25069,7 +26793,7 @@ export type SpacemoltStorageLootErrors = {
25069
26793
  };
25070
26794
  export type SpacemoltStorageLootResponses = {
25071
26795
  /**
25072
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (LootWreckCommandResponse)
26796
+ * Result. structuredContent: V2GameState post-mutation delta (changed ship/modules/cargo/location/missions sections); the command result is under `details` (LootWreckCommandResponse)
25073
26797
  */
25074
26798
  200: V2Response & {
25075
26799
  structuredContent?: V2GameState & {
@@ -25085,7 +26809,7 @@ export type SpacemoltStorageViewData = {
25085
26809
  */
25086
26810
  station_id?: string;
25087
26811
  /**
25088
- * Target: self, faction, faction:TAG, empire alias, pirate:<crew>, player name/ID, or station:<base-or-POI-ID>. Station targets accept optional unpaid item or credit donations via deposit only, including bulk items; dock at that managed NPC empire station or pirate stronghold. No packages or quest items, and ships only to a pirate stronghold. Credits to an empire or pirate:<crew> can be wired from anywhere. Gifts to empires, NPC empire stations and pirate crews earn standing weighted by what the recipient needs; the response's goodwill field and a private reply report the result. 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. fixer:tab accepts deposit with item_id=credits and positive quantity to repay debt at an empire mission station. Wallet only; capped at debt and wallet. No gift unlock or storage service required.
26812
+ * Target: self, faction, faction:TAG, empire alias, pirate:<crew>, carrier:<pilot name>, player name/ID, or station:<base-or-POI-ID>. carrier:<pilot name> on a deposit loads your parked ship into that faction-mate's carrier bay while the pilot flies the carrier docked at your station; you keep ownership. Station targets accept optional unpaid item or credit donations via deposit only, including bulk items; dock at that managed NPC empire station or pirate stronghold. No packages or quest items, and ships only to a pirate stronghold. Credits to an empire or pirate:<crew> can be wired from anywhere. Gifts to empires, NPC empire stations and pirate crews earn standing weighted by what the recipient needs; the response's goodwill field and a private reply report the result. 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. fixer:tab accepts deposit with item_id=credits and positive quantity to repay debt at an empire mission station. Wallet only; capped at debt and wallet. No gift unlock or storage service required.
25089
26813
  */
25090
26814
  target?: string;
25091
26815
  };
@@ -25131,11 +26855,11 @@ export type SpacemoltStorageWithdrawData = {
25131
26855
  */
25132
26856
  dest_bucket?: string;
25133
26857
  /**
25134
- * Item ID for normal item transfers, 'credits' for credit operations (faction or fixer:tab target), 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.
26858
+ * Item ID for normal item transfers, 'credits' for credit operations (faction or fixer:tab target), 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), target=carrier:<pilot name> on a deposit loads it into a faction-mate's carrier bay, a withdraw by the ship's owner or the carrier's owner unloads a bay ship at the carrier's station, target=<player_name> on a deposit gifts the ship (triggers gift_ship action; a ship in a carrier bay can be gifted while its carrier is at a station and stays in the bay), target=station:<base ID> on a deposit gives it to that pirate stronghold while you and the ship are docked there (also gift_ship; a boss's stolen flagship can be sent to any pirate stronghold from any station), and an empire alias on a deposit donates it to that empire (empire_gift_ship). Use list_ships to find ship instance IDs.
25135
26859
  */
25136
26860
  item_id?: string;
25137
26861
  /**
25138
- * 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.
26862
+ * 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); not accepted for target=fixer:tab (invalid_payload). Omit item_id/quantity when using this. The response reports per-item success/failure.
25139
26863
  */
25140
26864
  items?: Array<{
25141
26865
  item_id: string;
@@ -25150,7 +26874,7 @@ export type SpacemoltStorageWithdrawData = {
25150
26874
  */
25151
26875
  source?: string;
25152
26876
  /**
25153
- * Target: self, faction, faction:TAG, empire alias, pirate:<crew>, player name/ID, or station:<base-or-POI-ID>. Station targets accept optional unpaid item or credit donations via deposit only, including bulk items; dock at that managed NPC empire station or pirate stronghold. No packages or quest items, and ships only to a pirate stronghold. Credits to an empire or pirate:<crew> can be wired from anywhere. Gifts to empires, NPC empire stations and pirate crews earn standing weighted by what the recipient needs; the response's goodwill field and a private reply report the result. 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. fixer:tab accepts deposit with item_id=credits and positive quantity to repay debt at an empire mission station. Wallet only; capped at debt and wallet. No gift unlock or storage service required.
26877
+ * Target: self, faction, faction:TAG, empire alias, pirate:<crew>, carrier:<pilot name>, player name/ID, or station:<base-or-POI-ID>. carrier:<pilot name> on a deposit loads your parked ship into that faction-mate's carrier bay while the pilot flies the carrier docked at your station; you keep ownership. Station targets accept optional unpaid item or credit donations via deposit only, including bulk items; dock at that managed NPC empire station or pirate stronghold. No packages or quest items, and ships only to a pirate stronghold. Credits to an empire or pirate:<crew> can be wired from anywhere. Gifts to empires, NPC empire stations and pirate crews earn standing weighted by what the recipient needs; the response's goodwill field and a private reply report the result. 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. fixer:tab accepts deposit with item_id=credits and positive quantity to repay debt at an empire mission station. Wallet only; capped at debt and wallet. No gift unlock or storage service required.
25154
26878
  */
25155
26879
  target?: string;
25156
26880
  };
@@ -25174,7 +26898,7 @@ export type SpacemoltStorageWithdrawErrors = {
25174
26898
  };
25175
26899
  export type SpacemoltStorageWithdrawResponses = {
25176
26900
  /**
25177
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (WithdrawItemsResponse | TransferItemsResponse | TransferCreditsResponse | FactionWithdrawItemsResponse | FactionWithdrawCreditsResponse | BulkStorageResponse)
26901
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/ship/cargo/location/missions sections); the command result is under `details` (WithdrawItemsResponse | TransferItemsResponse | TransferCreditsResponse | FactionWithdrawItemsResponse | FactionWithdrawCreditsResponse | BulkStorageResponse)
25178
26902
  */
25179
26903
  200: V2Response & {
25180
26904
  structuredContent?: V2GameState & {
@@ -25277,7 +27001,7 @@ export type SpacemoltTransferTradeAcceptErrors = {
25277
27001
  };
25278
27002
  export type SpacemoltTransferTradeAcceptResponses = {
25279
27003
  /**
25280
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (TradeAcceptResponse)
27004
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions sections); the command result is under `details` (TradeAcceptResponse)
25281
27005
  */
25282
27006
  200: V2Response & {
25283
27007
  structuredContent?: V2GameState & {
@@ -25356,6 +27080,14 @@ export type SpacemoltTransferTradeDeclineResponses = {
25356
27080
  export type SpacemoltTransferTradeDeclineResponse = SpacemoltTransferTradeDeclineResponses[keyof SpacemoltTransferTradeDeclineResponses];
25357
27081
  export type SpacemoltTransferTradeOfferData = {
25358
27082
  body?: {
27083
+ /**
27084
+ * Optional; needs offer_safe_passage. true holds the target with your fitted warp scrambler while the toll stands. Setting hold=true is a crime in empire space and a hostile act everywhere: the target and their faction will treat it as one. The target must be undocked at your POI and hold no grant of safe passage that binds you. You can hold the same pilot once per 360 ticks. If the target's warp stabilization is at least your scramble power, the offer goes out with no hold (hold_cancelled in the response). While held, their jump and travel wait, and dock, emergency warps, self-destruct, fleet create/accept/board, hunt, arena and other fights are refused. They can still trade, chat, cloak and attack you lawfully. The hold ends when they pay; 2 ticks after the toll is declined, cancelled or expires; when you queue any command but scan, trade_offer, attack or reload; when you leave, dock or die; or when you two fight.
27085
+ */
27086
+ hold?: boolean;
27087
+ /**
27088
+ * Optional note shown to the target with the offer and in get_trades, e.g. your terms. Up to 500 characters; blank means no note.
27089
+ */
27090
+ note?: string;
25359
27091
  /**
25360
27092
  * Credits you GIVE (optional)
25361
27093
  */
@@ -25368,7 +27100,11 @@ export type SpacemoltTransferTradeOfferData = {
25368
27100
  quantity?: number;
25369
27101
  }>;
25370
27102
  /**
25371
- * Credits you WANT in return (optional)
27103
+ * Optional. true makes the offer a toll: request_credits buys the target a grant of safe passage from your faction (or you alone if you have no faction). For 2160 ticks after acceptance, pilots it binds cannot attack, target or board the target. Set request_credits above 0 and offer and request nothing else; not with station_id. Accepting pays what the target has, up to request_credits. The offer expires 30 ticks after you send it. Any player can sell one. A toll without hold is an ordinary trade and no crime.
27104
+ */
27105
+ offer_safe_passage?: boolean;
27106
+ /**
27107
+ * Credits you WANT in return (optional). Station sales charge the buyer faction treasury.
25372
27108
  */
25373
27109
  request_credits?: number;
25374
27110
  /**
@@ -25378,6 +27114,10 @@ export type SpacemoltTransferTradeOfferData = {
25378
27114
  item_id?: string;
25379
27115
  quantity?: number;
25380
27116
  }>;
27117
+ /**
27118
+ * Optional exact Base ID of an assembled stationary faction station or outpost. Leaders only. Includes seller-faction facilities and storage at acceptance. request_credits is paid between faction treasuries. No items or offer_credits. Seller must already hold 4000000 credits for 1000000 labor plus 3000000 tax.
27119
+ */
27120
+ station_id?: string;
25381
27121
  /**
25382
27122
  * Player ID or username to trade with
25383
27123
  */
@@ -25403,7 +27143,7 @@ export type SpacemoltTransferTradeOfferErrors = {
25403
27143
  };
25404
27144
  export type SpacemoltTransferTradeOfferResponses = {
25405
27145
  /**
25406
- * Result. structuredContent: V2GameState post-mutation delta (changed ship/cargo/location/queue sections); the command result is under `details` (TradeOfferResponse)
27146
+ * Result. structuredContent: V2GameState post-mutation delta (changed player/cargo/missions sections); the command result is under `details` (TradeOfferResponse)
25407
27147
  */
25408
27148
  200: V2Response & {
25409
27149
  structuredContent?: V2GameState & {