@trakit/objects 0.0.1

package/Billing/Report/BillingReportServiceBreakdown.d.ts

@@ -0,0 +1,126 @@
+import { IBelongAsset } from "../../API/Interfaces/IBelongAsset";
+import { INamed } from "../../API/Interfaces/INamed";
+import { ISerializable } from "../../API/Interfaces/ISerializable";
+import { codified, datetime, double, phone, ulong } from "../../API/Types";
+import { Asset } from "../../Assets/Asset";
+import { AssetType } from "../../Assets/AssetType";
+import { Provider } from "../../Providers/Provider";
+/**
+ * Full breakdown of billable details per targeted asset.
+ */
+export declare class BillingReportServiceBreakdown implements INamed, IBelongAsset, ISerializable {
+    /**
+     *
+     * @param json
+     * @returns
+     */
+    static fromJSON(json: any): BillingReportServiceBreakdown;
+    /**
+     * The asset to which this breakdown instance belongs.
+     * {@link Asset.id}
+     */
+    assetId: ulong;
+    /**
+     * The asset to which this breakdown instance belongs.
+     * {@link Asset.id}
+     */
+    get asset(): Asset;
+    set asset(value: Asset);
+    /**
+     * Type of asset.
+     */
+    kind: AssetType;
+    /**
+     * Asset's name.
+     */
+    name: string;
+    /**
+     * Notes about the asset.
+     */
+    notes: string;
+    /**
+     * Indicates when this Asset was created.
+     */
+    created: Date;
+    /**
+     * Indicates when this Asset was deleted.
+     */
+    deleted: Date;
+    /**
+     * Indicates when this Asset wass suspended from event processing.
+     */
+    suspended: Date;
+    /**
+     * Indicates when this Asset was restored after being deleted.
+     */
+    restored: Date;
+    /**
+     * Indicates when this Asset was revived after being suspended.
+     */
+    revived: Date;
+    /**
+     * Codified label names.
+     * {@link LabelStyle.code}
+     */
+    labels: codified[];
+    /**
+     * The list of devices providing events for this asset.
+     * {@link Provider.id}
+     */
+    providerIds: string[];
+    /**
+     * The list of devices providing events for this asset.
+     * {@link Provider.id}
+     */
+    get providers(): Provider[];
+    set providers(value: Provider[]);
+    /**
+     * The list of phone numbers for this asset.
+     */
+    phoneNumbers: phone[];
+    /**
+     * Indicates when this Asset was last updated.
+     */
+    updatedDts: Date;
+    /**
+     * Number of days this Asset is being billed for.
+     */
+    billableDays: double;
+    /**
+     * Cost per billing cycle for this asset.
+     */
+    cost: double;
+    /**
+     * Number of days this Asset was suspended.
+     */
+    suspendedDays: double;
+    /**
+     * Cost per billing cycle for suspended asset.
+     */
+    suspendedCost: double;
+    /**
+     * Total amount being billed for this asset.
+     */
+    total: double;
+    constructor(asset?: ulong, kind?: AssetType, name?: string, notes?: string, created?: Date | number | datetime, deleted?: Date | number | datetime, suspended?: Date | number | datetime, restored?: Date | number | datetime, revived?: Date | number | datetime, labels?: codified[], providers?: string[], phoneNumbers?: phone[], updatedDts?: Date | number | datetime, billableDays?: double, cost?: double, suspendedDays?: double, suspendedCost?: double, total?: double);
+    toJSON(): {
+        asset: number | null;
+        kind: AssetType;
+        name: string;
+        notes: string;
+        created: string | null;
+        deleted: string | null;
+        suspended: string | null;
+        restored: string | null;
+        revived: string | null;
+        labels: string[];
+        providers: string[];
+        phoneNumbers: number[];
+        revupdatedDtsived: string | null;
+        billableDays: number;
+        cost: number;
+        suspendedDays: number;
+        suspendedCost: number;
+        total: number;
+    };
+}

package/Billing/Report/BillingReportStatus.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The lifetime of building a {@link BillingReport}.
+ */
+export declare enum BillingReportStatus {
+    /**
+     * The {@link BillingReport} has been requested, but not yet begun processing.
+     */
+    created = "created",
+    /**
+     * The {@link BillingReport} is waiting for required resources to begin processing.
+     */
+    queued = "queued",
+    /**
+     * The {@link BillingReport} is currently being processed.
+     */
+    running = "running",
+    /**
+     * The {@link BillingReport} is available for retrieval.
+     */
+    completed = "completed",
+    /**
+     * There was an error processing the {@link BillingReport}; see the {@link BillingReport.error} for a description.
+     */
+    failed = "failed"
+}

package/Billing/Report/BillingReportSummary.d.ts

@@ -0,0 +1,51 @@
+import { INamed } from "../../API/Interfaces/INamed";
+import { ISerializable } from "../../API/Interfaces/ISerializable";
+import { ulong } from "../../API/Types";
+import { Company } from "../../Companies/Company";
+import { BillingReportHostingSummary } from "./BillingReportHostingSummary";
+/**
+ * Summarized bill per target.
+ */
+export declare class BillingReportSummary implements INamed, ISerializable {
+    static fromJSON(json: any): BillingReportSummary;
+    /**
+     * The target company to which this summary instance belongs.
+     * {@link Company.id}
+     */
+    targetId: ulong;
+    /**
+     * The target company to which this summary instance belongs.
+     * {@link Company.id}
+     */
+    get target(): Company;
+    /**
+     * The target company's parent.
+     * {@link Company.id}
+     */
+    parentId: ulong;
+    /**
+     * The target company's parent.
+     * {@link Company.id}
+     */
+    get parent(): Company;
+    /**
+     * Target's name.
+     */
+    name: string;
+    /**
+     * Notes about the target.
+     */
+    notes: string;
+    /**
+     * Summary contains totals per type of hosting (services and licenses) for this target
+     */
+    hosting: BillingReportHostingSummary[];
+    constructor(target?: ulong, parent?: ulong, name?: string, notes?: string, hosting?: BillingReportHostingSummary[]);
+    toJSON(): {
+        target: number | null;
+        parent: number | null;
+        name: string;
+        notes: string;
+        hosting: any[];
+    };
+}

package/Companies/ColourStyle.d.ts

@@ -0,0 +1,25 @@
+import { ISerializable } from "../API/Interfaces/ISerializable";
+import { colour } from "../API/Types";
+/**
+ * Part of the White-labelling profile definitions.
+ */
+export declare class ColourStyle implements ISerializable {
+    /**
+     *
+     * @param json
+     */
+    static fromJSON(json: any): ColourStyle;
+    /**
+     * The colour of the background.
+     */
+    fill: colour;
+    /**
+     * The colour of the text or outline.
+     */
+    stroke: colour;
+    constructor(fill?: colour, stroke?: colour);
+    toJSON(): {
+        fill: string;
+        stroke: string;
+    };
+}

package/Companies/Company.d.ts

@@ -0,0 +1,150 @@
+import { Contact } from '../Accounts/Contact';
+import { BaseComponent } from '../API/BaseComponent';
+import { BaseCompound } from '../API/BaseCompound';
+import { IAmCompany } from '../API/Interfaces/IAmCompany';
+import { IBelongCompany } from '../API/Interfaces/IBelongCompany';
+import { IIdUlong } from '../API/Interfaces/IIdUlong';
+import { INamed } from '../API/Interfaces/INamed';
+import { codified, ulong } from '../API/Types';
+import { Picture } from '../Images/Picture';
+import { CompanyDirectory } from './CompanyDirectory';
+import { CompanyGeneral } from './CompanyGeneral';
+import { CompanyPolicies } from './CompanyPolicies';
+import { CompanyReseller } from './CompanyReseller';
+import { CompanyStyles } from './CompanyStyles';
+import { LabelStyle } from './LabelStyle';
+import { PasswordPolicy } from './PasswordPolicy';
+import { SessionPolicy } from './SessionPolicy';
+/**
+ * The full company object which contains all fields.
+ */
+export declare class Company extends BaseCompound implements IIdUlong, INamed, IAmCompany, IBelongCompany {
+    /**
+     *
+     */
+    get pieces(): BaseComponent[];
+    /**
+     * Unique identifier of this Company.
+     * {@link Asset.id}
+     */
+    get id(): ulong;
+    /**
+     * The parent organization for this Company.
+     * {@link Company.id}
+     */
+    get parent(): Company;
+    set parent(value: Company);
+    get parentId(): number;
+    set parentId(value: number);
+    get company(): Company;
+    get companyId(): number;
+    set companyId(value: number);
+    /**
+     *
+     */
+    general: CompanyGeneral;
+    /**
+     * The organizational name.
+     */
+    get name(): string;
+    set name(value: string);
+    /**
+     * Notes.
+     */
+    get notes(): string;
+    set notes(value: string);
+    /**
+     * Name/value collections of custom fields used to refer to external systems.
+     */
+    get references(): Map<string, string>;
+    set references(value: Map<string, string>);
+    /**
+     *
+     */
+    directory: CompanyDirectory;
+    /**
+     * The list of Contacts from this and other companies broken down by contact role.
+     */
+    get employees(): Map<string, ulong[]>;
+    set employees(value: Map<string, ulong[]>);
+    /**
+     *
+     */
+    policies: CompanyPolicies;
+    /**
+     * The session lifetime policy.
+     */
+    get sessionPolicy(): SessionPolicy;
+    set sessionPolicy(value: SessionPolicy);
+    /**
+     * The password complexity and expiry policy.
+     */
+    get passwordPolicy(): PasswordPolicy;
+    set passwordPolicy(value: PasswordPolicy);
+    /**
+     *
+     */
+    styles: CompanyStyles;
+    /**
+     * The styles for labels added to Assets, Places, and other things.
+     */
+    get labels(): Map<codified, LabelStyle>;
+    set labels(value: Map<codified, LabelStyle>);
+    /**
+     * The styles for status tags added to Assets.
+     */
+    get tags(): Map<codified, LabelStyle>;
+    set tags(value: Map<codified, LabelStyle>);
+    /**
+     * If this company is a reseller, then they have their own theme, support and billing information.
+     */
+    reseller: CompanyReseller | null;
+    /**
+     *
+     */
+    toJSON(): {
+        sessionPolicy: {
+            applications: string[];
+            ipv4Ranges: string[];
+            multiUser: import("./SessionMultiUser").SessionMultiUser;
+            idleAllowed: boolean;
+            expireTimeout: number | null;
+            maxSessions: number | null;
+        };
+        passwordPolicy: {
+            minimumLength: number | null;
+            includeLetters: boolean;
+            includeNumbers: boolean;
+            includeUpperLower: boolean;
+            includeSpecial: boolean;
+            expireMode: import("./PasswordExpiryMode").PasswordExpiryMode;
+            expireThreshold: number | null;
+        };
+        labels: object;
+        tags: object;
+        directory: object;
+        name: string;
+        notes: string;
+        references: object;
+        id: number | null;
+        v: number[];
+        parent: number;
+    };
+    /**
+     *
+     * @param json
+     */
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+    /**
+     *
+     */
+    get contacts(): Contact[];
+    /**
+     *
+     */
+    get pictures(): Picture[];
+}

package/Companies/CompanyDirectory.d.ts

@@ -0,0 +1,49 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IAmCompany } from "../API/Interfaces/IAmCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { codified, ulong } from "../API/Types";
+import { Company } from "./Company";
+/**
+ * The list of Contacts from this and other companies broken down by contact role.
+ */
+export declare class CompanyDirectory extends BaseComponent implements IIdUlong, IAmCompany {
+    /**
+     * Unique identifier of the Company.
+     * {@link Company.id}
+     */
+    id: ulong;
+    /**
+     * The unique identifier of this company's parent organization.
+     * {@link Company.id}
+     */
+    parentId: ulong;
+    /**
+     * The unique identifier of this company's parent organization.
+     * {@link Company.id}
+     */
+    get parent(): Company;
+    /**
+     * The list of Contacts from this and other companies broken down by contact role.
+     * {@link Contact.id}
+     */
+    employees: Map<codified, ulong[]>;
+    /**
+     *
+     * @returns
+     */
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        parent: number;
+        directory: object;
+    };
+    /**
+     *
+     * @param json
+     */
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/Companies/CompanyGeneral.d.ts

@@ -0,0 +1,51 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IAmCompany } from "../API/Interfaces/IAmCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { INamed } from "../API/Interfaces/INamed";
+import { ulong } from "../API/Types";
+import { Company } from "./Company";
+/**
+ * General details about a company.
+ */
+export declare class CompanyGeneral extends BaseComponent implements IIdUlong, INamed, IAmCompany {
+    /**
+     * Unique identifier of the Company.
+     * {@link Company.id}
+     */
+    id: ulong;
+    /**
+     * The unique identifier of this company's parent organization.
+     * {@link Company.id}
+     */
+    parentId: ulong;
+    /**
+     * The unique identifier of this company's parent organization.
+     * {@link Company.id}
+     */
+    get parent(): Company;
+    /**
+     * The organizational name.
+     */
+    name: string;
+    /**
+     * Notes.
+     */
+    notes: string;
+    /**
+     * Name/value collections of custom fields used to refer to external systems.
+     */
+    references: Map<string, string>;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        parent: number;
+        name: string;
+        notes: string;
+        references: object;
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}

package/Companies/CompanyPolicies.d.ts

@@ -0,0 +1,62 @@
+import { BaseComponent } from "../API/BaseComponent";
+import { IAmCompany } from "../API/Interfaces/IAmCompany";
+import { IIdUlong } from "../API/Interfaces/IIdUlong";
+import { ulong } from "../API/Types";
+import { Company } from "./Company";
+import { PasswordPolicy } from "./PasswordPolicy";
+import { SessionPolicy } from "./SessionPolicy";
+/**
+ * The password and session lifetime policies for this Company.
+ */
+export declare class CompanyPolicies extends BaseComponent implements IIdUlong, IAmCompany {
+    /**
+     * Unique identifier of the Company.
+     * {@link Company.id}
+     */
+    id: ulong;
+    /**
+     * The unique identifier of this company's parent organization.
+     * {@link Company.id}
+     */
+    parentId: ulong;
+    /**
+     * The unique identifier of this company's parent organization.
+     * {@link Company.id}
+     */
+    get parent(): Company;
+    /**
+     * The session lifetime policy.
+     */
+    sessionPolicy: SessionPolicy;
+    /**
+     * The password complexity and expiry policy.
+     */
+    passwordPolicy: PasswordPolicy;
+    toJSON(): {
+        id: number | null;
+        v: number[];
+        parent: number;
+        sessionPolicy: {
+            applications: string[];
+            ipv4Ranges: string[];
+            multiUser: import("./SessionMultiUser").SessionMultiUser;
+            idleAllowed: boolean;
+            expireTimeout: number | null;
+            maxSessions: number | null;
+        };
+        passwordPolicy: {
+            minimumLength: number | null;
+            includeLetters: boolean;
+            includeNumbers: boolean;
+            includeUpperLower: boolean;
+            includeSpecial: boolean;
+            expireMode: import("./PasswordExpiryMode").PasswordExpiryMode;
+            expireThreshold: number | null;
+        };
+    };
+    fromJSON(json: any, force?: boolean): boolean;
+    /**
+     * The {@link id} is the key.
+     */
+    getKey(): string;
+}