swcombine-sdk 2.2.3 → 3.0.0-beta.0

package/dist/types/auth/scopes.d.ts

@@ -2,7 +2,8 @@
  * OAuth Scopes for SW Combine API
  *
  * This module defines all available OAuth scopes and provides utilities
- * for requesting common scope combinations.
+ * for requesting common scope combinations. Scope values mirror the
+ * permission names returned by the API permissions catalog.
  *
  * @see https://www.swcombine.com/ws/developers/permissions/
  */
@@ -12,9 +13,9 @@
 export declare const CharacterScopes: {
     /** Solely provides the character name and ID for use by clients who want to verify a character's identity */
     readonly AUTH: "character_auth";
-    /** Read basic character information (UID, handle, image, race, gender, etc.) */
+    /** Read basic character information.<br/>If your profile is private, this will return unique ID, handle, and image.<br/>If your profile is not private, this will also return your race, gender, last login, description, and biography. */
     readonly READ: "character_read";
-    /** Read character HP and XP */
+    /** Read information about the character's HP and XP */
     readonly STATS: "character_stats";
     /** Read character privileges */
     readonly PRIVILEGES: "character_privileges";
@@ -24,138 +25,424 @@ export declare const CharacterScopes: {
     readonly CREDITS: "character_credits";
     /** Transfer character credits */
     readonly CREDITS_WRITE: "character_credits_write";
-    /** Read character force-related information (FP, FXP, regen rate, Force Meter) */
+    /** Read character force-related information.<br/>If you are Force-aware, this will return Master or Student where applicable, as well as FP, FXP, regen rate, and Force Meter. */
     readonly FORCE: "character_force";
-    /** Read location information in-game */
+    /** Read your location in-game */
     readonly LOCATION: "character_location";
-    /** Read character events */
+    /** Read the characters' events */
     readonly EVENTS: "character_events";
-    /** Access all character information (includes all above) */
+    /** Access all character information */
     readonly ALL: "character_all";
 };
 /**
  * Message-related scopes
  */
 export declare const MessageScopes: {
-    /** Read messages */
+    /** Read messages sent to or by the character */
     readonly READ: "messages_read";
-    /** Send messages */
+    /** Send messages to or from the character */
     readonly SEND: "messages_send";
-    /** Delete messages */
+    /** Delete messages to or from the character */
     readonly DELETE: "messages_delete";
-    /** All message permissions */
+    /** Read, send and delete messages to or from the character */
     readonly ALL: "messages_all";
 };
 /**
  * Personal inventory scopes
  */
 export declare const PersonalInventoryScopes: {
-    /** Overview of personal inventory */
+    /** Read basic information about your inventories */
     readonly OVERVIEW: "personal_inv_overview";
     /** Personal ship scopes */
-    readonly SHIPS: Record<string, string>;
+    readonly SHIPS: {
+        /** Read basic information about your ships */
+        readonly READ: "personal_inv_ships_read";
+        /** Rename your ships */
+        readonly RENAME: "personal_inv_ships_rename";
+        /** Assign your ships */
+        readonly ASSIGN: "personal_inv_ships_assign";
+        /** Make over your ships */
+        readonly MAKEOVER: "personal_inv_ships_makeover";
+        /** Read the tags assigned to your ships */
+        readonly TAGS_READ: "personal_inv_ships_tags_read";
+        /** Modify the tags assigned to your ships */
+        readonly TAGS_WRITE: "personal_inv_ships_tags_write";
+        /** Access and change anything in your ship inventory */
+        readonly ALL: "personal_inv_ships_all";
+    };
     /** Personal vehicle scopes */
-    readonly VEHICLES: Record<string, string>;
+    readonly VEHICLES: {
+        /** Read basic information about your vehicles */
+        readonly READ: "personal_inv_vehicles_read";
+        /** Rename your vehicles */
+        readonly RENAME: "personal_inv_vehicles_rename";
+        /** Assign your vehicles */
+        readonly ASSIGN: "personal_inv_vehicles_assign";
+        /** Make over your vehicles */
+        readonly MAKEOVER: "personal_inv_vehicles_makeover";
+        /** Read the tags assigned to your vehicles */
+        readonly TAGS_READ: "personal_inv_vehicles_tags_read";
+        /** Modify the tags assigned to your vehicles */
+        readonly TAGS_WRITE: "personal_inv_vehicles_tags_write";
+        /** Access and change anything in your vehicle inventory */
+        readonly ALL: "personal_inv_vehicles_all";
+    };
     /** Personal station scopes */
-    readonly STATIONS: Record<string, string>;
+    readonly STATIONS: {
+        /** Read basic information about your space stations */
+        readonly READ: "personal_inv_stations_read";
+        /** Rename your space stations */
+        readonly RENAME: "personal_inv_stations_rename";
+        /** Assign your space stations */
+        readonly ASSIGN: "personal_inv_stations_assign";
+        /** Make over your space stations */
+        readonly MAKEOVER: "personal_inv_stations_makeover";
+        /** Read the tags assigned to your space stations */
+        readonly TAGS_READ: "personal_inv_stations_tags_read";
+        /** Modify the tags assigned to your space stations */
+        readonly TAGS_WRITE: "personal_inv_stations_tags_write";
+        /** Access and change anything in your space station inventory */
+        readonly ALL: "personal_inv_stations_all";
+    };
     /** Personal city scopes */
-    readonly CITIES: Record<string, string>;
+    readonly CITIES: {
+        /** Read basic information about your cities */
+        readonly READ: "personal_inv_cities_read";
+        /** Rename your cities */
+        readonly RENAME: "personal_inv_cities_rename";
+        /** Assign your cities */
+        readonly ASSIGN: "personal_inv_cities_assign";
+        /** Make over your cities */
+        readonly MAKEOVER: "personal_inv_cities_makeover";
+        /** Read the tags assigned to your cities */
+        readonly TAGS_READ: "personal_inv_cities_tags_read";
+        /** Modify the tags assigned to your cities */
+        readonly TAGS_WRITE: "personal_inv_cities_tags_write";
+        /** Access and change anything in your city inventory */
+        readonly ALL: "personal_inv_cities_all";
+    };
     /** Personal facility scopes */
-    readonly FACILITIES: Record<string, string>;
+    readonly FACILITIES: {
+        /** Read basic information about your facilities */
+        readonly READ: "personal_inv_facilities_read";
+        /** Rename your facilities */
+        readonly RENAME: "personal_inv_facilities_rename";
+        /** Assign your facilities */
+        readonly ASSIGN: "personal_inv_facilities_assign";
+        /** Make over your facilities */
+        readonly MAKEOVER: "personal_inv_facilities_makeover";
+        /** Read the tags assigned to your facilities */
+        readonly TAGS_READ: "personal_inv_facilities_tags_read";
+        /** Modify the tags assigned to your facilities */
+        readonly TAGS_WRITE: "personal_inv_facilities_tags_write";
+        /** Access and change anything in your facility inventory */
+        readonly ALL: "personal_inv_facilities_all";
+    };
     /** Personal planet scopes (no RENAME/MAKEOVER) */
-    readonly PLANETS: Record<string, string>;
+    readonly PLANETS: {
+        /** Read basic information about your planets */
+        readonly READ: "personal_inv_planets_read";
+        /** Assign your planets */
+        readonly ASSIGN: "personal_inv_planets_assign";
+        /** Read the tags assigned to your planets */
+        readonly TAGS_READ: "personal_inv_planets_tags_read";
+        /** Modify the tags assigned to your planets */
+        readonly TAGS_WRITE: "personal_inv_planets_tags_write";
+        /** Access and change anything in your planet inventory */
+        readonly ALL: "personal_inv_planets_all";
+    };
     /** Personal item scopes */
-    readonly ITEMS: Record<string, string>;
+    readonly ITEMS: {
+        /** Read basic information about your items */
+        readonly READ: "personal_inv_items_read";
+        /** Rename your items */
+        readonly RENAME: "personal_inv_items_rename";
+        /** Assign your items */
+        readonly ASSIGN: "personal_inv_items_assign";
+        /** Make over your items */
+        readonly MAKEOVER: "personal_inv_items_makeover";
+        /** Read the tags assigned to your items */
+        readonly TAGS_READ: "personal_inv_items_tags_read";
+        /** Modify the tags assigned to your items */
+        readonly TAGS_WRITE: "personal_inv_items_tags_write";
+        /** Access and change anything in your item inventory */
+        readonly ALL: "personal_inv_items_all";
+    };
     /** Personal NPC scopes (has MAKEOVER but no RENAME) */
     readonly NPCS: {
+        /** Read basic information about your NPCs */
         readonly READ: "personal_inv_npcs_read";
+        /** Assign your NPCs */
         readonly ASSIGN: "personal_inv_npcs_assign";
+        /** Make over your NPCs */
         readonly MAKEOVER: "personal_inv_npcs_makeover";
+        /** Read the tags assigned to your NPCs */
         readonly TAGS_READ: "personal_inv_npcs_tags_read";
+        /** Modify the tags assigned to your NPCs */
         readonly TAGS_WRITE: "personal_inv_npcs_tags_write";
+        /** Access and change anything in your NPC inventory */
         readonly ALL: "personal_inv_npcs_all";
     };
     /** Personal droid scopes */
-    readonly DROIDS: Record<string, string>;
+    readonly DROIDS: {
+        /** Read basic information about your droids */
+        readonly READ: "personal_inv_droids_read";
+        /** Rename your droids */
+        readonly RENAME: "personal_inv_droids_rename";
+        /** Assign your droids */
+        readonly ASSIGN: "personal_inv_droids_assign";
+        /** Make over your droids */
+        readonly MAKEOVER: "personal_inv_droids_makeover";
+        /** Read the tags assigned to your droids */
+        readonly TAGS_READ: "personal_inv_droids_tags_read";
+        /** Modify the tags assigned to your droids */
+        readonly TAGS_WRITE: "personal_inv_droids_tags_write";
+        /** Access and change anything in your droid inventory */
+        readonly ALL: "personal_inv_droids_all";
+    };
     /** Personal material scopes (no ASSIGN) */
     readonly MATERIALS: {
+        /** Read basic information about your materials */
         readonly READ: "personal_inv_materials_read";
+        /** Rename your materials */
         readonly RENAME: "personal_inv_materials_rename";
+        /** Make over your materials */
         readonly MAKEOVER: "personal_inv_materials_makeover";
+        /** Read the tags assigned to your materials */
         readonly TAGS_READ: "personal_inv_materials_tags_read";
+        /** Modify the tags assigned to your materials */
         readonly TAGS_WRITE: "personal_inv_materials_tags_write";
+        /** Access and change anything in your material inventory */
         readonly ALL: "personal_inv_materials_all";
     };
     /** Personal creature scopes */
-    readonly CREATURES: Record<string, string>;
+    readonly CREATURES: {
+        /** Read basic information about your creatures */
+        readonly READ: "personal_inv_creatures_read";
+        /** Rename your creatures */
+        readonly RENAME: "personal_inv_creatures_rename";
+        /** Assign your creatures */
+        readonly ASSIGN: "personal_inv_creatures_assign";
+        /** Make over your creatures */
+        readonly MAKEOVER: "personal_inv_creatures_makeover";
+        /** Read the tags assigned to your creatures */
+        readonly TAGS_READ: "personal_inv_creatures_tags_read";
+        /** Modify the tags assigned to your creatures */
+        readonly TAGS_WRITE: "personal_inv_creatures_tags_write";
+        /** Access and change anything in your creature inventory */
+        readonly ALL: "personal_inv_creatures_all";
+    };
 };
 /**
  * Faction management scopes
  */
 export declare const FactionScopes: {
-    /** Read faction information */
+    /** Read basic information about your faction */
     readonly READ: "faction_read";
-    /** Read faction members */
+    /** See your faction's members list */
     readonly MEMBERS: "faction_members";
-    /** Read faction stocks */
+    /** See the stocks your faction owns */
     readonly STOCKS: "faction_stocks";
-    /** Read faction credits */
+    /** See how many credits your faction owns */
     readonly CREDITS_READ: "faction_credits_read";
-    /** Write/transfer faction credits */
+    /** Transfer credits on behalf of your faction */
     readonly CREDITS_WRITE: "faction_credits_write";
-    /** Read faction budgets */
+    /** See your faction's budgets */
     readonly BUDGETS_READ: "faction_budgets_read";
-    /** Write faction budgets */
+    /** Change your faction's budgets */
     readonly BUDGETS_WRITE: "faction_budgets_write";
-    /** Read faction datacards */
+    /** See your faction's datacard assignments */
     readonly DATACARDS_READ: "faction_datacards_read";
-    /** Write faction datacards */
+    /** Assign or revoke your faction's datacard assignments */
     readonly DATACARDS_WRITE: "faction_datacards_write";
-    /** All faction permissions */
+    /** Access and change anything in your faction */
     readonly ALL: "faction_all";
 };
 /**
  * Faction inventory scopes
  */
 export declare const FactionInventoryScopes: {
-    /** Overview of faction inventory */
+    /** Read basic information about your faction's inventories */
     readonly OVERVIEW: "faction_inv_overview";
     /** Faction ship scopes */
-    readonly SHIPS: Record<string, string>;
+    readonly SHIPS: {
+        /** Read basic information about your faction's ships */
+        readonly READ: "faction_inv_ships_read";
+        /** Rename your faction's ships */
+        readonly RENAME: "faction_inv_ships_rename";
+        /** Assign your faction's ships */
+        readonly ASSIGN: "faction_inv_ships_assign";
+        /** Make over your faction's ships */
+        readonly MAKEOVER: "faction_inv_ships_makeover";
+        /** Read the tags assigned to your faction's ships */
+        readonly TAGS_READ: "faction_inv_ships_tags_read";
+        /** Modify the tags assigned to your faction's ships */
+        readonly TAGS_WRITE: "faction_inv_ships_tags_write";
+        /** Access and change anything in your faction's ship inventory */
+        readonly ALL: "faction_inv_ships_all";
+    };
     /** Faction vehicle scopes */
-    readonly VEHICLES: Record<string, string>;
+    readonly VEHICLES: {
+        /** Read basic information about your faction's vehicles */
+        readonly READ: "faction_inv_vehicles_read";
+        /** Rename your faction's vehicles */
+        readonly RENAME: "faction_inv_vehicles_rename";
+        /** Assign your faction's vehicles */
+        readonly ASSIGN: "faction_inv_vehicles_assign";
+        /** Make over your faction's vehicles */
+        readonly MAKEOVER: "faction_inv_vehicles_makeover";
+        /** Read the tags assigned to your faction's vehicles */
+        readonly TAGS_READ: "faction_inv_vehicles_tags_read";
+        /** Modify the tags assigned to your faction's vehicles */
+        readonly TAGS_WRITE: "faction_inv_vehicles_tags_write";
+        /** Access and change anything in your faction's vehicle inventory */
+        readonly ALL: "faction_inv_vehicles_all";
+    };
     /** Faction station scopes */
-    readonly STATIONS: Record<string, string>;
+    readonly STATIONS: {
+        /** Read basic information about your faction's space stations */
+        readonly READ: "faction_inv_stations_read";
+        /** Rename your faction's space stations */
+        readonly RENAME: "faction_inv_stations_rename";
+        /** Assign your faction's space stations */
+        readonly ASSIGN: "faction_inv_stations_assign";
+        /** Make over your faction's space stations */
+        readonly MAKEOVER: "faction_inv_stations_makeover";
+        /** Read the tags assigned to your faction's space stations */
+        readonly TAGS_READ: "faction_inv_stations_tags_read";
+        /** Modify the tags assigned to your faction's space stations */
+        readonly TAGS_WRITE: "faction_inv_stations_tags_write";
+        /** Access and change anything in your faction's space station inventory */
+        readonly ALL: "faction_inv_stations_all";
+    };
     /** Faction city scopes */
-    readonly CITIES: Record<string, string>;
+    readonly CITIES: {
+        /** Read basic information about your faction's cities */
+        readonly READ: "faction_inv_cities_read";
+        /** Rename your faction's cities */
+        readonly RENAME: "faction_inv_cities_rename";
+        /** Assign your faction's cities */
+        readonly ASSIGN: "faction_inv_cities_assign";
+        /** Make over your faction's cities */
+        readonly MAKEOVER: "faction_inv_cities_makeover";
+        /** Read the tags assigned to your faction's cities */
+        readonly TAGS_READ: "faction_inv_cities_tags_read";
+        /** Modify the tags assigned to your faction's cities */
+        readonly TAGS_WRITE: "faction_inv_cities_tags_write";
+        /** Access and change anything in your faction's city inventory */
+        readonly ALL: "faction_inv_cities_all";
+    };
     /** Faction facility scopes */
-    readonly FACILITIES: Record<string, string>;
+    readonly FACILITIES: {
+        /** Read basic information about your faction's facilities */
+        readonly READ: "faction_inv_facilities_read";
+        /** Rename your faction's facilities */
+        readonly RENAME: "faction_inv_facilities_rename";
+        /** Assign your faction's facilities */
+        readonly ASSIGN: "faction_inv_facilities_assign";
+        /** Make over your faction's facilities */
+        readonly MAKEOVER: "faction_inv_facilities_makeover";
+        /** Read the tags assigned to your faction's facilities */
+        readonly TAGS_READ: "faction_inv_facilities_tags_read";
+        /** Modify the tags assigned to your faction's facilities */
+        readonly TAGS_WRITE: "faction_inv_facilities_tags_write";
+        /** Access and change anything in your faction's facility inventory */
+        readonly ALL: "faction_inv_facilities_all";
+    };
     /** Faction planet scopes (no RENAME/MAKEOVER) */
-    readonly PLANETS: Record<string, string>;
+    readonly PLANETS: {
+        /** Read basic information about your faction's planets */
+        readonly READ: "faction_inv_planets_read";
+        /** Assign your faction's planets */
+        readonly ASSIGN: "faction_inv_planets_assign";
+        /** Read the tags assigned to your faction's planets */
+        readonly TAGS_READ: "faction_inv_planets_tags_read";
+        /** Modify the tags assigned to your faction's planets */
+        readonly TAGS_WRITE: "faction_inv_planets_tags_write";
+        /** Access and change anything in your faction's planet inventory */
+        readonly ALL: "faction_inv_planets_all";
+    };
     /** Faction item scopes */
-    readonly ITEMS: Record<string, string>;
+    readonly ITEMS: {
+        /** Read basic information about your faction's items */
+        readonly READ: "faction_inv_items_read";
+        /** Rename your faction's items */
+        readonly RENAME: "faction_inv_items_rename";
+        /** Assign your faction's items */
+        readonly ASSIGN: "faction_inv_items_assign";
+        /** Make over your faction's items */
+        readonly MAKEOVER: "faction_inv_items_makeover";
+        /** Read the tags assigned to your faction's items */
+        readonly TAGS_READ: "faction_inv_items_tags_read";
+        /** Modify the tags assigned to your faction's items */
+        readonly TAGS_WRITE: "faction_inv_items_tags_write";
+        /** Access and change anything in your faction's item inventory */
+        readonly ALL: "faction_inv_items_all";
+    };
     /** Faction NPC scopes (has MAKEOVER but no RENAME) */
     readonly NPCS: {
+        /** Read basic information about your faction's NPCs */
         readonly READ: "faction_inv_npcs_read";
+        /** Assign your faction's NPCs */
         readonly ASSIGN: "faction_inv_npcs_assign";
+        /** Make over your faction's NPCs */
         readonly MAKEOVER: "faction_inv_npcs_makeover";
+        /** Read the tags assigned to your faction's NPCs */
         readonly TAGS_READ: "faction_inv_npcs_tags_read";
+        /** Modify the tags assigned to your faction's NPCs */
         readonly TAGS_WRITE: "faction_inv_npcs_tags_write";
+        /** Access and change anything in your faction's NPC inventory */
         readonly ALL: "faction_inv_npcs_all";
     };
     /** Faction droid scopes */
-    readonly DROIDS: Record<string, string>;
+    readonly DROIDS: {
+        /** Read basic information about your faction's droids */
+        readonly READ: "faction_inv_droids_read";
+        /** Rename your faction's droids */
+        readonly RENAME: "faction_inv_droids_rename";
+        /** Assign your faction's droids */
+        readonly ASSIGN: "faction_inv_droids_assign";
+        /** Make over your faction's droids */
+        readonly MAKEOVER: "faction_inv_droids_makeover";
+        /** Read the tags assigned to your faction's droids */
+        readonly TAGS_READ: "faction_inv_droids_tags_read";
+        /** Modify the tags assigned to your faction's droids */
+        readonly TAGS_WRITE: "faction_inv_droids_tags_write";
+        /** Access and change anything in your faction's droid inventory */
+        readonly ALL: "faction_inv_droids_all";
+    };
     /** Faction material scopes (no ASSIGN) */
     readonly MATERIALS: {
+        /** Read basic information about your faction's materials */
         readonly READ: "faction_inv_materials_read";
+        /** Rename your faction's materials */
         readonly RENAME: "faction_inv_materials_rename";
+        /** Make over your faction's materials */
         readonly MAKEOVER: "faction_inv_materials_makeover";
+        /** Read the tags assigned to your faction's materials */
         readonly TAGS_READ: "faction_inv_materials_tags_read";
+        /** Modify the tags assigned to your faction's materials */
         readonly TAGS_WRITE: "faction_inv_materials_tags_write";
+        /** Access and change anything in your faction's material inventory */
         readonly ALL: "faction_inv_materials_all";
     };
     /** Faction creature scopes */
-    readonly CREATURES: Record<string, string>;
+    readonly CREATURES: {
+        /** Read basic information about your faction's creatures */
+        readonly READ: "faction_inv_creatures_read";
+        /** Rename your faction's creatures */
+        readonly RENAME: "faction_inv_creatures_rename";
+        /** Assign your faction's creatures */
+        readonly ASSIGN: "faction_inv_creatures_assign";
+        /** Make over your faction's creatures */
+        readonly MAKEOVER: "faction_inv_creatures_makeover";
+        /** Read the tags assigned to your faction's creatures */
+        readonly TAGS_READ: "faction_inv_creatures_tags_read";
+        /** Modify the tags assigned to your faction's creatures */
+        readonly TAGS_WRITE: "faction_inv_creatures_tags_write";
+        /** Access and change anything in your faction's creature inventory */
+        readonly ALL: "faction_inv_creatures_all";
+    };
 };
 /**
  * All available scopes organized by category
@@ -164,9 +451,9 @@ export declare const Scopes: {
     readonly Character: {
         /** Solely provides the character name and ID for use by clients who want to verify a character's identity */
         readonly AUTH: "character_auth";
-        /** Read basic character information (UID, handle, image, race, gender, etc.) */
+        /** Read basic character information.<br/>If your profile is private, this will return unique ID, handle, and image.<br/>If your profile is not private, this will also return your race, gender, last login, description, and biography. */
         readonly READ: "character_read";
-        /** Read character HP and XP */
+        /** Read information about the character's HP and XP */
         readonly STATS: "character_stats";
         /** Read character privileges */
         readonly PRIVILEGES: "character_privileges";
@@ -176,126 +463,412 @@ export declare const Scopes: {
         readonly CREDITS: "character_credits";
         /** Transfer character credits */
         readonly CREDITS_WRITE: "character_credits_write";
-        /** Read character force-related information (FP, FXP, regen rate, Force Meter) */
+        /** Read character force-related information.<br/>If you are Force-aware, this will return Master or Student where applicable, as well as FP, FXP, regen rate, and Force Meter. */
         readonly FORCE: "character_force";
-        /** Read location information in-game */
+        /** Read your location in-game */
         readonly LOCATION: "character_location";
-        /** Read character events */
+        /** Read the characters' events */
         readonly EVENTS: "character_events";
-        /** Access all character information (includes all above) */
+        /** Access all character information */
         readonly ALL: "character_all";
     };
     readonly Messages: {
-        /** Read messages */
+        /** Read messages sent to or by the character */
         readonly READ: "messages_read";
-        /** Send messages */
+        /** Send messages to or from the character */
         readonly SEND: "messages_send";
-        /** Delete messages */
+        /** Delete messages to or from the character */
         readonly DELETE: "messages_delete";
-        /** All message permissions */
+        /** Read, send and delete messages to or from the character */
         readonly ALL: "messages_all";
     };
     readonly PersonalInventory: {
-        /** Overview of personal inventory */
+        /** Read basic information about your inventories */
         readonly OVERVIEW: "personal_inv_overview";
         /** Personal ship scopes */
-        readonly SHIPS: Record<string, string>;
+        readonly SHIPS: {
+            /** Read basic information about your ships */
+            readonly READ: "personal_inv_ships_read";
+            /** Rename your ships */
+            readonly RENAME: "personal_inv_ships_rename";
+            /** Assign your ships */
+            readonly ASSIGN: "personal_inv_ships_assign";
+            /** Make over your ships */
+            readonly MAKEOVER: "personal_inv_ships_makeover";
+            /** Read the tags assigned to your ships */
+            readonly TAGS_READ: "personal_inv_ships_tags_read";
+            /** Modify the tags assigned to your ships */
+            readonly TAGS_WRITE: "personal_inv_ships_tags_write";
+            /** Access and change anything in your ship inventory */
+            readonly ALL: "personal_inv_ships_all";
+        };
         /** Personal vehicle scopes */
-        readonly VEHICLES: Record<string, string>;
+        readonly VEHICLES: {
+            /** Read basic information about your vehicles */
+            readonly READ: "personal_inv_vehicles_read";
+            /** Rename your vehicles */
+            readonly RENAME: "personal_inv_vehicles_rename";
+            /** Assign your vehicles */
+            readonly ASSIGN: "personal_inv_vehicles_assign";
+            /** Make over your vehicles */
+            readonly MAKEOVER: "personal_inv_vehicles_makeover";
+            /** Read the tags assigned to your vehicles */
+            readonly TAGS_READ: "personal_inv_vehicles_tags_read";
+            /** Modify the tags assigned to your vehicles */
+            readonly TAGS_WRITE: "personal_inv_vehicles_tags_write";
+            /** Access and change anything in your vehicle inventory */
+            readonly ALL: "personal_inv_vehicles_all";
+        };
         /** Personal station scopes */
-        readonly STATIONS: Record<string, string>;
+        readonly STATIONS: {
+            /** Read basic information about your space stations */
+            readonly READ: "personal_inv_stations_read";
+            /** Rename your space stations */
+            readonly RENAME: "personal_inv_stations_rename";
+            /** Assign your space stations */
+            readonly ASSIGN: "personal_inv_stations_assign";
+            /** Make over your space stations */
+            readonly MAKEOVER: "personal_inv_stations_makeover";
+            /** Read the tags assigned to your space stations */
+            readonly TAGS_READ: "personal_inv_stations_tags_read";
+            /** Modify the tags assigned to your space stations */
+            readonly TAGS_WRITE: "personal_inv_stations_tags_write";
+            /** Access and change anything in your space station inventory */
+            readonly ALL: "personal_inv_stations_all";
+        };
         /** Personal city scopes */
-        readonly CITIES: Record<string, string>;
+        readonly CITIES: {
+            /** Read basic information about your cities */
+            readonly READ: "personal_inv_cities_read";
+            /** Rename your cities */
+            readonly RENAME: "personal_inv_cities_rename";
+            /** Assign your cities */
+            readonly ASSIGN: "personal_inv_cities_assign";
+            /** Make over your cities */
+            readonly MAKEOVER: "personal_inv_cities_makeover";
+            /** Read the tags assigned to your cities */
+            readonly TAGS_READ: "personal_inv_cities_tags_read";
+            /** Modify the tags assigned to your cities */
+            readonly TAGS_WRITE: "personal_inv_cities_tags_write";
+            /** Access and change anything in your city inventory */
+            readonly ALL: "personal_inv_cities_all";
+        };
         /** Personal facility scopes */
-        readonly FACILITIES: Record<string, string>;
+        readonly FACILITIES: {
+            /** Read basic information about your facilities */
+            readonly READ: "personal_inv_facilities_read";
+            /** Rename your facilities */
+            readonly RENAME: "personal_inv_facilities_rename";
+            /** Assign your facilities */
+            readonly ASSIGN: "personal_inv_facilities_assign";
+            /** Make over your facilities */
+            readonly MAKEOVER: "personal_inv_facilities_makeover";
+            /** Read the tags assigned to your facilities */
+            readonly TAGS_READ: "personal_inv_facilities_tags_read";
+            /** Modify the tags assigned to your facilities */
+            readonly TAGS_WRITE: "personal_inv_facilities_tags_write";
+            /** Access and change anything in your facility inventory */
+            readonly ALL: "personal_inv_facilities_all";
+        };
         /** Personal planet scopes (no RENAME/MAKEOVER) */
-        readonly PLANETS: Record<string, string>;
+        readonly PLANETS: {
+            /** Read basic information about your planets */
+            readonly READ: "personal_inv_planets_read";
+            /** Assign your planets */
+            readonly ASSIGN: "personal_inv_planets_assign";
+            /** Read the tags assigned to your planets */
+            readonly TAGS_READ: "personal_inv_planets_tags_read";
+            /** Modify the tags assigned to your planets */
+            readonly TAGS_WRITE: "personal_inv_planets_tags_write";
+            /** Access and change anything in your planet inventory */
+            readonly ALL: "personal_inv_planets_all";
+        };
         /** Personal item scopes */
-        readonly ITEMS: Record<string, string>;
+        readonly ITEMS: {
+            /** Read basic information about your items */
+            readonly READ: "personal_inv_items_read";
+            /** Rename your items */
+            readonly RENAME: "personal_inv_items_rename";
+            /** Assign your items */
+            readonly ASSIGN: "personal_inv_items_assign";
+            /** Make over your items */
+            readonly MAKEOVER: "personal_inv_items_makeover";
+            /** Read the tags assigned to your items */
+            readonly TAGS_READ: "personal_inv_items_tags_read";
+            /** Modify the tags assigned to your items */
+            readonly TAGS_WRITE: "personal_inv_items_tags_write";
+            /** Access and change anything in your item inventory */
+            readonly ALL: "personal_inv_items_all";
+        };
         /** Personal NPC scopes (has MAKEOVER but no RENAME) */
         readonly NPCS: {
+            /** Read basic information about your NPCs */
             readonly READ: "personal_inv_npcs_read";
+            /** Assign your NPCs */
             readonly ASSIGN: "personal_inv_npcs_assign";
+            /** Make over your NPCs */
             readonly MAKEOVER: "personal_inv_npcs_makeover";
+            /** Read the tags assigned to your NPCs */
             readonly TAGS_READ: "personal_inv_npcs_tags_read";
+            /** Modify the tags assigned to your NPCs */
             readonly TAGS_WRITE: "personal_inv_npcs_tags_write";
+            /** Access and change anything in your NPC inventory */
             readonly ALL: "personal_inv_npcs_all";
         };
         /** Personal droid scopes */
-        readonly DROIDS: Record<string, string>;
+        readonly DROIDS: {
+            /** Read basic information about your droids */
+            readonly READ: "personal_inv_droids_read";
+            /** Rename your droids */
+            readonly RENAME: "personal_inv_droids_rename";
+            /** Assign your droids */
+            readonly ASSIGN: "personal_inv_droids_assign";
+            /** Make over your droids */
+            readonly MAKEOVER: "personal_inv_droids_makeover";
+            /** Read the tags assigned to your droids */
+            readonly TAGS_READ: "personal_inv_droids_tags_read";
+            /** Modify the tags assigned to your droids */
+            readonly TAGS_WRITE: "personal_inv_droids_tags_write";
+            /** Access and change anything in your droid inventory */
+            readonly ALL: "personal_inv_droids_all";
+        };
         /** Personal material scopes (no ASSIGN) */
         readonly MATERIALS: {
+            /** Read basic information about your materials */
             readonly READ: "personal_inv_materials_read";
+            /** Rename your materials */
             readonly RENAME: "personal_inv_materials_rename";
+            /** Make over your materials */
             readonly MAKEOVER: "personal_inv_materials_makeover";
+            /** Read the tags assigned to your materials */
             readonly TAGS_READ: "personal_inv_materials_tags_read";
+            /** Modify the tags assigned to your materials */
             readonly TAGS_WRITE: "personal_inv_materials_tags_write";
+            /** Access and change anything in your material inventory */
             readonly ALL: "personal_inv_materials_all";
         };
         /** Personal creature scopes */
-        readonly CREATURES: Record<string, string>;
+        readonly CREATURES: {
+            /** Read basic information about your creatures */
+            readonly READ: "personal_inv_creatures_read";
+            /** Rename your creatures */
+            readonly RENAME: "personal_inv_creatures_rename";
+            /** Assign your creatures */
+            readonly ASSIGN: "personal_inv_creatures_assign";
+            /** Make over your creatures */
+            readonly MAKEOVER: "personal_inv_creatures_makeover";
+            /** Read the tags assigned to your creatures */
+            readonly TAGS_READ: "personal_inv_creatures_tags_read";
+            /** Modify the tags assigned to your creatures */
+            readonly TAGS_WRITE: "personal_inv_creatures_tags_write";
+            /** Access and change anything in your creature inventory */
+            readonly ALL: "personal_inv_creatures_all";
+        };
     };
     readonly Faction: {
-        /** Read faction information */
+        /** Read basic information about your faction */
         readonly READ: "faction_read";
-        /** Read faction members */
+        /** See your faction's members list */
         readonly MEMBERS: "faction_members";
-        /** Read faction stocks */
+        /** See the stocks your faction owns */
         readonly STOCKS: "faction_stocks";
-        /** Read faction credits */
+        /** See how many credits your faction owns */
         readonly CREDITS_READ: "faction_credits_read";
-        /** Write/transfer faction credits */
+        /** Transfer credits on behalf of your faction */
         readonly CREDITS_WRITE: "faction_credits_write";
-        /** Read faction budgets */
+        /** See your faction's budgets */
         readonly BUDGETS_READ: "faction_budgets_read";
-        /** Write faction budgets */
+        /** Change your faction's budgets */
         readonly BUDGETS_WRITE: "faction_budgets_write";
-        /** Read faction datacards */
+        /** See your faction's datacard assignments */
         readonly DATACARDS_READ: "faction_datacards_read";
-        /** Write faction datacards */
+        /** Assign or revoke your faction's datacard assignments */
         readonly DATACARDS_WRITE: "faction_datacards_write";
-        /** All faction permissions */
+        /** Access and change anything in your faction */
         readonly ALL: "faction_all";
     };
     readonly FactionInventory: {
-        /** Overview of faction inventory */
+        /** Read basic information about your faction's inventories */
         readonly OVERVIEW: "faction_inv_overview";
         /** Faction ship scopes */
-        readonly SHIPS: Record<string, string>;
+        readonly SHIPS: {
+            /** Read basic information about your faction's ships */
+            readonly READ: "faction_inv_ships_read";
+            /** Rename your faction's ships */
+            readonly RENAME: "faction_inv_ships_rename";
+            /** Assign your faction's ships */
+            readonly ASSIGN: "faction_inv_ships_assign";
+            /** Make over your faction's ships */
+            readonly MAKEOVER: "faction_inv_ships_makeover";
+            /** Read the tags assigned to your faction's ships */
+            readonly TAGS_READ: "faction_inv_ships_tags_read";
+            /** Modify the tags assigned to your faction's ships */
+            readonly TAGS_WRITE: "faction_inv_ships_tags_write";
+            /** Access and change anything in your faction's ship inventory */
+            readonly ALL: "faction_inv_ships_all";
+        };
         /** Faction vehicle scopes */
-        readonly VEHICLES: Record<string, string>;
+        readonly VEHICLES: {
+            /** Read basic information about your faction's vehicles */
+            readonly READ: "faction_inv_vehicles_read";
+            /** Rename your faction's vehicles */
+            readonly RENAME: "faction_inv_vehicles_rename";
+            /** Assign your faction's vehicles */
+            readonly ASSIGN: "faction_inv_vehicles_assign";
+            /** Make over your faction's vehicles */
+            readonly MAKEOVER: "faction_inv_vehicles_makeover";
+            /** Read the tags assigned to your faction's vehicles */
+            readonly TAGS_READ: "faction_inv_vehicles_tags_read";
+            /** Modify the tags assigned to your faction's vehicles */
+            readonly TAGS_WRITE: "faction_inv_vehicles_tags_write";
+            /** Access and change anything in your faction's vehicle inventory */
+            readonly ALL: "faction_inv_vehicles_all";
+        };
         /** Faction station scopes */
-        readonly STATIONS: Record<string, string>;
+        readonly STATIONS: {
+            /** Read basic information about your faction's space stations */
+            readonly READ: "faction_inv_stations_read";
+            /** Rename your faction's space stations */
+            readonly RENAME: "faction_inv_stations_rename";
+            /** Assign your faction's space stations */
+            readonly ASSIGN: "faction_inv_stations_assign";
+            /** Make over your faction's space stations */
+            readonly MAKEOVER: "faction_inv_stations_makeover";
+            /** Read the tags assigned to your faction's space stations */
+            readonly TAGS_READ: "faction_inv_stations_tags_read";
+            /** Modify the tags assigned to your faction's space stations */
+            readonly TAGS_WRITE: "faction_inv_stations_tags_write";
+            /** Access and change anything in your faction's space station inventory */
+            readonly ALL: "faction_inv_stations_all";
+        };
         /** Faction city scopes */
-        readonly CITIES: Record<string, string>;
+        readonly CITIES: {
+            /** Read basic information about your faction's cities */
+            readonly READ: "faction_inv_cities_read";
+            /** Rename your faction's cities */
+            readonly RENAME: "faction_inv_cities_rename";
+            /** Assign your faction's cities */
+            readonly ASSIGN: "faction_inv_cities_assign";
+            /** Make over your faction's cities */
+            readonly MAKEOVER: "faction_inv_cities_makeover";
+            /** Read the tags assigned to your faction's cities */
+            readonly TAGS_READ: "faction_inv_cities_tags_read";
+            /** Modify the tags assigned to your faction's cities */
+            readonly TAGS_WRITE: "faction_inv_cities_tags_write";
+            /** Access and change anything in your faction's city inventory */
+            readonly ALL: "faction_inv_cities_all";
+        };
         /** Faction facility scopes */
-        readonly FACILITIES: Record<string, string>;
+        readonly FACILITIES: {
+            /** Read basic information about your faction's facilities */
+            readonly READ: "faction_inv_facilities_read";
+            /** Rename your faction's facilities */
+            readonly RENAME: "faction_inv_facilities_rename";
+            /** Assign your faction's facilities */
+            readonly ASSIGN: "faction_inv_facilities_assign";
+            /** Make over your faction's facilities */
+            readonly MAKEOVER: "faction_inv_facilities_makeover";
+            /** Read the tags assigned to your faction's facilities */
+            readonly TAGS_READ: "faction_inv_facilities_tags_read";
+            /** Modify the tags assigned to your faction's facilities */
+            readonly TAGS_WRITE: "faction_inv_facilities_tags_write";
+            /** Access and change anything in your faction's facility inventory */
+            readonly ALL: "faction_inv_facilities_all";
+        };
         /** Faction planet scopes (no RENAME/MAKEOVER) */
-        readonly PLANETS: Record<string, string>;
+        readonly PLANETS: {
+            /** Read basic information about your faction's planets */
+            readonly READ: "faction_inv_planets_read";
+            /** Assign your faction's planets */
+            readonly ASSIGN: "faction_inv_planets_assign";
+            /** Read the tags assigned to your faction's planets */
+            readonly TAGS_READ: "faction_inv_planets_tags_read";
+            /** Modify the tags assigned to your faction's planets */
+            readonly TAGS_WRITE: "faction_inv_planets_tags_write";
+            /** Access and change anything in your faction's planet inventory */
+            readonly ALL: "faction_inv_planets_all";
+        };
         /** Faction item scopes */
-        readonly ITEMS: Record<string, string>;
+        readonly ITEMS: {
+            /** Read basic information about your faction's items */
+            readonly READ: "faction_inv_items_read";
+            /** Rename your faction's items */
+            readonly RENAME: "faction_inv_items_rename";
+            /** Assign your faction's items */
+            readonly ASSIGN: "faction_inv_items_assign";
+            /** Make over your faction's items */
+            readonly MAKEOVER: "faction_inv_items_makeover";
+            /** Read the tags assigned to your faction's items */
+            readonly TAGS_READ: "faction_inv_items_tags_read";
+            /** Modify the tags assigned to your faction's items */
+            readonly TAGS_WRITE: "faction_inv_items_tags_write";
+            /** Access and change anything in your faction's item inventory */
+            readonly ALL: "faction_inv_items_all";
+        };
         /** Faction NPC scopes (has MAKEOVER but no RENAME) */
         readonly NPCS: {
+            /** Read basic information about your faction's NPCs */
             readonly READ: "faction_inv_npcs_read";
+            /** Assign your faction's NPCs */
             readonly ASSIGN: "faction_inv_npcs_assign";
+            /** Make over your faction's NPCs */
             readonly MAKEOVER: "faction_inv_npcs_makeover";
+            /** Read the tags assigned to your faction's NPCs */
             readonly TAGS_READ: "faction_inv_npcs_tags_read";
+            /** Modify the tags assigned to your faction's NPCs */
             readonly TAGS_WRITE: "faction_inv_npcs_tags_write";
+            /** Access and change anything in your faction's NPC inventory */
             readonly ALL: "faction_inv_npcs_all";
         };
         /** Faction droid scopes */
-        readonly DROIDS: Record<string, string>;
+        readonly DROIDS: {
+            /** Read basic information about your faction's droids */
+            readonly READ: "faction_inv_droids_read";
+            /** Rename your faction's droids */
+            readonly RENAME: "faction_inv_droids_rename";
+            /** Assign your faction's droids */
+            readonly ASSIGN: "faction_inv_droids_assign";
+            /** Make over your faction's droids */
+            readonly MAKEOVER: "faction_inv_droids_makeover";
+            /** Read the tags assigned to your faction's droids */
+            readonly TAGS_READ: "faction_inv_droids_tags_read";
+            /** Modify the tags assigned to your faction's droids */
+            readonly TAGS_WRITE: "faction_inv_droids_tags_write";
+            /** Access and change anything in your faction's droid inventory */
+            readonly ALL: "faction_inv_droids_all";
+        };
         /** Faction material scopes (no ASSIGN) */
         readonly MATERIALS: {
+            /** Read basic information about your faction's materials */
             readonly READ: "faction_inv_materials_read";
+            /** Rename your faction's materials */
             readonly RENAME: "faction_inv_materials_rename";
+            /** Make over your faction's materials */
             readonly MAKEOVER: "faction_inv_materials_makeover";
+            /** Read the tags assigned to your faction's materials */
             readonly TAGS_READ: "faction_inv_materials_tags_read";
+            /** Modify the tags assigned to your faction's materials */
             readonly TAGS_WRITE: "faction_inv_materials_tags_write";
+            /** Access and change anything in your faction's material inventory */
             readonly ALL: "faction_inv_materials_all";
         };
         /** Faction creature scopes */
-        readonly CREATURES: Record<string, string>;
+        readonly CREATURES: {
+            /** Read basic information about your faction's creatures */
+            readonly READ: "faction_inv_creatures_read";
+            /** Rename your faction's creatures */
+            readonly RENAME: "faction_inv_creatures_rename";
+            /** Assign your faction's creatures */
+            readonly ASSIGN: "faction_inv_creatures_assign";
+            /** Make over your faction's creatures */
+            readonly MAKEOVER: "faction_inv_creatures_makeover";
+            /** Read the tags assigned to your faction's creatures */
+            readonly TAGS_READ: "faction_inv_creatures_tags_read";
+            /** Modify the tags assigned to your faction's creatures */
+            readonly TAGS_WRITE: "faction_inv_creatures_tags_write";
+            /** Access and change anything in your faction's creature inventory */
+            readonly ALL: "faction_inv_creatures_all";
+        };
     };
 };
 /**