tornapi-typescript 0.2.4 → 0.2.7

package/dist/index.d.ts

@@ -9,6 +9,31 @@
 
 export type RaceClassEnum = "A" | "B" | "C" | "D" | "E";
 
+export type CountryEnum =
+    | "Mexico"
+    | "Hawaii"
+    | "South Africa"
+    | "Japan"
+    | "China"
+    | "Argentina"
+    | "Switzerland"
+    | "Canada"
+    | "United Kingdom"
+    | "UAE"
+    | "Cayman Islands";
+
+export type ReportTypeEnum =
+    | "mostwanted"
+    | "money"
+    | "stats"
+    | "references"
+    | "friendorfoe"
+    | "companyfinancials"
+    | "truelevel"
+    | "stockanalysis"
+    | "anonymousbounties"
+    | "investment";
+
 export type ApiKeyAccessTypeEnum =
     | "Custom"
     | "Public Only"
@@ -4174,6 +4199,8 @@ export type FactionStatEnum =
 
 export type FactionBranchStateEnum = "war" | "peace";
 
+export type RacingRaceTypeEnum = "official" | "custom";
+
 export type FactionPositionAbilityEnum =
     | "Medical Item Usage"
     | "Booster Item Usage"
@@ -4573,6 +4600,8 @@ export interface RequestMetadataWithLinksAndTotal {
  */
 export type ForumFeedTypeEnum = 1 | 2 | 3 | 4 | 5 | 6 | 7;
 
+export type Parameters = string;
+
 export type ReviveSetting =
     | "Everyone"
     | "Friends & faction"
@@ -4838,6 +4867,138 @@ export interface TimestampResponse {
     timestamp: number;
 }
 
+export interface ReportBase {
+    type: ReportTypeEnum;
+    target_id: UserId | null;
+    reporter_id: UserId;
+    faction_id: FactionId | null;
+    timestamp: number;
+}
+
+export interface ReportWarrantDetails {
+    id: UserId;
+    name: string;
+    warrant: number;
+}
+
+export interface ReportMostWanted {
+    top: ReportWarrantDetails[];
+    notable: ReportWarrantDetails[];
+}
+
+export interface ReportMoney {
+    money: number;
+}
+
+export interface ReportInvestment {
+    amount: number;
+    until: number;
+}
+
+export interface ReportTrueLevel {
+    level: number;
+}
+
+export interface ReportStats {
+    strength: number | null;
+    speed: number | null;
+    dexterity: number | null;
+    defense: number | null;
+    total: number | null;
+}
+
+export interface ReportHistoryFaction {
+    id: FactionId;
+    name: string;
+    joined: string;
+    left: string | null;
+}
+
+export interface ReportHistoryCompany {
+    id: CompanyId;
+    name: string;
+    joined: string;
+    left: string | null;
+}
+
+export interface ReportHistory {
+    factions: ReportHistoryFaction[];
+    companies: ReportHistoryCompany[];
+}
+
+export interface ReportFriendOrFoeUser {
+    id: UserId;
+    name: string;
+}
+
+export interface ReportFriendOrFoe {
+    friends: ReportFriendOrFoeUser[];
+    enemies: ReportFriendOrFoeUser[];
+}
+
+export interface ReportCompanyFinancials {
+    balance: number;
+    employees: number;
+    wages: {
+        highest: number;
+        lowest: number;
+        average: number;
+    };
+}
+
+export interface ReportStockAnalysis {
+    items: {
+        country: CountryEnum;
+        item: {
+            id: ItemId;
+            name: string;
+            price: number;
+            value: number;
+            due: number | null;
+        };
+        trip_duration: number;
+        hourly_profit: number;
+    }[];
+}
+
+export interface ReportAnonymousBounties {
+    bounties: {
+        text: string;
+        bounty: number;
+        user: {
+            id: UserId;
+            name: string;
+        } | null;
+    }[];
+}
+
+export interface ReportReport {
+    report:
+        | ReportMoney
+        | ReportStats
+        | ReportMostWanted
+        | ReportHistory
+        | ReportFriendOrFoe
+        | ReportCompanyFinancials
+        | ReportTrueLevel
+        | ReportStockAnalysis
+        | ReportAnonymousBounties
+        | ReportInvestment;
+}
+
+export interface Report extends ReportBase, ReportReport {}
+
+export interface ReportsResponse {
+    reports: Report[];
+    _metadata: RequestMetadataWithLinks;
+}
+
+export type SelectionCategoryEnum =
+    | ReportTypeEnum
+    | UserListEnum
+    | PersonalStatsCategoryEnum
+    | RacingRaceTypeEnum;
+
 export interface UserCurrentEducation {
     id: EducationId;
     until: number;
@@ -5186,67 +5347,7 @@ export interface UserListResponse {
 }
 
 /** The following selections will fallback to API v1 and may change at any time: 'ammo','bars','basic','battlestats','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','events','gym','honors','icons','inventory','jobpoints','log','medals','merits','messages','missions','money','networth','newevents','newmessages','notifications','perks','profile','properties','refills','reports','skills','stocks','travel','weaponexp','workstats'. */
-export type UserSelectionName =
-    | "attacks"
-    | "attacksfull"
-    | "bounties"
-    | "calendar"
-    | "crimes"
-    | "enlistedcars"
-    | "factionbalance"
-    | "forumfeed"
-    | "forumfriends"
-    | "forumposts"
-    | "forumsubscribedthreads"
-    | "forumthreads"
-    | "hof"
-    | "itemmarket"
-    | "jobranks"
-    | "list"
-    | "lookup"
-    | "organizedcrime"
-    | "personalstats"
-    | "races"
-    | "revives"
-    | "revivesfull"
-    | "timestamp"
-    | "ammo"
-    | "bars"
-    | "basic"
-    | "battlestats"
-    | "bazaar"
-    | "cooldowns"
-    | "criminalrecord"
-    | "discord"
-    | "display"
-    | "education"
-    | "equipment"
-    | "events"
-    | "gym"
-    | "honors"
-    | "icons"
-    | "inventory"
-    | "jobpoints"
-    | "log"
-    | "medals"
-    | "merits"
-    | "messages"
-    | "missions"
-    | "money"
-    | "networth"
-    | "newevents"
-    | "newmessages"
-    | "notifications"
-    | "perks"
-    | "profile"
-    | "properties"
-    | "refills"
-    | "reports"
-    | "skills"
-    | "stocks"
-    | "travel"
-    | "weaponexp"
-    | "workstats";
+export type UserSelectionName = string;
 
 export interface UserLookupResponse {
     selections: UserSelectionName[];
@@ -6180,6 +6281,30 @@ export interface FactionTerritoryWarFinishedFaction {
     is_aggressor: boolean;
 }
 
+export interface FactionSearchLeader {
+    id: UserId;
+    name: string;
+}
+
+export interface FactionSearch {
+    id: FactionId;
+    name: string;
+    respect: number;
+    members: number;
+    leader: FactionSearchLeader;
+    co_leader: FactionSearchLeader | null;
+    image: string | null;
+    tag_image: string | null;
+    tag: string | null;
+    is_destroyed: boolean;
+    is_recruiting: boolean;
+}
+
+export interface FactionSearchResponse {
+    search: FactionSearch[];
+    _metadata: RequestMetadataWithLinks;
+}
+
 export interface FactionTerritoryWarFinished {
     id: TerritoryWarId;
     territory: FactionTerritoryEnum;
@@ -6740,58 +6865,10 @@ export interface FactionBalanceResponse {
 }
 
 /**
- * The following selections will fallback to API v1 and may change at any time: 'armor', 'boosters', 'caches', 'cesium', 'crimeexp', 'drugs', 'medical', 'positions', 'reports', 'temporary', 'weapons'.
- *  * The following selections are not available in API v2: 'armorynews', 'attacknews', 'crimenews', 'currency', 'donations', 'fundsnews', 'mainnews', 'membershipnews', 'territorynews'.
+ * The following selections will fallback to API v1 and may change at any time: 'armor', 'boosters', 'caches', 'cesium', 'crimeexp', 'drugs', 'medical', 'temporary', 'weapons'.
+ *  *  The following selections are not available in API v2: 'armorynews', 'attacknews', 'crimenews', 'currency', 'donations', 'fundsnews', 'mainnews', 'membershipnews', 'territorynews'.
  */
-export type FactionSelectionName =
-    | "applications"
-    | "attacks"
-    | "attacksfull"
-    | "balance"
-    | "basic"
-    | "chain"
-    | "chainreport"
-    | "chains"
-    | "contributors"
-    | "crime"
-    | "crimes"
-    | "hof"
-    | "lookup"
-    | "members"
-    | "news"
-    | "rackets"
-    | "rankedwars"
-    | "rankedwarreport"
-    | "revives"
-    | "revivesfull"
-    | "stats"
-    | "territory"
-    | "territoryownership"
-    | "territorywarreport"
-    | "territorywars"
-    | "timestamp"
-    | "upgrades"
-    | "wars"
-    | "armor"
-    | "boosters"
-    | "caches"
-    | "cesium"
-    | "crimeexp"
-    | "drugs"
-    | "medical"
-    | "positions"
-    | "reports"
-    | "temporary"
-    | "weapons"
-    | "armorynews"
-    | "attacknews"
-    | "crimenews"
-    | "currency"
-    | "donations"
-    | "fundsnews"
-    | "mainnews"
-    | "membershipnews"
-    | "territorynews";
+export type FactionSelectionName = string;
 
 export interface FactionLookupResponse {
     selections: FactionSelectionName[];
@@ -6966,13 +7043,7 @@ export interface ForumPostsResponse {
     _metadata: RequestMetadataWithLinks;
 }
 
-export type ForumSelectionName =
-    | "categories"
-    | "lookup"
-    | "posts"
-    | "thread"
-    | "threads"
-    | "timestamp";
+export type ForumSelectionName = string;
 
 export interface ForumLookupResponse {
     selections: ForumSelectionName[];
@@ -6983,7 +7054,7 @@ export interface KeyLogResponse {
         timestamp: number;
         type: string;
         selections: string;
-        id: number | null;
+        id: number | string | null;
         comment?: string | null;
         ip: string;
     }[];
@@ -7013,7 +7084,7 @@ export interface KeyInfoResponse {
     };
 }
 
-export type KeySelectionName = "info" | "log";
+export type KeySelectionName = string;
 
 export interface ItemMarketListingItemBonus {
     id: number;
@@ -7057,6 +7128,8 @@ export interface ItemMarketListingNonstackable {
 export interface ItemMarket {
     item: ItemMarketItem;
     listings: (ItemMarketListingNonstackable | ItemMarketListingStackable)[];
+    /** Timestamp when the data was globally cached at. */
+    cache_timestamp: number;
 }
 
 export interface MarketItemMarketResponse {
@@ -7065,12 +7138,7 @@ export interface MarketItemMarketResponse {
 }
 
 /** The following selections will fallback to API v1 and may change at any time: 'pointsmarket'. */
-export type MarketSelectionName =
-    | "itemmarket"
-    | "lookup"
-    | "timestamp"
-    | "pointsmarket"
-    | "bazaar";
+export type MarketSelectionName = string;
 
 export interface MarketLookupResponse {
     selections: MarketSelectionName[];
@@ -7193,15 +7261,7 @@ export interface RacingRaceDetailsResponse {
     };
 }
 
-export type RacingSelectionName =
-    | "cars"
-    | "carupgrades"
-    | "lookup"
-    | "race"
-    | "races"
-    | "records"
-    | "timestamp"
-    | "tracks";
+export type RacingSelectionName = string;
 
 export interface RacingLookupResponse {
     selections: RacingSelectionName[];
@@ -7537,55 +7597,9 @@ export interface TornFactionTreeResponse {
 
 /**
  * The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','dirtybombs','gyms','honors','itemdetails','itemstats','medals','organisedcrimes','pawnshop','pokertables','properties','raidreport','raids','rockpaperscissors','searchforcash','shoplifting','stats','stocks'.
- *  *  The following selections are not available in API v2: 'chainreport', 'rackets', 'rankedwarreport', 'rankedwars', 'territorynames', 'territorywarreport', 'territorywars'.
+ *  *   The following selections are not available in API v2: 'chainreport', 'rackets', 'rankedwarreport', 'rankedwars', 'territorynames', 'territorywarreport', 'territorywars'.
  */
-export type TornSelectionName =
-    | "attacklog"
-    | "bounties"
-    | "calendar"
-    | "crimes"
-    | "education"
-    | "factionhof"
-    | "factiontree"
-    | "hof"
-    | "itemammo"
-    | "itemmods"
-    | "items"
-    | "logcategories"
-    | "logtypes"
-    | "lookup"
-    | "subcrimes"
-    | "territory"
-    | "timestamp"
-    | "bank"
-    | "cards"
-    | "cityshops"
-    | "companies"
-    | "competition"
-    | "dirtybombs"
-    | "gyms"
-    | "honors"
-    | "itemdetails"
-    | "itemstats"
-    | "medals"
-    | "organisedcrimes"
-    | "pawnshop"
-    | "pokertables"
-    | "properties"
-    | "raidreport"
-    | "raids"
-    | "rockpaperscissors"
-    | "searchforcash"
-    | "shoplifting"
-    | "stats"
-    | "stocks"
-    | "chainreport"
-    | "rackets"
-    | "rankedwarreport"
-    | "rankedwars"
-    | "territorynames"
-    | "territorywarreport"
-    | "territorywars";
+export type TornSelectionName = string;
 
 export interface TornLookupResponse {
     selections: TornSelectionName[];