tornapi-typescript 5.7.1 → 5.8.0

package/dist/index.d.ts

@@ -55,7 +55,7 @@ export type JobPositionMedicalEnum = "Medical Student" | "Houseman" | "Senior Ho
 export type JobPositionLawEnum = "Law Student" | "Paralegal" | "Probate Lawyer" | "Trial Lawyer" | "Circuit Court Judge" | "Federal Judge";
 export type JobPositionEducationEnum = "Recess Supervisor" | "Substitute Teacher" | "Elementary Teacher" | "Secondary Teacher" | "Professor" | "Vice-Principal" | "Principal";
 export type RaceCarUpgradeSubCategory = "Engine Cooling" | "Front Diffuser" | "Rear Diffuser" | "Spoiler" | "Brake Accessory" | "Brake Control" | "Callipers" | "Discs" | "Brake Cooling" | "Fluid" | "Rear Control Arms" | "Springs" | "Upper Front Brace" | "Clutch" | "Differential" | "Flywheel" | "Gearbox" | "Shifting" | "Boot" | "Hood" | "Interior" | "Roof" | "Steering wheel" | "Strip out" | "Windows" | "Tyres" | "Wheels" | "Rear Bushes" | "Rear Brace" | "Lower Front Brace" | "Front Tie Rods" | "Front Bushes" | "Seat" | "Safety Accessory" | "Roll cage" | "Overalls" | "Helmet" | "Fire Extinguisher" | "Cut-off" | "Fuel" | "Manifold" | "Exhaust" | "Air Filter" | "Turbo" | "Pistons" | "Intercooler" | "Gasket" | "Fuel Pump" | "Engine Porting" | "Engine Cleaning" | "Computer" | "Camshaft" | "Pads";
-export type FactionApplicationStatusEnum = "accepted" | "declined" | "withdrawn" | "active";
+export type ApplicationStatusEnum = "accepted" | "declined" | "withdrawn" | "active";
 export type FactionRankedWarsCategoryEnum = "all" | "ongoing";
 export type FactionTerritoryWarsCategoryEnum = "finsihed" | "ongoing";
 /**
@@ -86,6 +86,7 @@ export type TerritoryWarId = number;
 export type RaidWarId = number;
 export type ItemUid = number;
 export type UserId = number;
+export type CompanyPositionId = number;
 export type TradeId = number;
 export type StockId = number;
 export type DiscordId = string;
@@ -137,6 +138,8 @@ export interface RequestMetadataWithLinksAndTotal {
  */
 export type ForumFeedTypeEnum = 1 | 2 | 3 | 4 | 5 | 6 | 7;
 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";
 export type HonorRarityEnum = "Extremely Rare" | "Very Rare" | "Rare" | "Limited" | "Uncommon" | "Common" | "Very Common" | "Unknown" | "Unknown Rarity";
 export type AwardCrimesVersionEnum = "v1" | "v2";
 export type Parameters = string;
@@ -2409,7 +2412,7 @@ export interface FactionApplication {
     };
     message: string | null;
     valid_until: number;
-    status: FactionApplicationStatusEnum;
+    status: ApplicationStatusEnum;
 }
 export interface FactionApplicationsResponse {
     applications: FactionApplication[];
@@ -2664,6 +2667,150 @@ export interface FactionRankedWarReportResponse {
         }[];
     };
 }
+/**
+ * The following selections will fallback to API v1 and may change at any time: 'companies', 'news', 'search'.
+ *  *  The following selections are not available in API v2: 'details'.
+ */
+export type CompanySelectionName = string;
+export interface CompanyLookupResponse {
+    selections: CompanySelectionName[];
+}
+export interface CompanyProfileResponse {
+    profile: CompanyProfile;
+}
+export interface CompanyProfileExtendedResponse {
+    profile: CompanyProfileExtended;
+}
+export interface CompanyProfileResponseMixed {
+    profile: CompanyProfile | CompanyProfileExtended;
+}
+export interface CompanyProfileExtended extends CompanyProfile {
+    funds: number;
+    popularity: number;
+    efficiency: number;
+    environment: number;
+    trains: number;
+    applications_allowed: boolean;
+    advertisement_budget: number;
+    upgrades: CompanyUpgrades;
+    value: number;
+}
+export interface CompanyUpgrades {
+    staff_room: CompanyStaffRoomSizeEnum;
+    storage: string;
+    storage_capacity: CompanyStorageSizeEnum;
+}
+export interface CompanyProfile {
+    id: CompanyId;
+    name: string;
+    created_at: number;
+    days_old: number;
+    image: string;
+    type: CompanyType;
+    rating: number;
+    director: CompanyDirector;
+    employees: CompanyEmployees;
+    income: CompanyIncome;
+    customers: CompanyCustomers;
+}
+export interface CompanyType {
+    id: CompanyTypeId;
+    name: string;
+}
+export interface CompanyDirector {
+    id: UserId;
+    name: string;
+    status: UserStatus;
+    last_action: UserLastAction;
+}
+export interface CompanyEmployees {
+    hired: number;
+    capacity: number;
+}
+export interface CompanyIncome {
+    daily: number;
+    weekly: number;
+}
+export interface CompanyCustomers {
+    daily: number;
+    weekly: number;
+}
+export interface CompanyEmployeesResponse {
+    employees: (CompanyEmployee | CompanyEmployeeExtended)[];
+}
+export interface CompanyEmployeesResponseBasic {
+    employees: CompanyEmployee[];
+}
+export interface CompanyEmployeeExtended extends CompanyEmployee {
+    joined_at: number;
+    wage: number;
+    stats: CompanyEmployeeStats;
+    effectiveness: CompanyEmployeeEffectiveness;
+    value: number | null;
+}
+export interface CompanyEmployeeStats {
+    manual_labor: number;
+    intelligence: number;
+    endurance: number;
+}
+export interface CompanyEmployeeEffectiveness {
+    working_stats: number;
+    settled_in: number;
+    book: number;
+    merits: number;
+    director_education: number;
+    management: number;
+    wrong_gender: number;
+    addiction: number;
+    inactivity: number;
+    total: number;
+}
+export interface CompanyEmployee {
+    id: UserId;
+    name: string;
+    position: CompanyEmployeePosition;
+    days_in_company: number;
+    status: UserStatus;
+    last_action: UserLastAction;
+}
+export interface CompanyEmployeePosition {
+    id: CompanyPositionId;
+    name: string;
+}
+export interface CompanyStockResponse {
+    stock: CompanyStockItem[];
+}
+export interface CompanyStockItem {
+    name: string;
+    id: number;
+    cost: number;
+    rrp: number;
+    price: number;
+    in_stock: number;
+    on_order: number;
+    sold_amount: number;
+    sold_worth: number;
+}
+export interface CompanyApplicationsResponse {
+    applications: CompanyApplication[];
+}
+export interface CompanyApplication {
+    player: CompanyApplicationPlayer;
+    message: string | null;
+    expires_at: number;
+    status: ApplicationStatusEnum;
+}
+export interface CompanyApplicationPlayer {
+    id: UserId;
+    name: string;
+    level: number;
+    stats: CompanyApplicationPlayerStats;
+}
+export interface CompanyApplicationPlayerStats {
+    manual_labor: number;
+    intelligence: number;
+    endurance: number;
+}
 export interface ForumCategoriesResponse {
     categories: {
         id: ForumId;
@@ -7239,6 +7386,34 @@ export interface FactionV2 extends BaseSchema {
         };
     };
 }
+export interface CompanyV2 extends BaseSchema {
+    selections: {
+        applications: {
+            response: CompanyApplicationsResponse;
+            params: "timestamp";
+        };
+        employees: {
+            response: CompanyEmployeesResponse;
+            params: "striptags" | "timestamp";
+        };
+        profile: {
+            response: CompanyProfileResponseMixed;
+            params: "striptags" | "timestamp";
+        };
+        stock: {
+            response: CompanyStockResponse;
+            params: "timestamp";
+        };
+        lookup: {
+            response: CompanyLookupResponse;
+            params: "timestamp";
+        };
+        timestamp: {
+            response: TimestampResponse;
+            params: "timestamp";
+        };
+    };
+}
 export interface ForumV2 extends BaseSchema {
     selections: {
         categories: {
@@ -7478,6 +7653,7 @@ export interface TornV2 extends BaseSchema {
 export interface SectionsV2Map {
     user: UserV2;
     faction: FactionV2;
+    company: CompanyV2;
     forum: ForumV2;
     key: KeyV2;
     market: MarketV2;

package/dist/index.ts

@@ -4722,7 +4722,7 @@ export type RaceCarUpgradeSubCategory =
     | "Camshaft"
     | "Pads";
 
-export type FactionApplicationStatusEnum =
+export type ApplicationStatusEnum =
     | "accepted"
     | "declined"
     | "withdrawn"
@@ -4789,6 +4789,8 @@ export type ItemUid = number;
 
 export type UserId = number;
 
+export type CompanyPositionId = number;
+
 export type TradeId = number;
 
 export type StockId = number;
@@ -4871,6 +4873,24 @@ export type ForumFeedTypeEnum = 1 | 2 | 3 | 4 | 5 | 6 | 7;
 
 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";
+
 export type HonorRarityEnum =
     | "Extremely Rare"
     | "Very Rare"
@@ -8055,7 +8075,7 @@ export interface FactionApplication {
     };
     message: string | null;
     valid_until: number;
-    status: FactionApplicationStatusEnum;
+    status: ApplicationStatusEnum;
 }
 
 export interface FactionApplicationsResponse {
@@ -8346,6 +8366,176 @@ export interface FactionRankedWarReportResponse {
     };
 }
 
+/**
+ * The following selections will fallback to API v1 and may change at any time: 'companies', 'news', 'search'.
+ *  *  The following selections are not available in API v2: 'details'.
+ */
+export type CompanySelectionName = string;
+
+export interface CompanyLookupResponse {
+    selections: CompanySelectionName[];
+}
+
+export interface CompanyProfileResponse {
+    profile: CompanyProfile;
+}
+
+export interface CompanyProfileExtendedResponse {
+    profile: CompanyProfileExtended;
+}
+
+export interface CompanyProfileResponseMixed {
+    profile: CompanyProfile | CompanyProfileExtended;
+}
+
+export interface CompanyProfileExtended extends CompanyProfile {
+    funds: number;
+    popularity: number;
+    efficiency: number;
+    environment: number;
+    trains: number;
+    applications_allowed: boolean;
+    advertisement_budget: number;
+    upgrades: CompanyUpgrades;
+    value: number;
+}
+
+export interface CompanyUpgrades {
+    staff_room: CompanyStaffRoomSizeEnum;
+    storage: string;
+    storage_capacity: CompanyStorageSizeEnum;
+}
+
+export interface CompanyProfile {
+    id: CompanyId;
+    name: string;
+    created_at: number;
+    days_old: number;
+    image: string;
+    type: CompanyType;
+    rating: number;
+    director: CompanyDirector;
+    employees: CompanyEmployees;
+    income: CompanyIncome;
+    customers: CompanyCustomers;
+}
+
+export interface CompanyType {
+    id: CompanyTypeId;
+    name: string;
+}
+
+export interface CompanyDirector {
+    id: UserId;
+    name: string;
+    status: UserStatus;
+    last_action: UserLastAction;
+}
+
+export interface CompanyEmployees {
+    hired: number;
+    capacity: number;
+}
+
+export interface CompanyIncome {
+    daily: number;
+    weekly: number;
+}
+
+export interface CompanyCustomers {
+    daily: number;
+    weekly: number;
+}
+
+export interface CompanyEmployeesResponse {
+    employees: (CompanyEmployee | CompanyEmployeeExtended)[];
+}
+
+export interface CompanyEmployeesResponseBasic {
+    employees: CompanyEmployee[];
+}
+
+export interface CompanyEmployeeExtended extends CompanyEmployee {
+    joined_at: number;
+    wage: number;
+    stats: CompanyEmployeeStats;
+    effectiveness: CompanyEmployeeEffectiveness;
+    value: number | null;
+}
+
+export interface CompanyEmployeeStats {
+    manual_labor: number;
+    intelligence: number;
+    endurance: number;
+}
+
+export interface CompanyEmployeeEffectiveness {
+    working_stats: number;
+    settled_in: number;
+    book: number;
+    merits: number;
+    director_education: number;
+    management: number;
+    wrong_gender: number;
+    addiction: number;
+    inactivity: number;
+    total: number;
+}
+
+export interface CompanyEmployee {
+    id: UserId;
+    name: string;
+    position: CompanyEmployeePosition;
+    days_in_company: number;
+    status: UserStatus;
+    last_action: UserLastAction;
+}
+
+export interface CompanyEmployeePosition {
+    id: CompanyPositionId;
+    name: string;
+}
+
+export interface CompanyStockResponse {
+    stock: CompanyStockItem[];
+}
+
+export interface CompanyStockItem {
+    name: string;
+    id: number;
+    cost: number;
+    rrp: number;
+    price: number;
+    in_stock: number;
+    on_order: number;
+    sold_amount: number;
+    sold_worth: number;
+}
+
+export interface CompanyApplicationsResponse {
+    applications: CompanyApplication[];
+}
+
+export interface CompanyApplication {
+    player: CompanyApplicationPlayer;
+    message: string | null;
+    expires_at: number;
+    status: ApplicationStatusEnum;
+}
+
+export interface CompanyApplicationPlayer {
+    id: UserId;
+    name: string;
+    level: number;
+    stats: CompanyApplicationPlayerStats;
+}
+
+export interface CompanyApplicationPlayerStats {
+    manual_labor: number;
+    intelligence: number;
+    endurance: number;
+}
+
 export interface ForumCategoriesResponse {
     categories: {
         id: ForumId;
@@ -13220,6 +13410,34 @@ export interface FactionV2 extends BaseSchema {
         };
     };
 }
+export interface CompanyV2 extends BaseSchema {
+    selections: {
+        applications: {
+            response: CompanyApplicationsResponse;
+            params: "timestamp";
+        };
+        employees: {
+            response: CompanyEmployeesResponse;
+            params: "striptags" | "timestamp";
+        };
+        profile: {
+            response: CompanyProfileResponseMixed;
+            params: "striptags" | "timestamp";
+        };
+        stock: {
+            response: CompanyStockResponse;
+            params: "timestamp";
+        };
+        lookup: {
+            response: CompanyLookupResponse;
+            params: "timestamp";
+        };
+        timestamp: {
+            response: TimestampResponse;
+            params: "timestamp";
+        };
+    };
+}
 export interface ForumV2 extends BaseSchema {
     selections: {
         categories: {
@@ -13476,6 +13694,7 @@ export interface TornV2 extends BaseSchema {
 export interface SectionsV2Map {
     user: UserV2;
     faction: FactionV2;
+    company: CompanyV2;
     forum: ForumV2;
     key: KeyV2;
     market: MarketV2;