tornapi-typescript 6.7.0 → 6.8.0

package/dist/index.d.ts

@@ -146,6 +146,7 @@ export type CompanyStorageSizeEnum = "Small room" | "Standard room" | "Large roo
 export type HonorRarityEnum = "Extremely Rare" | "Very Rare" | "Rare" | "Limited" | "Uncommon" | "Common" | "Very Common" | "Unknown" | "Unknown Rarity";
 export type AwardCrimesVersionEnum = "v1" | "v2";
 export type CompanySearchParameter = string;
+export type UserSearchParameter = string;
 export type Parameters = string;
 export type ReviveSetting = "Everyone" | "Friends & faction" | "No one" | "Unknown";
 export type FactionWarfareTypeEnum = "ranked" | "territory" | "raid" | "chain" | "chainOngoing" | "db";
@@ -506,6 +507,18 @@ 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 UserSearch {
+    id: UserId;
+    name: string;
+    level: number;
+    online: UserLastActionStatusEnum;
+    faction_id: FactionId;
+    icons: UserIconPublic[];
+}
+export interface UserSearchResponse {
+    search: UserSearch[];
+    _metadata: RequestMetadataWithLinksAndTotal;
+}
 export interface UserPerksResponse {
     perks: {
         faction: string[];
@@ -7386,6 +7399,10 @@ export interface UserV2 extends BaseSchema {
             response: UserSkillsResponse;
             params: "timestamp";
         };
+        search: {
+            response: UserSearchResponse;
+            params: "name" | "filters" | "offset" | "timestamp";
+        };
         snapshot: {
             response: null;
             params: "timestamp";

package/dist/index.ts

@@ -4864,6 +4864,8 @@ export type AwardCrimesVersionEnum = "v1" | "v2";
 
 export type CompanySearchParameter = string;
 
+export type UserSearchParameter = string;
+
 export type Parameters = string;
 
 export type ReviveSetting =
@@ -5521,6 +5523,20 @@ export type ApiError =
     | ErrorCategorySelectionUnavailableForInteractionLogs
     | ErrorFileDoesNotExist;
 
+export interface UserSearch {
+    id: UserId;
+    name: string;
+    level: number;
+    online: UserLastActionStatusEnum;
+    faction_id: FactionId;
+    icons: UserIconPublic[];
+}
+
+export interface UserSearchResponse {
+    search: UserSearch[];
+    _metadata: RequestMetadataWithLinksAndTotal;
+}
+
 export interface UserPerksResponse {
     perks: {
         faction: string[];
@@ -13305,6 +13321,10 @@ export interface UserV2 extends BaseSchema {
             response: UserSkillsResponse;
             params: "timestamp";
         };
+        search: {
+            response: UserSearchResponse;
+            params: "name" | "filters" | "offset" | "timestamp";
+        };
         snapshot: {
             response: null;
             params: "timestamp";

package/dist/openapi.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Torn API",
     "description": "\n * The development of Torn's API v2 is still ongoing.\n * If selections remain unaltered, they will default to the API v1 version.\n * Unlike API v1, API v2 accepts both selections and IDs as path and query parameters.\n * If any discrepancies or errors are found, please submit a [bug report](https://www.torn.com/forums.php#/p=forums&f=19&b=0&a=0) on the Torn Forums.\n * In case you're using bots to check for changes on openapi.json file, make sure to specificy a custom user-agent header - CloudFlare sometimes prevents requests from default user-agents.",
-    "version": "6.7.0"
+    "version": "6.8.0"
   },
   "servers": [
     {
@@ -3281,6 +3281,54 @@
         "x-stability": "Stable"
       }
     },
+    "/user/search": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Search users by name or other criteria",
+        "description": "Requires public access key. <br>This selection is standalone and cannot be used together with other selections.<br>It's always limited to return just 25 records.",
+        "operationId": "getUsersSearch",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/ApiName"
+          },
+          {
+            "$ref": "#/components/parameters/ApiUserSearchFilter"
+          },
+          {
+            "$ref": "#/components/parameters/ApiOffset"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyPublic"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UserSearchResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
     "/user/snapshot": {
       "get": {
         "tags": [
@@ -16355,6 +16403,47 @@
           }
         ]
       },
+      "UserSearchParameter": {
+        "oneOf": [
+          {
+            "type": "string",
+            "enum": [
+              "married",
+              "notMarried",
+              "traveling",
+              "notTraveling",
+              "inFaction",
+              "notInFaction",
+              "inCompany",
+              "notInCompany",
+              "inHospital",
+              "notInHospital",
+              "inJail",
+              "notInJail",
+              "inFederalJail",
+              "notInFederalJail",
+              "male",
+              "female",
+              "enby",
+              "lastActionNow",
+              "lastActionRecent",
+              "lastActionHourAgo",
+              "lastActionDayAgo",
+              "lastActionWeekAgo",
+              "lastActionMonthAgo",
+              "lastActionYearAgo"
+            ]
+          },
+          {
+            "type": "string",
+            "pattern": "^(level|daysOld|offences):(=|!=|<|<=|>=|>|Equal|NotEqual|Less|LessOrEqual|GreaterOrEqual|Greater):\\d+$"
+          },
+          {
+            "type": "string",
+            "pattern": "^factions:\\d+(;\\d+)*$"
+          }
+        ]
+      },
       "Parameters": {
         "oneOf": [
           {
@@ -18445,6 +18534,59 @@
           }
         ]
       },
+      "UserSearch": {
+        "required": [
+          "id",
+          "name",
+          "level",
+          "online",
+          "faction_id",
+          "icons"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/UserId"
+          },
+          "name": {
+            "type": "string"
+          },
+          "level": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "online": {
+            "$ref": "#/components/schemas/UserLastActionStatusEnum"
+          },
+          "faction_id": {
+            "$ref": "#/components/schemas/FactionId"
+          },
+          "icons": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserIconPublic"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "UserSearchResponse": {
+        "required": [
+          "search",
+          "_metadata"
+        ],
+        "properties": {
+          "search": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserSearch"
+            }
+          },
+          "_metadata": {
+            "$ref": "#/components/schemas/RequestMetadataWithLinksAndTotal"
+          }
+        },
+        "type": "object"
+      },
       "UserPerksResponse": {
         "required": [
           "perks"
@@ -35107,7 +35249,7 @@
       "ApiCompanySearchFilter": {
         "name": "filters",
         "in": "query",
-        "description": "A filtering query parameter allowing a comma-separated list of filters. <br>\n *  Each filter can be one of the following:\n *  Fixed options: `recruiting`, `notRecruiting`\n *  Dynamic options: `fieldName`+`condition`+`number`. Each dynamic filter is made out of 3 parts separated by colon `:`:\n *  * `fieldName` is one of: `id`, `type`, `daysOld`, `rating`, `dailyIncome`, `weeklyIncome`, `dailyCustomers`, `weeklyCustomers`\n *  * `condition` is one of: `=`, `!=`, `<`, `<=`, `>=`, `>`, `Equal`, `NotEqual`, `Less`, `LessOrEqual`, `GreaterOrEqual`, `Greater`\n *  * `number`: any integer value\n *  Examples: `filters=recruiting`, `filters=weeklyIncome:>=:20000,id:<:1000,notRecruiting`, `filters=type:Equal:10,rating:=:10,dailyIncome:<=:6666666`",
+        "description": "A filtering query parameter allowing a comma-separated list of filters. <br>\n *  Each filter can be one of the following:\n *  Fixed options: `recruiting`, `notRecruiting`\n *  Dynamic options: `fieldName`+`condition`+`number`. Each dynamic filter is made out of 3 parts separated by colon `:`:\n *  * `fieldName` is one of: `id`, `type`, `daysOld`, `rating`, `dailyIncome`, `weeklyIncome`, `dailyCustomers`, `weeklyCustomers`\n *  * `condition` is one of: `=`, `!=`, `<`, `<=`, `>=`, `>`, `Equal`, `NotEqual`, `Less`, `LessOrEqual`, `GreaterOrEqual`, `Greater`\n *  * `number`: any integer value\n *  Examples:\n * `filters=recruiting`,\n * `filters=weeklyIncome:>=:20000,id:<:1000,notRecruiting`,\n * `filters=type:Equal:10,rating:=:10,dailyIncome:<=:6666666`",
         "required": false,
         "style": "form",
         "explode": false,
@@ -35131,6 +35273,59 @@
           }
         }
       },
+      "ApiUserSearchFilter": {
+        "name": "filters",
+        "in": "query",
+        "description": "A filtering query parameter allowing a comma-separated list of filters. <br>\n *  Filters in this selection reflect on-site filters, and they can be:\n *  One of: `married`, `notMarried`, `traveling`, `notTraveling`, `inFaction`, `notInFaction`, `inCompany`, `notInCompany`, `inHospital`, `notInHospital`, `inJail`, `notInJail`, `inFederalJail`, `notInFederalJail`\n *  Additionally, one of last action: `lastActionNow`, `lastActionRecent`, `lastActionHourAgo`, `lastActionDayAgo`, `lastActionWeekAgo`, `lastActionMonthAgo`, `lastActionYearAgo`\n *  Additionally, one of gender: `male`, `female`, `enby`\n *  Any dynamic option: `fieldName`+`condition`+`number`. Each dynamic filter is made out of 3 parts separated by colon `:`:\n *  * `fieldName` is one of: `level`, `daysOld`, `offences`\n *  * `condition` is one of: `=`, `!=`, `<`, `<=`, `>=`, `>`, `Equal`, `NotEqual`, `Less`, `LessOrEqual`, `GreaterOrEqual`, `Greater`\n *  * `number`: any integer value\n *  Additionally, a dynamic list of faction ids (negates `inFaction` and `notInFaction` filters): `factions`+`:`+`list of ids separated by semicolon ;`\n *  Examples:\n * `filters=married`,\n * `filters=daysOld:>=:5000,offences:>:100000,notInFaction`,\n * `filters=factions:1;2;3`,\n * `filters=level:=:100,lastActionYearAgo,male,inFaction,offences:>=:1000,offences:<=:1000000,daysOld:>:500,daysOld:<:7000`",
+        "required": false,
+        "style": "form",
+        "explode": false,
+        "schema": {
+          "type": "array",
+          "items": {
+            "schema": "UserSearchParameter",
+            "oneOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "married",
+                  "notMarried",
+                  "traveling",
+                  "notTraveling",
+                  "inFaction",
+                  "notInFaction",
+                  "inCompany",
+                  "notInCompany",
+                  "inHospital",
+                  "notInHospital",
+                  "inJail",
+                  "notInJail",
+                  "inFederalJail",
+                  "notInFederalJail",
+                  "male",
+                  "female",
+                  "enby",
+                  "lastActionNow",
+                  "lastActionRecent",
+                  "lastActionHourAgo",
+                  "lastActionDayAgo",
+                  "lastActionWeekAgo",
+                  "lastActionMonthAgo",
+                  "lastActionYearAgo"
+                ]
+              },
+              {
+                "type": "string",
+                "pattern": "^(level|daysOld|offences):(=|!=|<|<=|>=|>|Equal|NotEqual|Less|LessOrEqual|GreaterOrEqual|Greater):\\d+$"
+              },
+              {
+                "type": "string",
+                "pattern": "^factions:\\d+(;\\d+)*$"
+              }
+            ]
+          }
+        }
+      },
       "ApiKeyPublic": {
         "name": "key",
         "in": "query",
@@ -35246,7 +35441,7 @@
       "ApiFactionSearchFilter": {
         "name": "filters",
         "in": "query",
-        "description": "A filtering query parameter allowing a comma-separated list of filters. <br>\n * Each filter can be one of the following:\n * Fixed options: `destroyed`, `notDestroyed`, `recruiting`, `notRecruiting`\n * Dynamic options: `fieldName`+`condition`+`number`. Each dynamic filter is made out of 3 parts separated by colon `:`:\n * * `fieldName` is one of: `id`, `respect`, `members`, `membersMax`\n * * `condition` is one of: `=`, `!=`, `<`, `<=`, `>=`, `>`, `Equal`, `NotEqual`, `Less`, `LessOrEqual`, `GreaterOrEqual`, `Greater`\n * * `number`: any integer value\n * Examples: `filters=destroyed`, `filters=notDestroyed,recruiting`, `filters=respect:>=:20000,id:<:100,notRecruiting`",
+        "description": "A filtering query parameter allowing a comma-separated list of filters. <br>\n * Each filter can be one of the following:\n * Fixed options: `destroyed`, `notDestroyed`, `recruiting`, `notRecruiting`\n * Dynamic options: `fieldName`+`condition`+`number`. Each dynamic filter is made out of 3 parts separated by colon `:`:\n * * `fieldName` is one of: `id`, `respect`, `members`, `membersMax`\n * * `condition` is one of: `=`, `!=`, `<`, `<=`, `>=`, `>`, `Equal`, `NotEqual`, `Less`, `LessOrEqual`, `GreaterOrEqual`, `Greater`\n * * `number`: any integer value\n * Examples:\n * `filters=destroyed`,\n * `filters=notDestroyed,recruiting`,\n * `filters=respect:>=:20000,id:<:100,notRecruiting`",
         "required": false,
         "style": "form",
         "explode": false,
@@ -35284,7 +35479,7 @@
       "ApiName": {
         "name": "name",
         "in": "query",
-        "description": "Name  to search for.",
+        "description": "Name to search for.",
         "required": false,
         "schema": {
           "type": "string"

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "tornapi-typescript",
   "type": "module",
-  "version": "6.7.0",
+  "version": "6.8.0",
   "repository": {
     "url": "git+https://github.com/Torn-Playground/tornapi-typescript.git"
   },