bruce-models 3.2.0 → 3.2.1

package/dist/lib/util/url-utils.js

@@ -1,95 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UrlUtils = void 0;
-/**
- * Utility to help with url manipulation.
- */
 var UrlUtils;
 (function (UrlUtils) {
-    function GetQueryString(doc) {
-        const qs = {};
-        const p0 = doc.location.href.indexOf("?");
-        if (p0 >= 0) {
-            const str = doc.location.href.substring(p0 + 1);
-            const tokens = str.split("&");
-            tokens.forEach(token => {
-                const p = token.split("=");
-                if (p.length == 2) {
-                    qs[p[0]] = p[1];
-                }
-            });
-        }
-        return qs;
-    }
-    UrlUtils.GetQueryString = GetQueryString;
     /**
-     * Helper to get and set url params for a given window.
+     * Returns a url-safe string that is human readable.
+     * Eg: 'My Project View!' into 'My-Project-View'.
+     * @param str
+     * @returns
      */
-    class Handler {
-        get window() {
-            return this._window;
-        }
-        get document() {
-            var _a;
-            return (_a = this.window) === null || _a === void 0 ? void 0 : _a.document;
-        }
-        get allowedKeys() {
-            return this._allowedKeys;
-        }
-        constructor(window, allowedKeys) {
-            this._allowedKeys = null;
-            this._window = window;
-            this._allowedKeys = allowedKeys;
-        }
-        UpdateAllowedKeys(allowedKeys) {
-            this._allowedKeys = allowedKeys;
-            let params = this.GetParams();
-            this.refresh(params);
-        }
-        UpdateParam(key, value) {
-            let params = this.GetParams();
-            params[key + ""] = value + "";
-            this.refresh(params);
-        }
-        RemoveParam(key) {
-            let params = this.GetParams();
-            params[key + ""] = null;
-            this.refresh(params);
-        }
-        GetParamKeys() {
-            let params = GetQueryString(this.document);
-            return Object.keys(params);
-        }
-        GetParams() {
-            return GetQueryString(this.document);
-        }
-        GetParam(key) {
-            let params = this.GetParams();
-            return params[key + ""];
-        }
-        Clear() {
-            this.refresh({});
-        }
-        refresh(urlParams) {
-            const params = [];
-            const keys = Object.keys(urlParams);
-            for (let i = 0; i < keys.length; i++) {
-                const key = keys[i];
-                if (this._allowedKeys == null || this._allowedKeys.includes(key)) {
-                    const val = urlParams[key];
-                    if (!!val || val == 0) {
-                        params.push(`${key}=${val}`);
-                    }
-                }
-            }
-            if (params.length > 0) {
-                this.window.history.replaceState({}, null, "?" + params.join("&"));
-            }
-            else {
-                this.window.history.replaceState({}, null, "");
-            }
-        }
+    function ToHumanReadable(str) {
+        str = str.replace(/[^a-zA-Z0-9]/gi, "-");
+        // Dedupe underscores.
+        str = str.replace(/-+/g, "-");
+        // Trim underscores.
+        str = str.replace(/^-+|-+$/g, "");
+        return str;
     }
-    UrlUtils.Handler = Handler;
+    UrlUtils.ToHumanReadable = ToHumanReadable;
 })(UrlUtils = exports.UrlUtils || (exports.UrlUtils = {}));
 //# sourceMappingURL=url-utils.js.map

package/dist/lib/util/url-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"url-utils.js","sourceRoot":"","sources":["../../../src/util/url-utils.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,IAAiB,QAAQ,CA8FxB;AA9FD,WAAiB,QAAQ;IACrB,SAAgB,cAAc,CAAC,GAAa;QACxC,MAAM,EAAE,GAAQ,EAAE,CAAC;QACnB,MAAM,EAAE,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,EAAE,IAAI,CAAC,EAAE;YACT,MAAM,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAChD,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC9B,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBACnB,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC3B,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE;oBACf,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;iBACnB;YACL,CAAC,CAAC,CAAC;SACN;QACD,OAAO,EAAE,CAAC;IACd,CAAC;IAde,uBAAc,iBAc7B,CAAA;IAED;;OAEG;IACH,MAAa,OAAO;QAEhB,IAAW,MAAM;YACb,OAAO,IAAI,CAAC,OAAO,CAAC;QACxB,CAAC;QACD,IAAY,QAAQ;;YAChB,OAAO,MAAA,IAAI,CAAC,MAAM,0CAAE,QAAQ,CAAC;QACjC,CAAC;QAED,IAAW,WAAW;YAClB,OAAO,IAAI,CAAC,YAAY,CAAC;QAC7B,CAAC;QAED,YAAmB,MAAc,EAAE,WAAsB;YALjD,iBAAY,GAAkB,IAAI,CAAC;YAMvC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;YACtB,IAAI,CAAC,YAAY,GAAa,WAAW,CAAC;QAC9C,CAAC;QAEM,iBAAiB,CAAC,WAAqB;YAC1C,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;YAChC,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAC9B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;QAEM,WAAW,CAAC,GAAW,EAAE,KAAsB;YAClD,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAC9B,MAAM,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC;YAC9B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;QAEM,WAAW,CAAC,GAAW;YAC1B,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAC9B,MAAM,CAAC,GAAG,GAAG,EAAE,CAAC,GAAQ,IAAI,CAAC;YAC7B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;QAEM,YAAY;YACf,IAAI,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC3C,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;QAEM,SAAS;YACZ,OAAO,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC;QAEM,QAAQ,CAAC,GAAW;YACvB,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAC9B,OAAO,MAAM,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;QAC5B,CAAC;QAEM,KAAK;YACR,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACrB,CAAC;QAEO,OAAO,CAAC,SAAuC;YACnD,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACpC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAClC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBACpB,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBAC9D,MAAM,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;oBAC3B,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,EAAE;wBACnB,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC,CAAC;qBAChC;iBACJ;aACJ;YACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;gBACnB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,EAAO,IAAI,EAAE,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;aAC3E;iBACI;gBACD,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,EAAO,IAAI,EAAE,EAAE,CAAC,CAAC;aACvD;QACL,CAAC;KACJ;IAzEY,gBAAO,UAyEnB,CAAA;AACL,CAAC,EA9FgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QA8FxB"}
+{"version":3,"file":"url-utils.js","sourceRoot":"","sources":["../../../src/util/url-utils.ts"],"names":[],"mappings":";;;AAAA,IAAiB,QAAQ,CAexB;AAfD,WAAiB,QAAQ;IACrB;;;;;OAKG;IACH,SAAgB,eAAe,CAAC,GAAW;QACvC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;QACzC,sBAAsB;QACtB,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC9B,oBAAoB;QACpB,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAClC,OAAO,GAAG,CAAC;IACf,CAAC;IAPe,wBAAe,kBAO9B,CAAA;AACL,CAAC,EAfgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAexB"}

package/dist/types/account/account-invite.d.ts

@@ -1,9 +1,15 @@
 import { Api } from "../api/api";
 import { GuardianApi } from "../api/guardian-api";
-import { IdmApi } from "../api/idm-api";
 import { UTC } from "../common/utc";
 import { User } from "../user/user";
+/**
+ * An account-invite is an invitation to a user to join a client account.
+ * New users to Nextspace will setup their user account within the invitation process.
+ */
 export declare namespace AccountInvite {
+    /**
+     * Describes an account-invite record.
+     */
     interface IInvite {
         ID: number;
         "Account.ID": string;
@@ -14,6 +20,9 @@ export declare namespace AccountInvite {
         IsExpired: boolean;
         Status: EStatus;
     }
+    /**
+     * Possible invite statuses.
+     */
     enum EStatus {
         Denied = "Denied",
         Cancelled = "Cancelled",
@@ -21,20 +30,34 @@ export declare namespace AccountInvite {
         NotSent = "NotSent",
         Accepted = "Accepted"
     }
+    /**
+     * Possible invite methods.
+     */
     enum EInviteMethod {
         Email = "Email",
-        SMS = "SMS",
-        Manual = "Manual"
+        Manual = "Manual",
+        SMS = "SMS"
     }
+    /**
+     * Returns an invite matching a provided invite code.
+     * @param params
+     * @returns
+     */
     function GetByCode(params: {
-        api?: IdmApi.Api | GuardianApi.Api;
+        api?: GuardianApi.Api;
         code: string;
         req?: Api.IReqParams;
     }): Promise<{
         invite: IInvite;
     }>;
+    /**
+     * Returns a list of invites matching provided criteria.
+     * For example you can get a list of invites for a specific account or user (or both).
+     * @param params
+     * @returns
+     */
     function GetList(params: {
-        api?: IdmApi.Api | GuardianApi.Api;
+        api?: GuardianApi.Api;
         accountId?: string;
         userId?: string;
         req?: Api.IReqParams;
@@ -42,15 +65,28 @@ export declare namespace AccountInvite {
         invites: IInvite[];
         warnings?: string[];
     }>;
+    /**
+     * Updates an invite's status.
+     * Once an invite is accepted or denied it cannot be changed.
+     * @param params
+     * @returns
+     */
     function Update(params: {
-        api?: IdmApi.Api | GuardianApi.Api;
+        api?: GuardianApi.Api;
         code: string;
         status: string;
         user?: User.IUser;
         req?: Api.IReqParams;
     }): Promise<any>;
+    /**
+     * Creates a new invite.
+     * Please validate the response invitation records to ensure the desired contact method was used and worked.
+     * Eg: It will tell you if the email was sent successfully.
+     * @param params
+     * @returns
+     */
     function Create(params: {
-        api?: IdmApi.Api | GuardianApi.Api;
+        api?: GuardianApi.Api;
         accountId: string;
         login?: string;
         userId?: string;
@@ -62,8 +98,8 @@ export declare namespace AccountInvite {
     }): Promise<{
         warnings?: string[];
         user: User.IUser;
-        manualInviteCode?: string;
         invite: IInvite;
         manualInvite?: IInvite;
+        manualInviteCode?: string;
     }>;
 }

package/dist/types/account/account-settings.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Account settings are arbitrary JSON blobs for storing settings for particular applications.
+ */
 export declare namespace AccountSettings {
     type Settings = IBruceApi | INavigator | any;
     interface IBruceApi {

package/dist/types/account/account.d.ts

@@ -1,51 +1,107 @@
 import { Api } from "../api/api";
 import { BruceApi } from "../api/bruce-api";
-import { CamApi } from "../api/cam-api";
 import { GuardianApi } from "../api/guardian-api";
-import { IdmApi } from "../api/idm-api";
 import { AccountSettings } from "./account-settings";
 /**
- * Describes the "Client Account" concept within Bruce.
+ * Describes the "Client Account" concept within Nextspace.
  * A client account is a database instance that holds one or many users.
  */
 export declare namespace Account {
+    /**
+     * Returns cache identifier for an account by ID.
+     * Example: {
+     *    const api: BruceApi.Api = ...;
+     *    const key = GetCacheKey(1);
+     *    api.Cache.Remove(key);
+     * }
+     * @param accountId
+     * @param appSettingsId
+     * @returns
+     */
     function GetCacheKey(accountId: string, appSettingsId?: string): string;
+    /**
+     * Returns cache identifier for a list of accounts by session ID.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey(api.GetSessionId());
+     *     api.Cache.Remove(key);
+     * }
+     * @param ssid
+     * @returns
+     */
     function GetListCacheKey(ssid: string): string;
+    /**
+     * Returns cache identifier for a list of database regions.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetDbRegionListCacheKey();
+     *     api.Cache.Remove(key);
+     * }
+     * @returns
+     */
     function GetDbRegionListCacheKey(): Api.ECacheKey;
+    /**
+     * Known Nextspace applications we store settings for.
+     */
     enum EAppId {
         BruceApi = "BruceAPI",
         Navigator = "Navigator"
     }
     type AppId = EAppId | string;
+    /**
+     * Possible starter content options.
+     * When creating a new account you can populate it with certain default data.
+     */
     enum EStarterContent {
         Default = "default",
         None = "none"
     }
+    /**
+     * Describes a Nextspace client account record.
+     */
     interface IAccount {
         ID?: string;
+        Subdomain?: string;
         Name?: string;
-        "ClientAccount.ID"?: string;
+        "Client.ID": string;
+        "OwnerUser.ID"?: string;
         "Application.ID"?: string;
+        "Application.Settings"?: AccountSettings.Settings;
+        "HostingLocation.Key"?: string;
+        "ClientAccount.ID"?: string;
         "BruceAPI"?: string;
         "Settings"?: any;
-        "OwnerUser.ID"?: string;
-        "Application.Settings"?: AccountSettings.Settings;
     }
+    /**
+     * Gets a client account record by ID.
+     * @param params
+     * @returns
+     */
     function Get(params: {
-        api?: CamApi.Api | GuardianApi.Api;
+        api?: GuardianApi.Api;
         accountId: string;
         req?: Api.IReqParams;
     }): Promise<{
         account: IAccount;
     }>;
+    /**
+     * Gets a list of client accounts related to the current session user.
+     * @param params
+     * @returns
+     */
     function GetRelatedList(params: {
-        api?: IdmApi.Api | GuardianApi.Api;
+        api?: GuardianApi.Api;
         req?: Api.IReqParams;
     }): Promise<{
         accounts: IAccount[];
     }>;
+    /**
+     * Gets application settings for a specific client account.
+     * @param params
+     * @returns
+     */
     function GetAppSettings(params: {
-        api?: CamApi.Api | GuardianApi.Api;
+        api?: GuardianApi.Api;
         accountId: string;
         appId: AppId;
         req?: Api.IReqParams;
@@ -53,12 +109,13 @@ export declare namespace Account {
         settings: AccountSettings.Settings;
     }>;
     /**
+     * Updates application settings for a specific client account + application.
      * WARNING: Do not update API settings without knowing what you're doing.
      * @param params
      * @returns
      */
     function UpdateAppSettings(params: {
-        api?: CamApi.Api | GuardianApi.Api;
+        api?: GuardianApi.Api;
         accountId: string;
         appId: string;
         settings: AccountSettings.Settings;
@@ -67,7 +124,7 @@ export declare namespace Account {
         settings: AccountSettings.Settings;
     }>;
     /**
-     * Creates a new Bruce account using given details.
+     * Creates a new Nextspace account using given details.
      * @param params
      * @returns
      */

package/dist/types/ann-document/ann-document.d.ts

@@ -6,8 +6,32 @@ type Type = AnnDocument.EType | string;
  * Annotated documents are files with hotspots that can link to Entity records.
  */
 export declare namespace AnnDocument {
+    /**
+     * Returns cache identifier for an annotated document by ID.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey(1);
+     *     api.Cache.Remove(key);
+     * }
+     * @param id
+     * @returns
+     */
     function GetCacheKey(id: number): string;
+    /**
+     * Returns cache identifier for a list of annotated documents by type.
+     * Example: {
+     *    const api: BruceApi.Api = ...;
+     *    const key = GetListCacheKey("SVG");
+     *    api.Cache.Remove(key);
+     * }
+     * @param type
+     * @returns
+     */
     function GetListCacheKey(type: Type): string;
+    /**
+     * Describes a hotspot on an annotated document.
+     * Hotspots are areas of interest on the document that can be linked to Entity records.
+     */
     interface IHotspot {
         X: number;
         Y: number;
@@ -17,11 +41,17 @@ export declare namespace AnnDocument {
             "Entity.ID": string;
         };
     }
+    /**
+     * Describes settings for an annotated document.
+     */
     interface ISettings {
         Hotspots?: IHotspot[];
         DrawingScaleFactorX?: number;
         DrawingScaleFactorY?: number;
     }
+    /**
+     * Describes an annotated document record.
+     */
     interface IDocument {
         ID?: number;
         Type: Type;
@@ -29,9 +59,17 @@ export declare namespace AnnDocument {
         "ClientFile.ID": string;
         Settings?: ISettings;
     }
+    /**
+     * The types of supported annotated documents.
+     */
     enum EType {
         SVG = "SVG"
     }
+    /**
+     * Returns an annotated document by ID.
+     * @param params
+     * @returns
+     */
     function Get(params: {
         api?: BruceApi.Api;
         docId: number;
@@ -39,6 +77,11 @@ export declare namespace AnnDocument {
     }): Promise<{
         document: IDocument;
     }>;
+    /**
+     * Returns a list of annotated documents by type.
+     * @param params
+     * @returns
+     */
     function GetList(params: {
         api?: BruceApi.Api;
         docType?: Type;

package/dist/types/api/abstract-api.d.ts

@@ -1,7 +1,7 @@
 import { CacheControl } from "../common/cache";
 import { Api } from "./api";
 /**
- * This is a base class for communication with an arbitrary Bruce Api.
+ * This is a base class for communication with an arbitrary Nextspace API.
  */
 export declare class AbstractApi {
     private ssidHeader;
@@ -12,25 +12,100 @@ export declare class AbstractApi {
         ssidHeader?: string;
         cacheId?: string;
     });
+    /**
+     * Returns the base URL for the API.
+     * @returns
+     */
     GetBaseUrl(): string;
+    /**
+     * Sets the base URL for the API.
+     * @param url
+     */
     SetBaseUrl(url: string): void;
+    /**
+     * Returns a cache item matching the provided key.
+     * If the reqParams specify that caching is disabled, null is returned.
+     * @param key
+     * @param reqParams
+     * @returns
+     */
     GetCacheItem(key: string, reqParams?: Api.IReqParams): {
         data: any;
         found: boolean;
     };
+    /**
+     * Sets a cache item matching the provided key.
+     * If the reqParams specify that caching is disabled, then no action is taken.
+     * @param params
+     * @returns
+     */
     SetCacheItem(params: {
         key: string;
         value: any;
         duration?: number;
         req?: Api.IReqParams;
     }): void;
+    /**
+     * Returns the session ID.
+     * @returns
+     */
     GetSessionId(): string;
+    /**
+     * Sets the session ID.
+     * @param value
+     */
     SetSessionId(value: string): void;
+    /**
+     * Returns the session header.
+     * @returns
+     */
     GetSessionHeader(): string;
+    /**
+     * Sets the session header.
+     * @param value
+     */
     SetSessionHeader(value: string): void;
+    /**
+     * Performs a GET request.
+     * This will NOT prepend the base URL to the provided URL.
+     * @param url
+     * @param params
+     * @returns
+     */
     get(url: string, params?: Api.IReqParams): Promise<any>;
+    /**
+     * Performs a DELETE request.
+     * This will NOT prepend the base URL to the provided URL.
+     * @param url
+     * @param params
+     * @returns
+     */
     delete(url: string, params?: Api.IReqParams): Promise<any>;
+    /**
+     * Performs a POST request.
+     * This will NOT prepend the base URL to the provided URL.
+     * @param url
+     * @param data
+     * @param params
+     * @returns
+     */
     post(url: string, data: any, params?: Api.IReqParams): Promise<any>;
+    /**
+     * Performs a PUT request.
+     * This will NOT prepend the base URL to the provided URL.
+     * @param url
+     * @param data
+     * @param params
+     * @returns
+     */
     put(url: string, data: any, params?: Api.IReqParams): Promise<any>;
+    /**
+     * Performs a file upload (POST) request.
+     * This will NOT prepend the base URL to the provided URL.
+     * @param url
+     * @param blob
+     * @param params
+     * @returns
+     */
     upload(url: string, blob: Blob, params?: Api.IUploadReqParams): Promise<any>;
 }

package/dist/types/api/api-getters.d.ts

@@ -1,13 +1,28 @@
 import { Api } from "./api";
 import { BruceApi } from "./bruce-api";
-import { CamApi } from "./cam-api";
 import { GlobalApi } from "./global-api";
 import { GuardianApi } from "./guardian-api";
-import { IdmApi } from "./idm-api";
+/**
+ * Utility for managing multiple API instances.
+ * Example: {
+ *     const api = new ApiGetters({
+ *         accountId: "123",
+ *         env: Api.EEnv.PROD
+ *     });
+ *
+ *     // Returns default API instance specified in constructor.
+ *     const bruce1 = api.GetBruceApi();
+ *     // Returns API instance for account 456.
+ *     const bruce2 = api.GetBruceApi({
+ *          accountId: "456"
+ *     });
+ *
+ *     const global = api.GetGlobalApi();
+ *     const guardian = api.GetGuardianApi();
+ * }
+ */
 export declare class ApiGetters {
     private bruce;
-    private idm;
-    private cam;
     private guardian;
     private global;
     private accountId;
@@ -18,48 +33,71 @@ export declare class ApiGetters {
         env?: Api.EEnv;
         sessionId?: string;
     });
+    /**
+     * Clears all cache items in all API instances.
+     */
     ClearCache(): void;
+    /**
+     * Sets the default account ID to use when one is unspecified.
+     * @param accountId
+     */
     SetAccountId(accountId: string): void;
+    /**
+     * Returns the default account ID to use when one is unspecified.
+     * @returns
+     */
     GetAccountId(): string;
+    /**
+     * Sets the default environment to use when one is unspecified.
+     * @param env
+     */
     SetEnv(env: Api.EEnv): void;
+    /**
+     * Returns the default environment to use when one is unspecified.
+     * @returns
+     */
     GetEnv(): Api.EEnv;
+    /**
+     * Updates the session ID for all API instances.
+     * This will auto-clear all cache items.
+     * @param sessionId
+     */
     SetSessionId(sessionId: string): void;
-    GetSessionId(): string;
-    GetBruceApi(params?: {
-        accountId?: string;
-        env?: Api.EEnv;
-    }): BruceApi.Api;
-    GetBruceGetter(): BruceApi.IGetter;
     /**
-     * Deprecated: Use GetGuardianApi instead.
+     * Returns the session ID.
      * @returns
      */
-    GetIdmApi(params?: {
-        env?: Api.EEnv;
-    }): IdmApi.Api;
+    GetSessionId(): string;
     /**
-     * Deprecated: Use GetGuardianGetter instead.
+     * Returns a BruceApi instance.
+     * @param params
      * @returns
      */
-    GetIdmGetter(): IdmApi.IGetter;
+    GetBruceApi(params?: {
+        accountId?: string;
+        env?: Api.EEnv;
+    }): BruceApi.Api;
     /**
-     * Deprecated: Use GetGuardianApi instead.
+     * Returns a BruceApi getter instance.
+     * This is a micro-utility that is used to request the bruce-api specifically for various client accounts.
+     * @deprecated: use the full api-getters instance instead.
      * @returns
      */
-    GetCamApi(params?: {
-        env?: Api.EEnv;
-    }): CamApi.Api;
+    GetBruceGetter(): BruceApi.IGetter;
     /**
-     * Deprecated: Use GetGuardianGetter instead.
+     * Returns a GlobalApi instance.
+     * @param params
      * @returns
      */
-    GetCamGetter(): CamApi.IGetter;
     GetGlobalApi(params?: {
         env?: Api.EEnv;
     }): GlobalApi.Api;
-    GetGlobalGetter(): GlobalApi.IGetter;
+    /**
+     * Returns a GuardianApi instance.
+     * @param params
+     * @returns
+     */
     GetGuardianApi(params?: {
         env?: Api.EEnv;
     }): GuardianApi.Api;
-    GetGuardianGetter(): GuardianApi.IGetter;
 }