tornapi-typescript 6.8.2 → 6.10.0

package/dist/index.d.ts

@@ -109,11 +109,13 @@ export type EducationId = number;
 export type FactionBranchId = number;
 export type FactionCrimeId = number;
 export type TornCrimeId = number;
+export type TornSubCrimeId = number;
 export type ChainId = number;
 export type AttackId = number;
 export type AttackCode = string;
 export type ForumId = number;
 export type ForumThreadId = number;
+export type GymId = number;
 export type ForumPostId = number;
 export interface RequestLinks {
     next: string | null;
@@ -129,6 +131,11 @@ export interface RequestMetadataWithLinksAndTotal {
     links: RequestLinks;
     total?: number;
 }
+export interface RequestMetadataWithLinksAndNanostamp {
+    links: RequestLinks;
+    /** Use to bypass system limitation when 100 or more logs were inserted within the same second. */
+    nanostamp?: string;
+}
 /**
  * This represents the type of the activity. Values range from 1 to 8 where:
  *  *                    1 = 'X posted on a thread',
@@ -140,6 +147,7 @@ export interface RequestMetadataWithLinksAndTotal {
  *  *                    7 = 'X quoted your post'.
  */
 export type ForumFeedTypeEnum = 1 | 2 | 3 | 4 | 5 | 6 | 7;
+export type GymClassEnum = "Basic" | "Lightweight" | "Middleweight" | "Heavyweight" | "Specialist";
 export type UserGenderEnum = "Male" | "Female" | "Enby";
 export type CompanyStaffRoomSizeEnum = "No staff room" | "Small staff room" | "Standard staff room" | "Large staff room" | "Very large staff room" | "Huge staff room" | "Colossal staff room";
 export type CompanyStorageSizeEnum = "Small room" | "Standard room" | "Large room" | "Huge room" | "Warehouse" | "Large warehouse" | "Huge warehouse";
@@ -148,6 +156,7 @@ export type AwardCrimesVersionEnum = "v1" | "v2";
 export type CompanySearchParameter = string;
 export type UserSearchParameter = string;
 export type Parameters = string;
+export type TornShopliftingStatusTitleEnum = "One camera" | "Two cameras" | "Three cameras" | "Four cameras" | "Checkpoint" | "One guard" | "Two guards";
 export type ReviveSetting = "Everyone" | "Friends & faction" | "No one" | "Unknown";
 export type FactionWarfareTypeEnum = "ranked" | "territory" | "raid" | "chain" | "chainOngoing" | "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";
@@ -507,6 +516,12 @@ export interface ErrorFileDoesNotExist {
     error: string;
 }
 export type ApiError = ErrorUnknown | ErrorKeyEmpty | ErrorIncorrectKey | ErrorWrongType | ErrorWrongFields | ErrorTooManyRequests | ErrorIncorrectId | ErrorIncorrectIdEntityRelation | ErrorIpBlocked | ErrorApiDisabled | ErrorKeyOwnerInFederalJail | ErrorKeyChangeCooldown | ErrorKeyReadError | ErrorKeyTemporaryDisabled | ErrorDailyReadLimitReached | ErrorLogUnavailable | ErrorAccessLevelTooLow | ErrorBackendError | ErrorApiKeyPaused | ErrorMustMigrateToCrimesV2 | ErrorRaceNotFinished | ErrorIncorrectCategory | ErrorOnlyAvailableInApiV1 | ErrorOnlyAvailableInApiV2 | ErrorClosedTemporarily | ErrorInvalidStatRequested | ErrorOnlyCategoryOrStatsAllowed | ErrorMustMigrateToOrganizedCrimesV2 | ErrorIncorrectLogId | ErrorCategorySelectionUnavailableForInteractionLogs | ErrorFileDoesNotExist;
+export interface UserGymResponse {
+    gym: {
+        id: GymId;
+        name: string;
+    };
+}
 export interface UserSearch {
     id: UserId;
     name: string;
@@ -692,15 +707,16 @@ export interface UserStocksResponse {
 export interface UserOrganizedCrimesResponse {
     organizedcrimes: FactionCrime[];
 }
+export interface UserEquipmentAmmo {
+    id: AmmoId;
+    name: string;
+    quantity: number;
+    type: TornItemAmmoTypeEnum;
+}
 export type UserEquipment = TornItemDetails & {
     slot: number;
     mods: UserEquipmentItemMod[];
-    ammo: {
-        id: AmmoId;
-        name: string;
-        quantity: number;
-        type: TornItemAmmoTypeEnum;
-    };
+    ammo: UserEquipmentAmmo | null;
 };
 export interface UserEquipmentItemMod {
     id: ItemModId;
@@ -952,6 +968,7 @@ export interface UserProfileResponse {
         signed_up: number;
         faction_id: FactionId | null;
         honor_id: HonorId;
+        revive_setting: ReviveSetting;
         property: {
             id: PropertyId;
             name: string;
@@ -1090,7 +1107,7 @@ export interface UserLog {
 }
 export interface UserLogsResponse {
     log: UserLog[];
-    _metadata: RequestMetadataWithLinks;
+    _metadata: RequestMetadataWithLinksAndNanostamp;
 }
 export interface BasicUser {
     id: UserId;
@@ -1264,7 +1281,7 @@ export interface UserCrimeDetailsScamming {
     };
 }
 export interface UserSubcrime {
-    id: number;
+    id: TornSubCrimeId;
     total: number;
     success: number;
     fail: number;
@@ -1325,7 +1342,7 @@ export interface UserRacesResponse {
 }
 export interface UserRaceCarDetails extends RaceCar {
     id: RaceCarId;
-    name?: string | null;
+    car_name?: string | null;
     worth: number;
     points_spent: number;
     races_entered: number;
@@ -1458,7 +1475,7 @@ export interface UserListResponse {
     list: UserList[];
     _metadata: RequestMetadataWithLinks;
 }
-/** The following selections will fallback to API v1 and may change at any time: 'bazaar','criminalrecord','display','gym','networth','perks'. */
+/** The following selections will fallback to API v1 and may change at any time: 'bazaar','criminalrecord','display','networth'. */
 export type UserSelectionName = string;
 export interface UserLookupResponse {
     selections: UserSelectionName[];
@@ -2719,6 +2736,25 @@ export interface FactionRankedWarResponse {
     rankedwars: FactionRankedWarDetails[];
     _metadata: RequestMetadataWithLinks;
 }
+export interface FactionWarfareRankedResponse {
+    warfareranked: FactionRankedWarDetails[];
+    _metadata: RequestMetadataWithLinks;
+}
+export interface FactionWarfareRaidsResponse {
+    warfareraids: FactionRaidWarfare[];
+    _metadata: RequestMetadataWithLinks;
+}
+export interface FactionWarfareTerritoryWarsResponse {
+    warfareterritory: FactionTerritoryWarfare[];
+    _metadata: RequestMetadataWithLinks;
+}
+export interface FactionWarfareChainsResponse {
+    warfarechains: FactionChainWarfare[];
+    _metadata: RequestMetadataWithLinks;
+}
+export interface FactionWarfareDirtyBombsResponse {
+    dirtybombs: FactionWarfareDirtyBomb[];
+}
 export interface FactionWarfareResponse {
     warfare: FactionRankedWarDetails[] | FactionTerritoryWarfare[] | FactionChainWarfare[] | FactionRaidWarfare[] | FactionWarfareDirtyBomb[];
     _metadata: RequestMetadataWithLinks;
@@ -3373,6 +3409,43 @@ export type PropertySelectionName = string;
 export interface PropertyLookupResponse {
     selections: PropertySelectionName[];
 }
+export interface TornGymModifiers {
+    strength: number;
+    speed: number;
+    defense: number;
+    dexterity: number;
+}
+export interface TornGym {
+    id: GymId;
+    name: string;
+    class: GymClassEnum;
+    energy_cost: number;
+    cost: number;
+    modifiers: TornGymModifiers;
+    note: string | null;
+}
+export interface TornGymsResponse {
+    gyms: TornGym[];
+}
+export interface TornSearchForCash {
+    id: TornSubCrimeId;
+    title: string;
+    percentage: number;
+}
+export interface TornSearchForCashResponse {
+    searchforcash: TornSearchForCash[];
+}
+export interface TornShopliftingSecurityStatus {
+    title: TornShopliftingStatusTitleEnum;
+    disabled: boolean;
+}
+export interface TornShoplifting {
+    id: TornSubCrimeId;
+    status: TornShopliftingSecurityStatus[];
+}
+export interface TornShopliftingResponse {
+    shoplifting: TornShoplifting[];
+}
 export interface TornCompaniesResponse {
     companies: TornCompany[];
 }
@@ -3654,7 +3727,7 @@ export interface TornSubcrimesResponse {
     subcrimes: TornSubcrime[];
 }
 export interface TornSubcrime {
-    id: number;
+    id: TornSubCrimeId;
     name: string;
     nerve_cost: number;
 }
@@ -3899,7 +3972,7 @@ export interface TornFactionTreeResponse {
     factionTree: TornFactionTree[];
 }
 /**
- * The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','gyms','itemdetails','itemstats','organisedcrimes','pawnshop','pokertables','rockpaperscissors','searchforcash','shoplifting','stats'.
+ * The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','itemstats','organisedcrimes','pawnshop','pokertables','rockpaperscissors','stats'.
  *  *   The following selections are not available in API v2: 'dirtybombs','raidreport','raids', 'chainreport', 'rackets', 'rankedwarreport', 'rankedwars', 'territorynames', 'territorywarreport', 'territorywars'.
  */
 export type TornSelectionName = string;
@@ -7263,6 +7336,10 @@ export interface UserV2 extends BaseSchema {
             response: UserForumThreadsResponse;
             params: "limit" | "sort" | "from" | "to" | "timestamp";
         };
+        gym: {
+            response: UserGymResponse;
+            params: "timestamp";
+        };
         hof: {
             response: UserHofResponse;
             params: "timestamp";
@@ -7305,7 +7382,7 @@ export interface UserV2 extends BaseSchema {
         };
         log: {
             response: UserLogsResponse;
-            params: "log" | "cat" | "target" | "limit" | "to" | "from" | "timestamp";
+            params: "log" | "cat" | "target" | "limit" | "to" | "from" | "timestamp" | "nanostamp";
         };
         medals: {
             response: UserMedalsResponse;
@@ -7491,6 +7568,10 @@ export interface FactionV2 extends BaseSchema {
             response: FactionCrimeResponse;
             params: "crimeId" | "timestamp";
         };
+        dirtybombs: {
+            response: FactionWarfareDirtyBombsResponse;
+            params: "timestamp";
+        };
         hof: {
             response: FactionHofResponse;
             params: "timestamp";
@@ -7571,6 +7652,22 @@ export interface FactionV2 extends BaseSchema {
             response: FactionUpgradesResponse;
             params: "timestamp";
         };
+        warfarechains: {
+            response: FactionWarfareChainsResponse;
+            params: "cat" | "limit" | "sort" | "from" | "to" | "timestamp";
+        };
+        warfareraids: {
+            response: FactionWarfareRaidsResponse;
+            params: "limit" | "sort" | "from" | "to" | "timestamp";
+        };
+        warfareranked: {
+            response: FactionWarfareRankedResponse;
+            params: "limit" | "sort" | "from" | "to" | "timestamp";
+        };
+        warfareterritory: {
+            response: FactionWarfareTerritoryWarsResponse;
+            params: "limit" | "sort" | "from" | "to" | "timestamp";
+        };
         warfare: {
             response: FactionWarfareResponse;
             params: "cat" | "limit" | "sort" | "from" | "to" | "timestamp";
@@ -7807,6 +7904,10 @@ export interface TornV2 extends BaseSchema {
             response: TornFactionTreeResponse;
             params: "timestamp";
         };
+        gyms: {
+            response: TornGymsResponse;
+            params: "timestamp";
+        };
         honors: {
             response: TornHonorsResponse;
             params: "limit" | "offset" | "sort" | "timestamp";
@@ -7859,6 +7960,14 @@ export interface TornV2 extends BaseSchema {
             response: TornProperties;
             params: "timestamp";
         };
+        searchforcash: {
+            response: TornSearchForCashResponse;
+            params: "timestamp";
+        };
+        shoplifting: {
+            response: TornShopliftingResponse;
+            params: "timestamp";
+        };
         stocks: {
             response: TornStocksResponse;
             params: "timestamp";

package/dist/index.ts

@@ -4787,6 +4787,8 @@ export type FactionCrimeId = number;
 
 export type TornCrimeId = number;
 
+export type TornSubCrimeId = number;
+
 export type ChainId = number;
 
 export type AttackId = number;
@@ -4797,6 +4799,8 @@ export type ForumId = number;
 
 export type ForumThreadId = number;
 
+export type GymId = number;
+
 export type ForumPostId = number;
 
 export interface RequestLinks {
@@ -4817,6 +4821,12 @@ export interface RequestMetadataWithLinksAndTotal {
     total?: number;
 }
 
+export interface RequestMetadataWithLinksAndNanostamp {
+    links: RequestLinks;
+    /** Use to bypass system limitation when 100 or more logs were inserted within the same second. */
+    nanostamp?: string;
+}
+
 /**
  * This represents the type of the activity. Values range from 1 to 8 where:
  *  *                    1 = 'X posted on a thread',
@@ -4829,6 +4839,9 @@ export interface RequestMetadataWithLinksAndTotal {
  */
 export type ForumFeedTypeEnum = 1 | 2 | 3 | 4 | 5 | 6 | 7;
 
+export type GymClassEnum =
+    "Basic" | "Lightweight" | "Middleweight" | "Heavyweight" | "Specialist";
+
 export type UserGenderEnum = "Male" | "Female" | "Enby";
 
 export type CompanyStaffRoomSizeEnum =
@@ -4868,6 +4881,15 @@ export type UserSearchParameter = string;
 
 export type Parameters = string;
 
+export type TornShopliftingStatusTitleEnum =
+    | "One camera"
+    | "Two cameras"
+    | "Three cameras"
+    | "Four cameras"
+    | "Checkpoint"
+    | "One guard"
+    | "Two guards";
+
 export type ReviveSetting =
     "Everyone" | "Friends & faction" | "No one" | "Unknown";
 
@@ -5523,6 +5545,13 @@ export type ApiError =
     | ErrorCategorySelectionUnavailableForInteractionLogs
     | ErrorFileDoesNotExist;
 
+export interface UserGymResponse {
+    gym: {
+        id: GymId;
+        name: string;
+    };
+}
+
 export interface UserSearch {
     id: UserId;
     name: string;
@@ -5740,15 +5769,17 @@ export interface UserOrganizedCrimesResponse {
     organizedcrimes: FactionCrime[];
 }
 
+export interface UserEquipmentAmmo {
+    id: AmmoId;
+    name: string;
+    quantity: number;
+    type: TornItemAmmoTypeEnum;
+}
+
 export type UserEquipment = TornItemDetails & {
     slot: number;
     mods: UserEquipmentItemMod[];
-    ammo: {
-        id: AmmoId;
-        name: string;
-        quantity: number;
-        type: TornItemAmmoTypeEnum;
-    };
+    ammo: UserEquipmentAmmo | null;
 };
 
 export interface UserEquipmentItemMod {
@@ -6053,6 +6084,7 @@ export interface UserProfileResponse {
         signed_up: number;
         faction_id: FactionId | null;
         honor_id: HonorId;
+        revive_setting: ReviveSetting;
         property: {
             id: PropertyId;
             name: string;
@@ -6207,7 +6239,7 @@ export interface UserLog {
 
 export interface UserLogsResponse {
     log: UserLog[];
-    _metadata: RequestMetadataWithLinks;
+    _metadata: RequestMetadataWithLinksAndNanostamp;
 }
 
 export interface BasicUser {
@@ -6409,7 +6441,7 @@ export interface UserCrimeDetailsScamming {
 }
 
 export interface UserSubcrime {
-    id: number;
+    id: TornSubCrimeId;
     total: number;
     success: number;
     fail: number;
@@ -6490,7 +6522,7 @@ export interface UserRacesResponse {
 
 export interface UserRaceCarDetails extends RaceCar {
     id: RaceCarId;
-    name?: string | null;
+    car_name?: string | null;
     worth: number;
     points_spent: number;
     races_entered: number;
@@ -6649,7 +6681,7 @@ export interface UserListResponse {
     _metadata: RequestMetadataWithLinks;
 }
 
-/** The following selections will fallback to API v1 and may change at any time: 'bazaar','criminalrecord','display','gym','networth','perks'. */
+/** The following selections will fallback to API v1 and may change at any time: 'bazaar','criminalrecord','display','networth'. */
 export type UserSelectionName = string;
 
 export interface UserLookupResponse {
@@ -8354,6 +8386,30 @@ export interface FactionRankedWarResponse {
     _metadata: RequestMetadataWithLinks;
 }
 
+export interface FactionWarfareRankedResponse {
+    warfareranked: FactionRankedWarDetails[];
+    _metadata: RequestMetadataWithLinks;
+}
+
+export interface FactionWarfareRaidsResponse {
+    warfareraids: FactionRaidWarfare[];
+    _metadata: RequestMetadataWithLinks;
+}
+
+export interface FactionWarfareTerritoryWarsResponse {
+    warfareterritory: FactionTerritoryWarfare[];
+    _metadata: RequestMetadataWithLinks;
+}
+
+export interface FactionWarfareChainsResponse {
+    warfarechains: FactionChainWarfare[];
+    _metadata: RequestMetadataWithLinks;
+}
+
+export interface FactionWarfareDirtyBombsResponse {
+    dirtybombs: FactionWarfareDirtyBomb[];
+}
+
 export interface FactionWarfareResponse {
     warfare:
         | FactionRankedWarDetails[]
@@ -9119,6 +9175,51 @@ export interface PropertyLookupResponse {
     selections: PropertySelectionName[];
 }
 
+export interface TornGymModifiers {
+    strength: number;
+    speed: number;
+    defense: number;
+    dexterity: number;
+}
+
+export interface TornGym {
+    id: GymId;
+    name: string;
+    class: GymClassEnum;
+    energy_cost: number;
+    cost: number;
+    modifiers: TornGymModifiers;
+    note: string | null;
+}
+
+export interface TornGymsResponse {
+    gyms: TornGym[];
+}
+
+export interface TornSearchForCash {
+    id: TornSubCrimeId;
+    title: string;
+    percentage: number;
+}
+
+export interface TornSearchForCashResponse {
+    searchforcash: TornSearchForCash[];
+}
+
+export interface TornShopliftingSecurityStatus {
+    title: TornShopliftingStatusTitleEnum;
+    disabled: boolean;
+}
+
+export interface TornShoplifting {
+    id: TornSubCrimeId;
+    status: TornShopliftingSecurityStatus[];
+}
+
+export interface TornShopliftingResponse {
+    shoplifting: TornShoplifting[];
+}
+
 export interface TornCompaniesResponse {
     companies: TornCompany[];
 }
@@ -9443,7 +9544,7 @@ export interface TornSubcrimesResponse {
 }
 
 export interface TornSubcrime {
-    id: number;
+    id: TornSubCrimeId;
     name: string;
     nerve_cost: number;
 }
@@ -9725,7 +9826,7 @@ export interface TornFactionTreeResponse {
 }
 
 /**
- * The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','gyms','itemdetails','itemstats','organisedcrimes','pawnshop','pokertables','rockpaperscissors','searchforcash','shoplifting','stats'.
+ * The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','itemstats','organisedcrimes','pawnshop','pokertables','rockpaperscissors','stats'.
  *  *   The following selections are not available in API v2: 'dirtybombs','raidreport','raids', 'chainreport', 'rackets', 'rankedwarreport', 'rankedwars', 'territorynames', 'territorywarreport', 'territorywars'.
  */
 export type TornSelectionName = string;
@@ -13162,6 +13263,10 @@ export interface UserV2 extends BaseSchema {
             response: UserForumThreadsResponse;
             params: "limit" | "sort" | "from" | "to" | "timestamp";
         };
+        gym: {
+            response: UserGymResponse;
+            params: "timestamp";
+        };
         hof: {
             response: UserHofResponse;
             params: "timestamp";
@@ -13212,7 +13317,8 @@ export interface UserV2 extends BaseSchema {
                 | "limit"
                 | "to"
                 | "from"
-                | "timestamp";
+                | "timestamp"
+                | "nanostamp";
         };
         medals: {
             response: UserMedalsResponse;
@@ -13421,6 +13527,10 @@ export interface FactionV2 extends BaseSchema {
             response: FactionCrimeResponse;
             params: "crimeId" | "timestamp";
         };
+        dirtybombs: {
+            response: FactionWarfareDirtyBombsResponse;
+            params: "timestamp";
+        };
         hof: {
             response: FactionHofResponse;
             params: "timestamp";
@@ -13523,6 +13633,22 @@ export interface FactionV2 extends BaseSchema {
             response: FactionUpgradesResponse;
             params: "timestamp";
         };
+        warfarechains: {
+            response: FactionWarfareChainsResponse;
+            params: "cat" | "limit" | "sort" | "from" | "to" | "timestamp";
+        };
+        warfareraids: {
+            response: FactionWarfareRaidsResponse;
+            params: "limit" | "sort" | "from" | "to" | "timestamp";
+        };
+        warfareranked: {
+            response: FactionWarfareRankedResponse;
+            params: "limit" | "sort" | "from" | "to" | "timestamp";
+        };
+        warfareterritory: {
+            response: FactionWarfareTerritoryWarsResponse;
+            params: "limit" | "sort" | "from" | "to" | "timestamp";
+        };
         warfare: {
             response: FactionWarfareResponse;
             params: "cat" | "limit" | "sort" | "from" | "to" | "timestamp";
@@ -13775,6 +13901,10 @@ export interface TornV2 extends BaseSchema {
             response: TornFactionTreeResponse;
             params: "timestamp";
         };
+        gyms: {
+            response: TornGymsResponse;
+            params: "timestamp";
+        };
         honors: {
             response: TornHonorsResponse;
             params: "limit" | "offset" | "sort" | "timestamp";
@@ -13827,6 +13957,14 @@ export interface TornV2 extends BaseSchema {
             response: TornProperties;
             params: "timestamp";
         };
+        searchforcash: {
+            response: TornSearchForCashResponse;
+            params: "timestamp";
+        };
+        shoplifting: {
+            response: TornShopliftingResponse;
+            params: "timestamp";
+        };
         stocks: {
             response: TornStocksResponse;
             params: "timestamp";