@oasisomniverse/web5-api 1.0.0

package/index.d.ts

@@ -0,0 +1,97 @@
+// AUTO-GENERATED by scripts/generate-types.js - do not hand-edit.
+import type { OASISResponse, OASISSession } from './src/core/types';
+import type { AuthModule } from './src/modules/Auth';
+import type { AvatarModule } from './src/modules/Avatar';
+import type { CelestialBodiesModule } from './src/modules/CelestialBodies';
+import type { CelestialBodiesMetaDataModule } from './src/modules/CelestialBodiesMetaData';
+import type { CelestialSpacesModule } from './src/modules/CelestialSpaces';
+import type { ChaptersModule } from './src/modules/Chapters';
+import type { CompetitionModule } from './src/modules/Competition';
+import type { CosmicModule } from './src/modules/Cosmic';
+import type { GamesModule } from './src/modules/Games';
+import type { GeoHotSpotsModule } from './src/modules/GeoHotSpots';
+import type { GeoNFTsModule } from './src/modules/GeoNFTs';
+import type { HealthModule } from './src/modules/Health';
+import type { HolonsModule } from './src/modules/Holons';
+import type { HolonsMetaDataModule } from './src/modules/HolonsMetaData';
+import type { InventoryItemsModule } from './src/modules/InventoryItems';
+import type { LibrariesModule } from './src/modules/Libraries';
+import type { MissionsModule } from './src/modules/Missions';
+import type { NFTsModule } from './src/modules/NFTs';
+import type { OAPPsModule } from './src/modules/OAPPs';
+import type { ParksModule } from './src/modules/Parks';
+import type { PluginsModule } from './src/modules/Plugins';
+import type { QuestsModule } from './src/modules/Quests';
+import type { RuntimesModule } from './src/modules/Runtimes';
+import type { STARModule } from './src/modules/STAR';
+import type { TemplatesModule } from './src/modules/Templates';
+import type { ZomesModule } from './src/modules/Zomes';
+import type { ZomesMetaDataModule } from './src/modules/ZomesMetaData';
+
+export type { OASISResponse, OASISSession };
+
+export interface STARClientOptions {
+  baseUrl?: string;
+  persistSession?: boolean;
+  fetchImpl?: typeof fetch;
+}
+
+export declare class HttpClient {
+  constructor(options?: { baseUrl?: string; tokenStore?: unknown; fetchImpl?: typeof fetch });
+  setBaseUrl(baseUrl: string): void;
+  request(verb: 'GET' | 'POST' | 'PUT' | 'DELETE', path: string, options?: Record<string, any>): Promise<OASISResponse>;
+  get(path: string, options?: Record<string, any>): Promise<OASISResponse>;
+  post(path: string, options?: Record<string, any>): Promise<OASISResponse>;
+  put(path: string, options?: Record<string, any>): Promise<OASISResponse>;
+  delete(path: string, options?: Record<string, any>): Promise<OASISResponse>;
+}
+
+export declare class TokenStore {
+  constructor(options?: { persist?: boolean });
+  getSession(): OASISSession | null;
+  getToken(): string | null;
+  setSession(session: OASISSession | null): void;
+  clear(): void;
+}
+
+export declare const DEFAULT_BASE_URL: string;
+
+export declare class STARClient {
+  constructor(options?: STARClientOptions);
+  readonly http: HttpClient;
+  readonly tokenStore: TokenStore;
+  readonly auth: AuthModule;
+  readonly avatar: AvatarModule;
+  readonly celestialBodies: CelestialBodiesModule;
+  readonly celestialBodiesMetaData: CelestialBodiesMetaDataModule;
+  readonly celestialSpaces: CelestialSpacesModule;
+  readonly chapters: ChaptersModule;
+  readonly competition: CompetitionModule;
+  readonly cosmic: CosmicModule;
+  readonly games: GamesModule;
+  readonly geoHotSpots: GeoHotSpotsModule;
+  readonly geoNFTs: GeoNFTsModule;
+  readonly health: HealthModule;
+  readonly holons: HolonsModule;
+  readonly holonsMetaData: HolonsMetaDataModule;
+  readonly inventoryItems: InventoryItemsModule;
+  readonly libraries: LibrariesModule;
+  readonly missions: MissionsModule;
+  readonly nFTs: NFTsModule;
+  readonly oAPPs: OAPPsModule;
+  readonly parks: ParksModule;
+  readonly plugins: PluginsModule;
+  readonly quests: QuestsModule;
+  readonly runtimes: RuntimesModule;
+  readonly sTAR: STARModule;
+  readonly templates: TemplatesModule;
+  readonly zomes: ZomesModule;
+  readonly zomesMetaData: ZomesMetaDataModule;
+  setBaseUrl(baseUrl: string): void;
+  setToken(jwtToken: string, sessionExtras?: Partial<OASISSession>): void;
+  starIgnite(args?: Record<string, any>): Promise<OASISResponse>;
+  starExtinguish(args?: Record<string, any>): Promise<OASISResponse>;
+  starStatus(args?: Record<string, any>): Promise<OASISResponse>;
+}
+
+export default STARClient;

package/index.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('./src/index');

package/index.mjs

@@ -0,0 +1,4 @@
+import cjs from './index.js';
+
+export const { STARClient, HttpClient, TokenStore, DEFAULT_BASE_URL } = cjs;
+export default STARClient;

package/package.json

@@ -0,0 +1,117 @@
+{
+  "name": "@oasisomniverse/web5-api",
+  "version": "1.0.0",
+  "publishConfig": { "access": "public" },
+  "description": "Isomorphic (Node + browser) JavaScript/TypeScript-friendly client for the WEB5 STAR API - full coverage of the OASIS2 STAR WebAPI (OAPPs, Quests, Missions, Games, Celestial Bodies/Spaces, Cosmic hierarchy, NFTs, GeoNFTs, Plugins, Templates, Libraries, Runtimes, Competition/Leaderboards, and more).",
+  "main": "index.js",
+  "module": "index.mjs",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.mjs",
+      "require": "./index.js"
+    }
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "index.js",
+    "index.mjs",
+    "index.d.ts",
+    "src",
+    "docs"
+  ],
+  "scripts": {
+    "generate": "node scripts/generate-modules.js",
+    "docs": "node scripts/generate-docs.js",
+    "types": "node scripts/generate-types.js",
+    "test": "node --test test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/NextGenSoftwareUK/OASIS-API-Javascript-Package-WEB5.git"
+  },
+  "author": "NextGen Software Ltd",
+  "license": "MIT",
+  "keywords": [
+    "WEB5 STAR API",
+    "STAR ODK",
+    "STAR WebAPI",
+    "OAPPs",
+    "Quests",
+    "Missions",
+    "Games",
+    "Celestial Bodies",
+    "Celestial Spaces",
+    "Cosmic",
+    "Omniverse",
+    "Multiverse",
+    "Universe",
+    "Galaxy",
+    "GeoNFTs",
+    "GeoHotSpots",
+    "Plugins",
+    "Templates",
+    "Libraries",
+    "Runtimes",
+    "Competition",
+    "Leaderboards",
+    "Tournaments",
+    "Holons",
+    "Zomes",
+    "Parks",
+    "Chapters",
+    "Inventory Items",
+    "OASIS API",
+    "Avatar API",
+    "WEB 3",
+    "WEB 4",
+    "WEB 5",
+    "Blockchain",
+    "NFT",
+    "Tokens",
+    "Crypto",
+    "Interoperable",
+    "Future-Prove",
+    "Metaverse",
+    "Aggregation",
+    "HOT-Swappable-Architecture",
+    "P2P",
+    "Decentralised",
+    "Distributed",
+    "Interoprability",
+    "Abstraction-Layer",
+    "Multi-Network",
+    "Multi-Chain",
+    "Bridging",
+    "Network-Of-Networks",
+    "SSO",
+    "Auto-FailOver",
+    "Auto-LoadBalancing",
+    "Auto-Replication",
+    "Auto-Sync",
+    "Offline-Support",
+    "Write-Once-Deploy-Everywhere",
+    "Triple-Level-Quantum-Resistant-Encryption",
+    "Quantum",
+    "Encryption",
+    "Smart-Contracts",
+    "Intelligent-Key-Management",
+    "Zero-Lag",
+    "Zero-Downtime",
+    "Agent-Centric",
+    "Smart-City-Ready",
+    "WEB/2D/3D/AR/VR/IR/Map/Meta-Visusalization",
+    "IR-(Infinite-Reality)-Ready",
+    "Infinite-Players-Online-At-Same-Time",
+    "AI/Machine-Learning-Over-All-Of-World's-Aggregated-Data",
+    "HTTP-REST/gRPC/GraphQL/CLI/Native-Endpoints",
+    "Best-Of-All-Worlds",
+    "GOD-Protocol/API",
+    "Our-World-Geo-Location/AR/IR/Map-UI-(Game-of-Games-Engine)",
+    "One-World-Open-World-MMO-(VR)-UI-(Game-of-Games-Engine)",
+    "More Coming..."
+  ]
+}

package/src/core/httpClient.js

@@ -0,0 +1,110 @@
+'use strict';
+
+const DEFAULT_BASE_URL = 'https://api.star.oasisweb5.one';
+
+function buildQueryString(query) {
+  const entries = Object.entries(query || {}).filter(([, v]) => v !== undefined && v !== null);
+  if (!entries.length) return '';
+  const params = new URLSearchParams();
+  for (const [key, value] of entries) {
+    params.set(key, typeof value === 'object' ? JSON.stringify(value) : String(value));
+  }
+  return `?${params.toString()}`;
+}
+
+/**
+ * Thin isomorphic HTTP client around the global fetch API (Node 18+, all modern browsers).
+ * Every WEB5 STAR API call ultimately goes through `request()` below - there are no mocked
+ * or stubbed responses anywhere in this SDK.
+ */
+class HttpClient {
+  constructor({ baseUrl = DEFAULT_BASE_URL, tokenStore, fetchImpl = globalThis.fetch } = {}) {
+    if (!fetchImpl) {
+      throw new Error(
+        'No global fetch implementation found. Use Node 18+, a modern browser, or pass { fetchImpl } explicitly.'
+      );
+    }
+    this.baseUrl = baseUrl.replace(/\/+$/, '');
+    this.tokenStore = tokenStore;
+    this.fetchImpl = fetchImpl;
+  }
+
+  setBaseUrl(baseUrl) {
+    this.baseUrl = baseUrl.replace(/\/+$/, '');
+  }
+
+  /**
+   * @param {string} verb GET | POST | PUT | DELETE
+   * @param {string} path e.g. "api/avatar/authenticate"
+   * @param {object} [options]
+   * @param {object} [options.query] query string params (GET/DELETE)
+   * @param {object} [options.body] JSON body (POST/PUT/DELETE)
+   * @param {boolean} [options.auth] attach Authorization: Bearer <token> (default true)
+   * @param {string} [options.token] override token for this single request
+   */
+  async request(verb, path, { query, body, auth = true, token } = {}) {
+    const url = `${this.baseUrl}/${path.replace(/^\/+/, '')}${buildQueryString(query)}`;
+    const headers = {
+      'Content-Type': 'application/json',
+      Accept: 'application/json'
+    };
+
+    const bearer = token || (auth ? this.tokenStore?.getToken() : null);
+    if (bearer) headers.Authorization = `Bearer ${bearer}`;
+
+    const init = { method: verb, headers };
+    if (body !== undefined && verb !== 'GET') init.body = JSON.stringify(body);
+
+    let res;
+    try {
+      res = await this.fetchImpl(url, init);
+    } catch (err) {
+      return { isError: true, message: `Network error calling ${url}: ${err.message}`, exception: err };
+    }
+
+    const text = await res.text();
+    let json;
+    try {
+      json = text ? JSON.parse(text) : null;
+    } catch {
+      json = null;
+    }
+
+    if (!res.ok) {
+      const message =
+        json?.result?.message || json?.message || json?.title || `Request failed with status ${res.status}`;
+      return { isError: true, message, statusCode: res.status, raw: json };
+    }
+
+    // OASIS responses are typically { isError, message, result: { isError, message, result: <payload> } }.
+    // We surface the innermost payload as `.result` while keeping the full envelope available as `.raw`.
+    const inner = json?.result !== undefined ? json.result : json;
+    const payload = inner?.result !== undefined ? inner.result : inner;
+
+    return {
+      isError: Boolean(inner?.isError || json?.isError),
+      message: inner?.message || json?.message || null,
+      result: payload,
+      raw: json,
+      statusCode: res.status
+    };
+  }
+
+  get(path, options) {
+    return this.request('GET', path, options);
+  }
+
+  post(path, options) {
+    return this.request('POST', path, options);
+  }
+
+  put(path, options) {
+    return this.request('PUT', path, options);
+  }
+
+  delete(path, options) {
+    return this.request('DELETE', path, options);
+  }
+}
+
+module.exports = { HttpClient, DEFAULT_BASE_URL };

package/src/core/routeHelper.js

@@ -0,0 +1,85 @@
+'use strict';
+
+const TOKEN_PATTERN = /\{(\w+)(?::\w+)?\}/g;
+
+/**
+ * Resolves a route template like "get-by-id/{id}" against an args object,
+ * substituting path tokens and returning the resolved path plus whatever
+ * args were *not* consumed as path tokens (these become the query/body).
+ */
+function resolveRoute(routeTemplate, args = {}) {
+  const consumed = new Set();
+  const path = routeTemplate.replace(TOKEN_PATTERN, (match, name) => {
+    const key = Object.keys(args).find((k) => k.toLowerCase() === name.toLowerCase());
+    consumed.add(key);
+    const value = key !== undefined ? args[key] : undefined;
+    if (value === undefined) {
+      throw new Error(`Missing required route parameter "${name}" for route "${routeTemplate}"`);
+    }
+    return encodeURIComponent(value);
+  });
+
+  const rest = {};
+  for (const [key, value] of Object.entries(args)) {
+    if (!consumed.has(key)) rest[key] = value;
+  }
+
+  return { path, rest };
+}
+
+function takeKey(obj, name) {
+  const matchKey = Object.keys(obj).find((k) => k.toLowerCase() === name.toLowerCase());
+  if (matchKey === undefined) return { found: false, value: undefined };
+  const value = obj[matchKey];
+  delete obj[matchKey];
+  return { found: true, value };
+}
+
+/**
+ * Builds a bound method for a single WEB5 STAR API endpoint operation.
+ * @param {import('./httpClient').HttpClient} http
+ * @param {string} routePrefix e.g. "api/avatar"
+ * @param {string} verb GET | POST | PUT | DELETE
+ * @param {string} route route template relative to routePrefix, e.g. "get-by-id/{id}"
+ * @param {object} [opts]
+ * @param {string[]} [opts.query] arg names that ASP.NET binds from the query
+ *   string on this action regardless of HTTP verb (e.g. `[FromQuery]` flags
+ *   mixed into an otherwise-body-bound POST/PUT action). Always sent as query.
+ * @param {string} [opts.bodyParam] when the action's entire request body is a
+ *   single `[FromBody]` parameter (primitive or object), the JSON body is
+ *   that arg's value directly rather than the leftover-args object wrapped
+ *   around it.
+ */
+function makeOperation(http, routePrefix, verb, route, opts = {}) {
+  const declaredQueryKeys = opts.query || [];
+  const bodyParam = opts.bodyParam;
+
+  return async function operation(args = {}) {
+    const { path, rest } = resolveRoute(route, args);
+    const fullPath = path ? `${routePrefix}/${path}` : routePrefix;
+
+    const query = {};
+    for (const key of declaredQueryKeys) {
+      const { found, value } = takeKey(rest, key);
+      if (found) query[key] = value;
+    }
+
+    let body;
+    if (bodyParam) {
+      const { found, value } = takeKey(rest, bodyParam);
+      if (found) body = value;
+      // Any args left over that we don't recognize still get sent (as query)
+      // rather than silently dropped.
+      Object.assign(query, rest);
+    } else if (verb === 'GET' || verb === 'DELETE') {
+      Object.assign(query, rest);
+    } else {
+      body = Object.keys(rest).length ? rest : undefined;
+    }
+
+    const hasQuery = Object.keys(query).length > 0;
+    return http.request(verb, fullPath, { query: hasQuery ? query : undefined, body });
+  };
+}
+
+module.exports = { resolveRoute, makeOperation };

package/src/core/tokenStore.js

@@ -0,0 +1,52 @@
+'use strict';
+
+const hasLocalStorage = typeof globalThis.localStorage !== 'undefined';
+const STORAGE_KEY = 'oasis_session';
+
+/**
+ * Holds the current JWT/avatar session for the SDK.
+ * In the browser it persists to localStorage by default; in Node (or when
+ * persistence is disabled) it simply lives in memory for the lifetime of
+ * the client instance. Callers can always set/get/clear explicitly.
+ */
+class TokenStore {
+  constructor({ persist = hasLocalStorage } = {}) {
+    this.persist = persist;
+    this._session = null;
+
+    if (this.persist) {
+      try {
+        const raw = globalThis.localStorage.getItem(STORAGE_KEY);
+        if (raw) this._session = JSON.parse(raw);
+      } catch {
+        this._session = null;
+      }
+    }
+  }
+
+  getSession() {
+    return this._session;
+  }
+
+  getToken() {
+    return this._session?.jwtToken || this._session?.token || null;
+  }
+
+  setSession(session) {
+    this._session = session || null;
+    if (this.persist) {
+      try {
+        if (session) globalThis.localStorage.setItem(STORAGE_KEY, JSON.stringify(session));
+        else globalThis.localStorage.removeItem(STORAGE_KEY);
+      } catch {
+        // Storage unavailable (e.g. private browsing) - in-memory session still works.
+      }
+    }
+  }
+
+  clear() {
+    this.setSession(null);
+  }
+}
+
+module.exports = { TokenStore };

package/src/core/types.d.ts

@@ -0,0 +1,18 @@
+// AUTO-GENERATED by scripts/generate-types.js - do not hand-edit.
+export interface OASISResponse<T = any> {
+  isError: boolean;
+  message: string | null;
+  result: T;
+  raw: any;
+  statusCode: number;
+}
+
+export interface OASISSession {
+  avatarId: string;
+  username: string;
+  email: string;
+  firstName?: string;
+  lastName?: string;
+  jwtToken: string;
+  refreshToken?: string;
+}

package/src/index.js

@@ -0,0 +1,60 @@
+'use strict';
+
+const { HttpClient, DEFAULT_BASE_URL } = require('./core/httpClient');
+const { TokenStore } = require('./core/tokenStore');
+const { attachGeneratedModules } = require('./modules/index');
+const { AuthModule } = require('./modules/Auth');
+
+/**
+ * Main SDK entry point. Works in Node 18+ and any modern browser.
+ *
+ *   const { STARClient } = require('@oasisomniverse/web5-api');
+ *   const star = new STARClient({ baseUrl: 'https://api.star.oasisweb5.one' });
+ *   await star.auth.login({ username: 'me@example.com', password: '...' });
+ *   const quests = await star.quests.getAllQuestsForAvatar();
+ *
+ * Every controller on the OASIS2 STAR WebAPI is reachable as a lowerCamel
+ * property (star.avatar, star.quests, star.missions, star.games, star.cosmic,
+ * star.holons, star.nFTs, star.geoNFTs, star.plugins, star.templates,
+ * star.libraries, star.runtimes, star.competition, ...). Generated methods
+ * take a single args object; route template tokens (e.g. {id}) are consumed
+ * from it automatically, remaining keys become the query string (GET/DELETE)
+ * or JSON body (POST/PUT). star.auth is a hand-written convenience wrapper
+ * that also manages the session/token for you.
+ */
+class STARClient {
+  constructor({ baseUrl = DEFAULT_BASE_URL, persistSession, fetchImpl } = {}) {
+    this.tokenStore = new TokenStore({ persist: persistSession });
+    this.http = new HttpClient({ baseUrl, tokenStore: this.tokenStore, fetchImpl });
+
+    attachGeneratedModules(this, this.http);
+
+    // Hand-written ergonomic wrapper, built on top of the generated avatar module.
+    this.auth = new AuthModule(this.http, this.tokenStore, this.avatar);
+  }
+
+  setBaseUrl(baseUrl) {
+    this.http.setBaseUrl(baseUrl);
+  }
+
+  /** Use an externally-issued JWT (e.g. one your server already obtained) for subsequent calls. */
+  setToken(jwtToken, sessionExtras = {}) {
+    this.tokenStore.setSession({ ...sessionExtras, jwtToken });
+  }
+
+  /** Convenience pass-throughs to the generated STAR module (star.sTAR). */
+  starIgnite(args) {
+    return this.sTAR.igniteSTAR(args);
+  }
+
+  starExtinguish(args) {
+    return this.sTAR.extinguishSTAR(args);
+  }
+
+  starStatus(args) {
+    return this.sTAR.getStatus(args);
+  }
+}
+
+module.exports = { STARClient, HttpClient, TokenStore, DEFAULT_BASE_URL };
+module.exports.default = STARClient;

package/src/modules/Auth.d.ts

@@ -0,0 +1,15 @@
+// Hand-written type declaration for src/modules/Auth.js
+import type { OASISResponse, OASISSession } from '../core/types';
+
+export interface LoginCredentials {
+  username: string;
+  password: string;
+}
+
+export declare class AuthModule {
+  constructor(http: unknown, tokenStore: unknown, avatarModule: unknown);
+  getSession(): OASISSession | null;
+  isAuthenticated(): boolean;
+  login(credentials: LoginCredentials): Promise<OASISResponse & { session?: OASISSession }>;
+  logout(): Promise<void>;
+}

package/src/modules/Auth.js

@@ -0,0 +1,62 @@
+'use strict';
+
+/**
+ * Hand-written ergonomic auth wrapper. Built on top of the generated
+ * AvatarModule (api/avatar/authenticate) and manages the SDK's TokenStore
+ * automatically on login/logout - this is the one place callers don't have
+ * to think about JWTs themselves.
+ *
+ * STAR's AvatarController has no logout/revoke-token endpoint of its own (it
+ * only forwards a subset of WEB4 avatar operations), so logout() just clears
+ * the local session client-side.
+ */
+class AuthModule {
+  constructor(http, tokenStore, avatarModule) {
+    this._http = http;
+    this._tokenStore = tokenStore;
+    this._avatar = avatarModule;
+  }
+
+  /** Returns the currently stored session ({ avatarId, username, email, jwtToken, ... }) or null. */
+  getSession() {
+    return this._tokenStore.getSession();
+  }
+
+  isAuthenticated() {
+    return Boolean(this._tokenStore.getToken());
+  }
+
+  /**
+   * @param {{username: string, password: string}} credentials `username` may also be an email,
+   *   OASIS' authenticate endpoint accepts either.
+   */
+  async login({ username, password }) {
+    const res = await this._avatar.authenticate({ Username: username, Password: password });
+    if (res.isError || !res.result) return res;
+
+    const avatar = res.result;
+    const session = {
+      avatarId: avatar.id || avatar.Id,
+      username: avatar.username || avatar.Username || username,
+      email: avatar.email || avatar.Email,
+      firstName: avatar.firstName || avatar.FirstName,
+      lastName: avatar.lastName || avatar.LastName,
+      jwtToken: avatar.jwtToken || avatar.JwtToken,
+      refreshToken: avatar.refreshToken || avatar.RefreshToken
+    };
+
+    if (!session.jwtToken) {
+      return { isError: true, message: 'Authentication succeeded but no JWT token was returned.', raw: res.raw };
+    }
+
+    this._tokenStore.setSession(session);
+    return { ...res, session };
+  }
+
+  /** Clears the local session. STAR's AvatarController has no server-side revoke endpoint to call. */
+  async logout() {
+    this._tokenStore.clear();
+  }
+}
+
+module.exports = { AuthModule };

package/src/modules/Avatar.d.ts

@@ -0,0 +1,45 @@
+// AUTO-GENERATED by scripts/generate-types.js - do not hand-edit.
+import type { OASISResponse } from '../core/types';
+
+export declare class AvatarModule {
+  constructor(http: unknown);
+
+  /** POST api/avatar/inventory */
+  addItemToInventory(args?: Record<string, any>): Promise<OASISResponse>;
+
+  /** POST api/avatar/add-xp */
+  addXp(args?: Record<string, any>): Promise<OASISResponse>;
+
+  /** POST api/avatar/authenticate */
+  authenticate(args?: Record<string, any>): Promise<OASISResponse>;
+
+  /** GET api/avatar/current */
+  getCurrentAvatar(args?: Record<string, any>): Promise<OASISResponse>;
+
+  /** GET api/avatar/inventory */
+  getInventory(args?: Record<string, any>): Promise<OASISResponse>;
+
+  /** GET api/avatar/inventory/{itemId} */
+  getInventoryItem(args?: Record<string, any>): Promise<OASISResponse>;
+
+  /** GET api/avatar/inventory/{itemId}/has */
+  hasItem(args?: Record<string, any>): Promise<OASISResponse>;
+
+  /** GET api/avatar/inventory/has-by-name (query: itemName) */
+  hasItemByName(args?: Record<string, any>): Promise<OASISResponse>;
+
+  /** DELETE api/avatar/inventory/{itemId} */
+  removeItemFromInventory(args?: Record<string, any>): Promise<OASISResponse>;
+
+  /** GET api/avatar/inventory/search (query: searchTerm) */
+  searchInventory(args?: Record<string, any>): Promise<OASISResponse>;
+
+  /** POST api/avatar/inventory/send-to-avatar */
+  sendItemToAvatar(args?: Record<string, any>): Promise<OASISResponse>;
+
+  /** POST api/avatar/inventory/send-to-clan */
+  sendItemToClan(args?: Record<string, any>): Promise<OASISResponse>;
+
+  /** POST api/avatar/set-active-quest */
+  setActiveQuest(args?: Record<string, any>): Promise<OASISResponse>;
+}