tornapi-typescript 1.10.2 → 1.11.1

package/dist/index.d.ts

@@ -4173,6 +4173,7 @@ export type FactionStatEnum =
     | "gymtrains"
     | "gymstrength"
     | "gymspeed"
+    | "gymenergy"
     | "gymdefense"
     | "gymdexterity"
     | "candyused"
@@ -4547,6 +4548,10 @@ export type FactionCrimeUserOutcome =
 
 export type RaceId = number;
 
+export type PropertyTypeId = number;
+
+export type PropertyId = number;
+
 export type DirtyBombId = number;
 
 export type RaceTrackId = number;
@@ -4646,6 +4651,31 @@ export type FactionWarfareTypeEnum =
     | "chain"
     | "db";
 
+export type PropertyModificationEnum =
+    | "Hot Tub"
+    | "Sauna"
+    | "Open Bar"
+    | "Small Pool"
+    | "Medium Pool"
+    | "Large Pool"
+    | "Small Vault"
+    | "Medium Vault"
+    | "Large Vault"
+    | "Extra Large Vault"
+    | "Medical Facility"
+    | "Advanced Shooting Range"
+    | "Airstrip"
+    | "Private Yacht"
+    | "Sufficient Interior Modification"
+    | "Superior Interior Modification";
+
+export type PropertyStaffEnum =
+    | "Maid"
+    | "Guard"
+    | "Doctor"
+    | "Pilot"
+    | "Butler";
+
 export type FactionCrimeStatusEnum =
     | "Recruiting"
     | "Planning"
@@ -5038,6 +5068,79 @@ export type SelectionCategoryEnum =
     | PersonalStatsCategoryEnum
     | RacingRaceTypeEnum;
 
+export interface BasicUser {
+    id: UserId;
+    name: string;
+}
+
+export interface UserPropertyBasicDetails {
+    id: PropertyId;
+    owner: BasicUser;
+    property: BasicProperty;
+    happy: number;
+    upkeep: {
+        property: number;
+        staff: number;
+    };
+    market_price: number;
+    modifications: PropertyModificationEnum[];
+    staff: {
+        type: PropertyStaffEnum;
+        amount: number;
+    }[];
+}
+
+export interface UserPropertyDetailsExtended extends UserPropertyBasicDetails {
+    used_by: BasicUser[];
+    status: "none" | "in_use";
+}
+
+export interface UserPropertyDetails extends UserPropertyBasicDetails {
+    used_by: BasicUser[];
+}
+
+export interface UserPropertyDetailsExtendedRented
+    extends UserPropertyBasicDetails {
+    used_by: BasicUser[];
+    status: "rented";
+    cost: number;
+    cost_per_day: number;
+    rental_period: number;
+    rental_period_remaining: number;
+}
+
+export interface UserPropertyDetailsExtendedForRent
+    extends UserPropertyBasicDetails {
+    used_by: BasicUser[];
+    status: "for_rent";
+    cost: number;
+    cost_per_day: number;
+    rental_period: number;
+    renter_asked?: BasicUser;
+}
+
+export interface UserPropertyDetailsExtendedForSale
+    extends UserPropertyBasicDetails {
+    used_by: BasicUser[];
+    status: "for_sale";
+    cost: number;
+}
+
+export interface UserPropertiesResponse {
+    properties: {} & (
+        | UserPropertyBasicDetails
+        | UserPropertyDetailsExtended
+        | UserPropertyDetailsExtendedRented
+        | UserPropertyDetailsExtendedForRent
+        | UserPropertyDetailsExtendedForSale
+    );
+    _metadata: RequestMetadataWithLinks;
+}
+
+export interface UserPropertyResponse {
+    property: UserPropertyDetails;
+}
+
 export interface UserCurrentEducation {
     id: EducationId;
     until: number;
@@ -7228,6 +7331,45 @@ export interface KeyInfoResponse {
 
 export type KeySelectionName = string;
 
+export interface BasicProperty {
+    id: PropertyTypeId;
+    name: string;
+}
+
+export interface MarketRentalDetails {
+    listings: {
+        happy: number;
+        cost: number;
+        cost_per_day: number;
+        rental_period: number;
+        market_price: number;
+        upkeep: number;
+        modifications: PropertyModificationEnum[];
+    }[];
+    property: BasicProperty;
+}
+
+export interface MarketRentalsResponse {
+    properties: MarketRentalDetails;
+    _metadata: RequestMetadataWithLinks;
+}
+
+export interface MarketPropertyDetails {
+    listings: {
+        happy: number;
+        cost: number;
+        market_price: number;
+        upkeep: number;
+        modifications: PropertyModificationEnum[];
+    }[];
+    property: BasicProperty;
+}
+
+export interface MarketPropertiesResponse {
+    properties: MarketPropertyDetails;
+    _metadata: RequestMetadataWithLinks;
+}
+
 export interface BazaarWeekly {
     busiest: BazaarWeeklyCustomers[];
     most_popular: BazaarTotalFavorites[];
@@ -7471,6 +7613,18 @@ export interface RacingLookupResponse {
     selections: RacingSelectionName[];
 }
 
+export interface TornProperties {
+    properties?: {
+        id: PropertyTypeId;
+        name: string;
+        cost: number;
+        happy: number;
+        upkeep: number;
+        modifications: PropertyModificationEnum[];
+        staff: PropertyStaffEnum[];
+    }[];
+}
+
 export interface TornEducationRewards {
     working_stats: {
         manual_labor: number | null;
@@ -7805,7 +7959,7 @@ export interface TornFactionTreeResponse {
 }
 
 /**
- * The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','gyms','honors','itemdetails','itemstats','medals','organisedcrimes','pawnshop','pokertables','properties','rockpaperscissors','searchforcash','shoplifting','stats','stocks'.
+ * The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','gyms','honors','itemdetails','itemstats','medals','organisedcrimes','pawnshop','pokertables','rockpaperscissors','searchforcash','shoplifting','stats','stocks'.
  *  *   The following selections are not available in API v2: 'dirtybombs','raidreport','raids', 'chainreport', 'rackets', 'rankedwarreport', 'rankedwars', 'territorynames', 'territorywarreport', 'territorywars'.
  */
 export type TornSelectionName = string;