bruce-models 2.3.7 → 2.3.8

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

@@ -1,68 +1,68 @@
-import { Api } from "../api/api";
-import { IdmApi } from "../api/idm-api";
-import { UTC } from "../common/utc";
-import { User } from "../user/user";
-export declare namespace AccountInvite {
-    interface IInvite {
-        ID: number;
-        "Account.ID": string;
-        "Invited.User.ID": string;
-        "InvitedBy.User.ID": string;
-        CreatedDate: UTC.IUTC;
-        InviteMethod: EInviteMethod;
-        IsExpired: boolean;
-        Status: EStatus;
-    }
-    enum EStatus {
-        Denied = "Denied",
-        Cancelled = "Cancelled",
-        Sent = "Sent",
-        NotSent = "NotSent",
-        Accepted = "Accepted"
-    }
-    enum EInviteMethod {
-        Email = "Email",
-        SMS = "SMS",
-        Manual = "Manual"
-    }
-    function GetByCode(params: {
-        api: IdmApi.Api;
-        code: string;
-        req?: Api.IReqParams;
-    }): Promise<{
-        invite: IInvite;
-    }>;
-    function GetList(params: {
-        api: IdmApi.Api;
-        accountId?: string;
-        userId?: string;
-        req?: Api.IReqParams;
-    }): Promise<{
-        invites: IInvite[];
-        warnings?: string[];
-    }>;
-    function Update(params: {
-        api: IdmApi.Api;
-        code: string;
-        status: string;
-        user?: User.IUser;
-        req?: Api.IReqParams;
-    }): Promise<any>;
-    function Create(params: {
-        api: IdmApi.Api;
-        accountId: string;
-        login?: string;
-        userId?: string;
-        email?: string;
-        mobile?: string;
-        emailTemplateKey?: string;
-        groupIds?: string[];
-        req?: Api.IReqParams;
-    }): Promise<{
-        warnings?: string[];
-        user: User.IUser;
-        manualInviteCode?: string;
-        invite: IInvite;
-        manualInvite?: IInvite;
-    }>;
-}
+import { Api } from "../api/api";
+import { IdmApi } from "../api/idm-api";
+import { UTC } from "../common/utc";
+import { User } from "../user/user";
+export declare namespace AccountInvite {
+    interface IInvite {
+        ID: number;
+        "Account.ID": string;
+        "Invited.User.ID": string;
+        "InvitedBy.User.ID": string;
+        CreatedDate: UTC.IUTC;
+        InviteMethod: EInviteMethod;
+        IsExpired: boolean;
+        Status: EStatus;
+    }
+    enum EStatus {
+        Denied = "Denied",
+        Cancelled = "Cancelled",
+        Sent = "Sent",
+        NotSent = "NotSent",
+        Accepted = "Accepted"
+    }
+    enum EInviteMethod {
+        Email = "Email",
+        SMS = "SMS",
+        Manual = "Manual"
+    }
+    function GetByCode(params: {
+        api: IdmApi.Api;
+        code: string;
+        req?: Api.IReqParams;
+    }): Promise<{
+        invite: IInvite;
+    }>;
+    function GetList(params: {
+        api: IdmApi.Api;
+        accountId?: string;
+        userId?: string;
+        req?: Api.IReqParams;
+    }): Promise<{
+        invites: IInvite[];
+        warnings?: string[];
+    }>;
+    function Update(params: {
+        api: IdmApi.Api;
+        code: string;
+        status: string;
+        user?: User.IUser;
+        req?: Api.IReqParams;
+    }): Promise<any>;
+    function Create(params: {
+        api: IdmApi.Api;
+        accountId: string;
+        login?: string;
+        userId?: string;
+        email?: string;
+        mobile?: string;
+        emailTemplateKey?: string;
+        groupIds?: string[];
+        req?: Api.IReqParams;
+    }): Promise<{
+        warnings?: string[];
+        user: User.IUser;
+        manualInviteCode?: string;
+        invite: IInvite;
+        manualInvite?: IInvite;
+    }>;
+}

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

@@ -1,24 +1,24 @@
-export declare namespace AccountSettings {
-    type Settings = IBruceApi | INavigator | any;
-    interface IBruceApi {
-        "HostingLocation.Key"?: string;
-        "DatabaseServer.ID"?: number;
-        DBLocation?: string;
-        DBServer?: string;
-        FileStorageRegion?: string;
-        FileStorageName?: string;
-    }
-    interface INavigator {
-        branding?: {
-            loginTitleFileId?: string;
-            loginBannerFileId?: string;
-            dashBannerFileId?: string;
-            navIconFileId?: string;
-            links?: ILink[];
-        };
-    }
-    interface ILink {
-        name: string;
-        url: string;
-    }
-}
+export declare namespace AccountSettings {
+    type Settings = IBruceApi | INavigator | any;
+    interface IBruceApi {
+        "HostingLocation.Key"?: string;
+        "DatabaseServer.ID"?: number;
+        DBLocation?: string;
+        DBServer?: string;
+        FileStorageRegion?: string;
+        FileStorageName?: string;
+    }
+    interface INavigator {
+        branding?: {
+            loginTitleFileId?: string;
+            loginBannerFileId?: string;
+            dashBannerFileId?: string;
+            navIconFileId?: string;
+            links?: ILink[];
+        };
+    }
+    interface ILink {
+        name: string;
+        url: string;
+    }
+}

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

@@ -1,84 +1,84 @@
-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.
- * A client account is a database instance that holds one or many users.
- */
-export declare namespace Account {
-    function GetCacheKey(accountId: string, appSettingsId?: string): string;
-    function GetListCacheKey(ssid: string): string;
-    function GetDbRegionListCacheKey(): Api.ECacheKey;
-    enum EAppId {
-        BruceApi = "BruceAPI",
-        Navigator = "Navigator"
-    }
-    type AppId = EAppId | string;
-    enum EStarterContent {
-        Default = "default",
-        None = "none"
-    }
-    interface IAccount {
-        ID?: string;
-        Name?: string;
-        "ClientAccount.ID"?: string;
-        "Application.ID"?: string;
-        "BruceAPI"?: string;
-        "Settings"?: any;
-        "OwnerUser.ID"?: string;
-        "Application.Settings"?: AccountSettings.Settings;
-    }
-    function Get(params: {
-        api: CamApi.Api | GuardianApi.Api;
-        accountId: string;
-        req?: Api.IReqParams;
-    }): Promise<{
-        account: IAccount;
-    }>;
-    function GetRelatedList(params: {
-        api: IdmApi.Api;
-        req?: Api.IReqParams;
-    }): Promise<{
-        accounts: IAccount[];
-    }>;
-    function GetAppSettings(params: {
-        api: CamApi.Api | GuardianApi.Api;
-        accountId: string;
-        appId: AppId;
-        req?: Api.IReqParams;
-    }): Promise<{
-        settings: AccountSettings.Settings;
-    }>;
-    /**
-     * WARNING: Do not update API settings without knowing what you're doing.
-     * @param params
-     * @returns
-     */
-    function UpdateAppSettings(params: {
-        api: CamApi.Api | GuardianApi.Api;
-        accountId: string;
-        appId: string;
-        settings: AccountSettings.Settings;
-        req?: Api.IReqParams;
-    }): Promise<{
-        settings: AccountSettings.Settings;
-    }>;
-    /**
-     * Creates a new Bruce account using given details.
-     * @param params
-     * @returns
-     */
-    function Create(params: {
-        api: BruceApi.Api;
-        accountId: string;
-        name: string;
-        hostingLocationKey: string;
-        starterContent?: EStarterContent;
-        req?: Api.IReqParams;
-    }): Promise<{
-        account: IAccount;
-    }>;
-}
+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.
+ * A client account is a database instance that holds one or many users.
+ */
+export declare namespace Account {
+    function GetCacheKey(accountId: string, appSettingsId?: string): string;
+    function GetListCacheKey(ssid: string): string;
+    function GetDbRegionListCacheKey(): Api.ECacheKey;
+    enum EAppId {
+        BruceApi = "BruceAPI",
+        Navigator = "Navigator"
+    }
+    type AppId = EAppId | string;
+    enum EStarterContent {
+        Default = "default",
+        None = "none"
+    }
+    interface IAccount {
+        ID?: string;
+        Name?: string;
+        "ClientAccount.ID"?: string;
+        "Application.ID"?: string;
+        "BruceAPI"?: string;
+        "Settings"?: any;
+        "OwnerUser.ID"?: string;
+        "Application.Settings"?: AccountSettings.Settings;
+    }
+    function Get(params: {
+        api: CamApi.Api | GuardianApi.Api;
+        accountId: string;
+        req?: Api.IReqParams;
+    }): Promise<{
+        account: IAccount;
+    }>;
+    function GetRelatedList(params: {
+        api: IdmApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        accounts: IAccount[];
+    }>;
+    function GetAppSettings(params: {
+        api: CamApi.Api | GuardianApi.Api;
+        accountId: string;
+        appId: AppId;
+        req?: Api.IReqParams;
+    }): Promise<{
+        settings: AccountSettings.Settings;
+    }>;
+    /**
+     * WARNING: Do not update API settings without knowing what you're doing.
+     * @param params
+     * @returns
+     */
+    function UpdateAppSettings(params: {
+        api: CamApi.Api | GuardianApi.Api;
+        accountId: string;
+        appId: string;
+        settings: AccountSettings.Settings;
+        req?: Api.IReqParams;
+    }): Promise<{
+        settings: AccountSettings.Settings;
+    }>;
+    /**
+     * Creates a new Bruce account using given details.
+     * @param params
+     * @returns
+     */
+    function Create(params: {
+        api: BruceApi.Api;
+        accountId: string;
+        name: string;
+        hostingLocationKey: string;
+        starterContent?: EStarterContent;
+        req?: Api.IReqParams;
+    }): Promise<{
+        account: IAccount;
+    }>;
+}

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

@@ -1,50 +1,50 @@
-import { Api } from "../api/api";
-import { BruceApi } from "../bruce-models";
-declare type Type = AnnDocument.EType | string;
-/**
- * Describes communication with the "Annotated Document" concept in Bruce.
- * Annotated documents are files with hotspots that can link to Entity records.
- */
-export declare namespace AnnDocument {
-    function GetCacheKey(id: number): string;
-    function GetListCacheKey(type: Type): string;
-    interface IHotspot {
-        X: number;
-        Y: number;
-        Key: string;
-        Description?: string;
-        LinkedEntity?: {
-            "Entity.ID": string;
-        };
-    }
-    interface ISettings {
-        Hotspots?: IHotspot[];
-        DrawingScaleFactorX?: number;
-        DrawingScaleFactorY?: number;
-    }
-    interface IDocument {
-        ID?: number;
-        Type: Type;
-        Name: string;
-        "ClientFile.ID": string;
-        Settings?: ISettings;
-    }
-    enum EType {
-        SVG = "SVG"
-    }
-    function Get(params: {
-        api: BruceApi.Api;
-        docId: number;
-        req?: Api.IReqParams;
-    }): Promise<{
-        document: IDocument;
-    }>;
-    function GetList(params: {
-        api: BruceApi.Api;
-        docType?: Type;
-        req?: Api.IReqParams;
-    }): Promise<{
-        documents: IDocument[];
-    }>;
-}
-export {};
+import { Api } from "../api/api";
+import { BruceApi } from "../bruce-models";
+type Type = AnnDocument.EType | string;
+/**
+ * Describes communication with the "Annotated Document" concept in Bruce.
+ * Annotated documents are files with hotspots that can link to Entity records.
+ */
+export declare namespace AnnDocument {
+    function GetCacheKey(id: number): string;
+    function GetListCacheKey(type: Type): string;
+    interface IHotspot {
+        X: number;
+        Y: number;
+        Key: string;
+        Description?: string;
+        LinkedEntity?: {
+            "Entity.ID": string;
+        };
+    }
+    interface ISettings {
+        Hotspots?: IHotspot[];
+        DrawingScaleFactorX?: number;
+        DrawingScaleFactorY?: number;
+    }
+    interface IDocument {
+        ID?: number;
+        Type: Type;
+        Name: string;
+        "ClientFile.ID": string;
+        Settings?: ISettings;
+    }
+    enum EType {
+        SVG = "SVG"
+    }
+    function Get(params: {
+        api: BruceApi.Api;
+        docId: number;
+        req?: Api.IReqParams;
+    }): Promise<{
+        document: IDocument;
+    }>;
+    function GetList(params: {
+        api: BruceApi.Api;
+        docType?: Type;
+        req?: Api.IReqParams;
+    }): Promise<{
+        documents: IDocument[];
+    }>;
+}
+export {};

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

@@ -1,36 +1,36 @@
-import { CacheControl } from "../common/cache";
-import { Api } from "./api";
-/**
- * This is a base class for communication with an arbitrary Bruce Api.
- */
-export declare class AbstractApi {
-    private ssidHeader;
-    private ssid;
-    protected baseUrl: string;
-    Cache: CacheControl<any>;
-    constructor(params: {
-        ssidHeader?: string;
-        cacheId?: string;
-    });
-    GetBaseUrl(): string;
-    SetBaseUrl(url: string): void;
-    GetCacheItem(key: string, reqParams?: Api.IReqParams): Promise<{
-        data: any;
-        found: boolean;
-    }>;
-    SetCacheItem(params: {
-        key: string;
-        value: any;
-        duration?: number;
-        req?: Api.IReqParams;
-    }): Promise<void>;
-    GetSessionId(): string;
-    SetSessionId(value: string): void;
-    GetSessionHeader(): string;
-    SetSessionHeader(value: string): void;
-    get(url: string, params?: Api.IReqParams): Promise<any>;
-    delete(url: string, params?: Api.IReqParams): Promise<any>;
-    post(url: string, data: any, params?: Api.IReqParams): Promise<any>;
-    put(url: string, data: any, params?: Api.IReqParams): Promise<any>;
-    upload(url: string, blob: Blob, params?: Api.IUploadReqParams): Promise<any>;
-}
+import { CacheControl } from "../common/cache";
+import { Api } from "./api";
+/**
+ * This is a base class for communication with an arbitrary Bruce Api.
+ */
+export declare class AbstractApi {
+    private ssidHeader;
+    private ssid;
+    protected baseUrl: string;
+    Cache: CacheControl<any>;
+    constructor(params: {
+        ssidHeader?: string;
+        cacheId?: string;
+    });
+    GetBaseUrl(): string;
+    SetBaseUrl(url: string): void;
+    GetCacheItem(key: string, reqParams?: Api.IReqParams): Promise<{
+        data: any;
+        found: boolean;
+    }>;
+    SetCacheItem(params: {
+        key: string;
+        value: any;
+        duration?: number;
+        req?: Api.IReqParams;
+    }): Promise<void>;
+    GetSessionId(): string;
+    SetSessionId(value: string): void;
+    GetSessionHeader(): string;
+    SetSessionHeader(value: string): void;
+    get(url: string, params?: Api.IReqParams): Promise<any>;
+    delete(url: string, params?: Api.IReqParams): Promise<any>;
+    post(url: string, data: any, params?: Api.IReqParams): Promise<any>;
+    put(url: string, data: any, params?: Api.IReqParams): Promise<any>;
+    upload(url: string, blob: Blob, params?: Api.IUploadReqParams): Promise<any>;
+}

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

@@ -1,64 +1,64 @@
-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";
-export declare class ApiGetters {
-    private bruce;
-    private idm;
-    private cam;
-    private guardian;
-    private global;
-    private accountId;
-    private env;
-    private sessionId;
-    constructor(params: {
-        accountId: string;
-        env?: Api.EEnv;
-        sessionId?: string;
-    });
-    SetAccountId(accountId: string): void;
-    GetAccountId(): string;
-    SetEnv(env: Api.EEnv): void;
-    GetEnv(): Api.EEnv;
-    SetSessionId(sessionId: string): void;
-    GetSessionId(): string;
-    GetBruceApi(params: {
-        accountId?: string;
-        env?: Api.EEnv;
-    }): BruceApi.Api;
-    GetBruceGetter(): BruceApi.IGetter;
-    /**
-     * Deprecated: Use GetGuardianApi instead.
-     * @returns
-     */
-    GetIdmApi(params: {
-        env?: Api.EEnv;
-    }): IdmApi.Api;
-    /**
-     * Deprecated: Use GetGuardianGetter instead.
-     * @returns
-     */
-    GetIdmGetter(): IdmApi.IGetter;
-    /**
-     * Deprecated: Use GetGuardianApi instead.
-     * @returns
-     */
-    GetCamApi(params: {
-        env?: Api.EEnv;
-    }): CamApi.Api;
-    /**
-     * Deprecated: Use GetGuardianGetter instead.
-     * @returns
-     */
-    GetCamGetter(): CamApi.IGetter;
-    GetGlobalApi(params: {
-        env?: Api.EEnv;
-    }): GlobalApi.Api;
-    GetGlobalGetter(): GlobalApi.IGetter;
-    GetGuardianApi(params: {
-        env?: Api.EEnv;
-    }): GuardianApi.Api;
-    GetGuardianGetter(): GuardianApi.IGetter;
-}
+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";
+export declare class ApiGetters {
+    private bruce;
+    private idm;
+    private cam;
+    private guardian;
+    private global;
+    private accountId;
+    private env;
+    private sessionId;
+    constructor(params: {
+        accountId: string;
+        env?: Api.EEnv;
+        sessionId?: string;
+    });
+    SetAccountId(accountId: string): void;
+    GetAccountId(): string;
+    SetEnv(env: Api.EEnv): void;
+    GetEnv(): Api.EEnv;
+    SetSessionId(sessionId: string): void;
+    GetSessionId(): string;
+    GetBruceApi(params: {
+        accountId?: string;
+        env?: Api.EEnv;
+    }): BruceApi.Api;
+    GetBruceGetter(): BruceApi.IGetter;
+    /**
+     * Deprecated: Use GetGuardianApi instead.
+     * @returns
+     */
+    GetIdmApi(params: {
+        env?: Api.EEnv;
+    }): IdmApi.Api;
+    /**
+     * Deprecated: Use GetGuardianGetter instead.
+     * @returns
+     */
+    GetIdmGetter(): IdmApi.IGetter;
+    /**
+     * Deprecated: Use GetGuardianApi instead.
+     * @returns
+     */
+    GetCamApi(params: {
+        env?: Api.EEnv;
+    }): CamApi.Api;
+    /**
+     * Deprecated: Use GetGuardianGetter instead.
+     * @returns
+     */
+    GetCamGetter(): CamApi.IGetter;
+    GetGlobalApi(params: {
+        env?: Api.EEnv;
+    }): GlobalApi.Api;
+    GetGlobalGetter(): GlobalApi.IGetter;
+    GetGuardianApi(params: {
+        env?: Api.EEnv;
+    }): GuardianApi.Api;
+    GetGuardianGetter(): GuardianApi.IGetter;
+}