@trakit/objects 0.0.6 → 0.0.7

package/_publish/objects/Images/Dashcam.d.ts

@@ -1,63 +0,0 @@
-import { TimeSpan } from "../API/TimeSpan";
-import { guid, JsonObject, single } from "../API/Types";
-import { DashcamBase } from "./DashcamBase";
-import { DashcamMediaType } from "./DashcamMediaType";
-/**
- * An image or video received from a dashcam-enabled provider or asset.
- */
-export declare class Dashcam extends DashcamBase {
-    /**
-     * Unique identifier of this resource.
-     */
-    guid: guid;
-    /**
-     * The type of data being stored.
-     */
-    kind: DashcamMediaType;
-    /**
-     * For {@link DashcamMediaType.video} media files, this indicates the frames-per-second.
-     */
-    fps: single;
-    /**
-     * Timestamp of when this resource started.
-     * For {@link DashcamMediaType.image} media files, the start and end are the same.
-     */
-    start: Date;
-    /**
-     * Timestamp of when this resource ended.
-     * For {@link DashcamMediaType.image} media files, the start and end are the same.
-     */
-    end: Date;
-    /**
-     * For {@link DashcamMediaType.video} media files, the duration of the video clip.
-     */
-    get duration(): TimeSpan;
-    /**
-     * The reason why we're saving this image/video. Or the event name that triggered it.
-     */
-    eventName: string;
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    toJSON(): {
-        guid: string;
-        kind: DashcamMediaType;
-        fps: number | null;
-        start: string | null;
-        end: string | null;
-        eventName: string;
-        bytes: number | null;
-        size: import("../API/Geometry/Interfaces").ISize;
-        provider: string;
-        company: number | null;
-        asset: number | null;
-        camera: number | null;
-        latitude: number | null;
-        longitude: number | null;
-        speed: number | null;
-        heading: number | null;
-        altitude: number | null;
-    };
-    /**
-     * The {@link guid} is the key.
-     */
-    getKey(): string;
-}

package/_publish/objects/Images/DashcamBase.d.ts

@@ -1,97 +0,0 @@
-import { ISize } from "../API/Geometry/Interfaces";
-import { Size } from "../API/Geometry/Size";
-import { IDeserializable } from "../API/Interfaces/IDeserializable";
-import { IFileSize } from "../API/Interfaces/IFileSize";
-import { IRequestable } from "../API/Interfaces/IRequestable";
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { byte, double, JsonObject, ulong } from "../API/Types";
-import { Asset } from "../Assets/Asset";
-import { Company } from "../Companies/Company";
-import { Provider } from "../Providers/Provider";
-/**
- * A base class for Dashcam meta-data.
- */
-export declare abstract class DashcamBase implements IRequestable, IFileSize, ISerializable, IDeserializable {
-    /**
-     * Number bytes in the dashcam media file.
-     */
-    bytes: ulong;
-    /**
-     * Resolution defined in pixels.
-     */
-    size: Size;
-    /**
-     * Unique identifier of the provider that sent the data.
-     * {@link Provider.id}
-     */
-    providerId: string;
-    /**
-     * The {@link Provider} that sent the data.
-     */
-    get provider(): Provider;
-    /**
-     * Unique identifier of the company of the provider.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * Unique identifier of the {@link Company} of the provider.
-     */
-    get company(): Company;
-    /**
-     * Unique identifier of the asset tied to the provider at the time.
-     * {@link Asset.id}
-     */
-    assetId: ulong;
-    /**
-     * Unique identifier of the {@link Asset} tied to the provider at the time.
-     */
-    get asset(): Asset;
-    /**
-     * Number assigned to the camera that took the image/video.
-     */
-    camera: byte;
-    /**
-     * Latitude of the start of the resource.
-     */
-    latitude: double;
-    /**
-     * Longitude of the start of the resource.
-     */
-    longitude: double;
-    /**
-     * Speed of the start of the resource.
-     */
-    speed: double;
-    /**
-     * Heading of the start of the resource.
-     */
-    heading: double;
-    /**
-     * Altitude of the start of the resource.
-     */
-    altitude: double;
-    constructor(json?: JsonObject);
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     *
-     */
-    toJSON(): {
-        bytes: number | null;
-        size: ISize;
-        provider: string;
-        company: number | null;
-        asset: number | null;
-        camera: number | null;
-        latitude: number | null;
-        longitude: number | null;
-        speed: number | null;
-        heading: number | null;
-        altitude: number | null;
-    };
-    /**
-     * For dashcams, this is either a unique identifier, or a combination of the {@link assetId}, {@link providerId}, and {@link camera} values.
-     * @returns A string unique for this type of object.
-     */
-    abstract getKey(): string;
-}

package/_publish/objects/Images/DashcamLive.d.ts

@@ -1,36 +0,0 @@
-import { JsonObject } from "../API/Types";
-import { DashcamBase } from "./DashcamBase";
-import { DashcamMediaType } from "./DashcamMediaType";
-/**
- * A live snapshot a dashcam-enabled provider or asset.
- */
-export declare class DashcamLive extends DashcamBase {
-    /**
-     * The type of data being stored.
-     */
-    readonly kind = DashcamMediaType.image;
-    /**
-     * Timestamp of this live camera image.
-     */
-    dts: Date;
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    toJSON(): {
-        kind: DashcamMediaType;
-        dts: string | null;
-        bytes: number | null;
-        size: import("../API/Geometry/Interfaces").ISize;
-        provider: string;
-        company: number | null;
-        asset: number | null;
-        camera: number | null;
-        latitude: number | null;
-        longitude: number | null;
-        speed: number | null;
-        heading: number | null;
-        altitude: number | null;
-    };
-    /**
-     * A combination of the asset, provider, and camera number.
-     */
-    getKey(): string;
-}

package/_publish/objects/Images/DashcamMediaType.d.ts

@@ -1,17 +0,0 @@
-/**
- * The type of dashcam data being stored.
- */
-export declare enum DashcamMediaType {
-    /**
-     * Unknown or other.
-     */
-    unknown = "unknown",
-    /**
-     * Image
-     */
-    image = "image",
-    /**
-     * Video
-     */
-    video = "video"
-}

package/_publish/objects/Images/Icon.d.ts

@@ -1,66 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { IGlobal } from "../API/Interfaces/IGlobal";
-import { IIdUlong } from "../API/Interfaces/IIdUlong";
-import { INamed } from "../API/Interfaces/INamed";
-import { JsonObject, ulong } from "../API/Types";
-import { Company } from "../Companies/Company";
-import { IconGlyph } from "./IconGlyph";
-import { IconLabel } from "./IconLabel";
-/**
- * A visual representation of a thing on a map or in a list.
- */
-export declare class Icon extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IGlobal {
-    /**
-     * Unique identifier of this icon.
-     */
-    id: ulong;
-    /**
-     * The company to which this icon belongs.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The {@link Company} to which this icon belongs.
-     */
-    get company(): Company;
-    /**
-     * A noun to describe the type of thing represented.  Like Truck, Car, Trailer, Hot-Air Balloon, etc...
-     */
-    category: string;
-    /**
-     * A specific adjective to describe the thing.  Like Blue, Red, Empty, Full, etc...
-     */
-    name: string;
-    /**
-     * Notes.
-     */
-    notes: string;
-    /**
-     * Indicates whether this icon is available to child companies.
-     */
-    global: boolean;
-    /**
-     * A list of things that this icon can be used to represent.  Like asset, place, user, etc...
-     */
-    usage: string[];
-    /**
-     * Definition for the name bubble above the icon on a map.
-     */
-    label: IconLabel;
-    /**
-     * Where the notification will appear for a mapped icon.
-     * Such as the number of dispatches an asset is working on, or the number of dispatches at a place.
-     */
-    badge: IconLabel;
-    /**
-     * The images used to show the detail of this icon.
-     */
-    glyphs: IconGlyph[];
-    toJSON(): JsonObject;
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/objects/Images/IconGlyph.d.ts

@@ -1,47 +0,0 @@
-import { IPoint, ISize } from "../API/Geometry/Interfaces";
-import { Point } from "../API/Geometry/Point";
-import { Size } from "../API/Geometry/Size";
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { codified, ushort, JsonObject } from "../API/Types";
-import { IconLayer } from "./IconLayer";
-/**
- * The image source and defined status tags which need to be applied to an asset in order to show the image.
- */
-export declare class IconGlyph implements ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): IconGlyph;
-    /**
-     * A list of codified status tag names.  Any of the tags must be applied to the asset for the image to appear.
-     */
-    tags: codified[];
-    /**
-     * Path to the image.
-     */
-    src: string;
-    /**
-     * Size of the glyph in pixels.
-     */
-    size: Size;
-    /**
-     * The offset from the lat/long in pixels.
-     */
-    anchor: Point;
-    /**
-     * The layer on which this glyph is displayed.
-     */
-    layer: IconLayer;
-    /**
-     * The z-order of this glyph compared to other glyphs on the same layer.
-     */
-    zIndex: ushort;
-    /**
-     * Indicates that this glyph rotate based on GPS bearing.
-     */
-    rotates: boolean;
-    constructor(tags?: codified[], src?: string, size?: ISize | JsonObject, anchor?: IPoint | JsonObject, layer?: IconLayer, zIndex?: ushort, rotates?: boolean);
-    toJSON(): JsonObject;
-    isEqual(other: IconGlyph): boolean;
-}

package/_publish/objects/Images/IconLabel.d.ts

@@ -1,29 +0,0 @@
-import { IPoint } from "../API/Geometry/Interfaces";
-import { Point } from "../API/Geometry/Point";
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { colour, JsonObject } from "../API/Types";
-/**
- * Definition for the name bubble above the icon on a map.
- */
-export declare class IconLabel implements ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: JsonObject): IconLabel;
-    /**
-     * The offset from the lat/long in pixels.
-     */
-    anchor: Point;
-    /**
-     * Determines which corner of the label is attached to the anchor.
-     */
-    align: string;
-    /**
-     * Background colour of the label.
-     */
-    colour: colour;
-    constructor(anchor?: IPoint | JsonObject, align?: string, colour?: colour);
-    toJSON(): JsonObject;
-    isEqual(other: IconLabel): boolean;
-}

package/_publish/objects/Images/IconLayer.d.ts

@@ -1,33 +0,0 @@
-/**
- * The layers of the map used to visualize the icon.
- */
-export declare enum IconLayer {
-    /**
-     * An SVG only layer just above the roads used for solid Places and accuracy radius fill.
-     */
-    fills = "fills",
-    /**
-     * An HTML only layer intended for use by an icon's drop-shadow.
-     */
-    shadows = "shadows",
-    /**
-     * An SVG only layer intended for use by shape and accuracy radius outlines.
-     */
-    outlines = "outlines",
-    /**
-     * An HTML only layer intended for use by an icon's main images.
-     */
-    markers = "markers",
-    /**
-     * An HTML only layer intended for use by an icon's label.
-     */
-    labels = "labels",
-    /**
-     * An SVG only layer for special drawing controls.  Icons should not use this layer.
-     */
-    drawings = "drawings",
-    /**
-     * An HTML only layer for special drawing controls.  Icons should not use this layer.
-     */
-    edits = "edits"
-}

package/_publish/objects/Images/Picture.d.ts

@@ -1,72 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-import { Rectangle } from "../API/Geometry/Rectangle";
-import { Size } from "../API/Geometry/Size";
-import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { IFileSize } from "../API/Interfaces/IFileSize";
-import { IIdUlong } from "../API/Interfaces/IIdUlong";
-import { INamed } from "../API/Interfaces/INamed";
-import { uint, ulong, JsonObject } from "../API/Types";
-import { Company } from "../Companies/Company";
-/**
- * An image stored by the system.
- */
-export declare class Picture extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IFileSize {
-    /**
-     * Unique identifier of this image.
-     */
-    id: ulong;
-    /**
-     * The company to which this image belongs.
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The {@link Company} to which this image belongs.
-     */
-    get company(): Company;
-    /**
-     * The file name of this image.
-     */
-    name: string;
-    /**
-     * Notes about this image.
-     */
-    notes: string;
-    /**
-     * The URL/path to find this image.
-     */
-    src: string;
-    /**
-     * Resolution defined in pixels.
-     */
-    size: Size;
-    /**
-     * A list of focal points in the images like faces.
-     */
-    focals: Rectangle[];
-    /**
-     * The file-size on the disk.
-     */
-    bytes: ulong;
-    /**
-     * A count of the times this image was used for something (asset, contact, task, etc).
-     */
-    uses: uint;
-    toJSON(): {
-        id: number | null;
-        v: number[];
-        company: number;
-        name: string;
-        notes: string;
-        src: string;
-        size: import("../API/Geometry/Interfaces").ISize;
-        focals: any[];
-        bytes: number | null;
-        uses: number | null;
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/objects/Maintenance/MaintenanceInterval.d.ts

@@ -1,48 +0,0 @@
-import { IBelongAsset } from "../API/Interfaces/IBelongAsset";
-import { ISerializable } from "../API/Interfaces/ISerializable";
-import { datetime, double, JsonObject, ulong } from "../API/Types";
-import { Asset } from "../Assets/Asset";
-import { MaintenanceJob } from "./MaintenanceJob";
-/**
- * The detail for calculating Maintenance Schedule recurrence.
- */
-export declare class MaintenanceInterval implements IBelongAsset, ISerializable {
-    static fromJSON(json: JsonObject): MaintenanceInterval;
-    /**
-     * The Vehicle or Trailer to which this recurrence detail belongs.
-     * {@link Asset.id}
-     */
-    assetId: ulong;
-    /**
-     * The Vehicle or Trailer to which this recurrence detail belongs.
-     */
-    get asset(): Asset;
-    /**
-     * The date of the last calculation.
-     */
-    date: Date;
-    /**
-     * The odometer at the time of the last calculation.
-     */
-    odometer: double;
-    /**
-     * The operating time at the time of the last calculation.
-     */
-    engineHours: double;
-    /**
-     * The last "completed" job related to this schedule interval.
-     */
-    lastJobId: ulong;
-    /**
-     * The last "completed" job related to this schedule interval.
-     */
-    get lastJob(): MaintenanceJob;
-    constructor(asset?: ulong, date?: Date | number | datetime, odometer?: double, engineHours?: double, lastJob?: ulong);
-    toJSON(): {
-        asset: number | null;
-        date: string | null;
-        odometer: number;
-        engineHours: number;
-        lastJob: number | null;
-    };
-}

package/_publish/objects/Maintenance/MaintenanceJob.d.ts

@@ -1,134 +0,0 @@
-import { BaseComponent } from "../API/BaseComponent";
-import { IBelongAsset } from "../API/Interfaces/IBelongAsset";
-import { IBelongCompany } from "../API/Interfaces/IBelongCompany";
-import { IIdUlong } from "../API/Interfaces/IIdUlong";
-import { INamed } from "../API/Interfaces/INamed";
-import { IPictured } from "../API/Interfaces/IPictured";
-import { TimeSpan } from "../API/TimeSpan";
-import { double, JsonObject, ulong } from "../API/Types";
-import { Asset } from "../Assets/Asset";
-import { Company } from "../Companies/Company";
-import { Picture } from "../Images/Picture";
-import { MaintenanceJobStatus } from "./MaintenanceJobStatus";
-import { MaintenanceSchedule } from "./MaintenanceSchedule";
-/**
- * Historical service work performed on a Vehicle or Trailer
- */
-export declare class MaintenanceJob extends BaseComponent implements IIdUlong, INamed, IBelongCompany, IBelongAsset, IPictured {
-    /**
-     * Unique identifier
-     */
-    id: ulong;
-    /**
-     * The Vehicle or Trailer to which this job belongs
-     * {@link Asset.id}
-     */
-    assetId: ulong;
-    /**
-     * The Vehicle or Trailer to which this job belongs
-     */
-    get asset(): Asset;
-    /**
-     * The company to which this Vehicle or Trailer belongs
-     * {@link Company.id}
-     */
-    companyId: ulong;
-    /**
-     * The {@link Company} to which this Vehicle or Trailer belongs
-     */
-    get company(): Company;
-    /**
-     * The Maintenance Schedule from which this job was created
-     * {@link MaintenanceSchedule.id}
-     */
-    scheduleId: ulong;
-    /**
-     * The Maintenance Schedule from which this job was created
-     * {@link MaintenanceSchedule.id}
-     */
-    get schedule(): MaintenanceSchedule;
-    set schedule(value: MaintenanceSchedule);
-    /**
-     * The work being done. Like "oil change".
-     */
-    name: string;
-    /**
-     * Notes about the job.  Like "changed the oil and filter".
-     */
-    notes: string;
-    /**
-     * The status of this job.
-     */
-    status: MaintenanceJobStatus;
-    /**
-     * When was this job created.
-     */
-    created: Date;
-    /**
-     * When was this job created.
-     */
-    completed: Date;
-    /**
-     * The odometer at the time of the service.
-     */
-    odometer: double;
-    /**
-     * The operating time at the time of the service.
-     */
-    engineHours: double;
-    /**
-     * The name of the garage or service facility where the work is done.
-     */
-    garage: string;
-    /**
-     * Time it took to complete the job.
-     */
-    duration: TimeSpan;
-    /**
-     * How much the job cost in dollars.
-     */
-    cost: double;
-    /**
-     * A reference code used to track this job
-     */
-    reference: string;
-    /**
-     * The mechanic who performed the work.
-     */
-    technician: string;
-    /**
-     * Images taken while performing the work for reference.
-     * {@link Picture.id}
-     */
-    pictureIds: ulong[];
-    /**
-     * {@link Picture}s taken while performing the work for reference.
-     */
-    get pictures(): Picture[];
-    set pictures(values: Picture[]);
-    toJSON(): {
-        id: number | null;
-        v: number[];
-        company: number;
-        asset: number;
-        schedule: number;
-        name: string;
-        notes: string;
-        status: MaintenanceJobStatus;
-        created: string | null;
-        completed: string | null;
-        odometer: number;
-        engineHours: number;
-        garage: string;
-        cost: number;
-        duration: string;
-        reference: string;
-        technician: string;
-        pictures: number[];
-    };
-    fromJSON(json: JsonObject, force?: boolean): boolean;
-    /**
-     * The {@link id} is the key.
-     */
-    getKey(): number;
-}

package/_publish/objects/Maintenance/MaintenanceJobStatus.d.ts

@@ -1,21 +0,0 @@
-/**
- * The lifetime of a Maintenance Job
- */
-export declare enum MaintenanceJobStatus {
-    /**
-     * The work will need to be performed soon.
-     */
-    pending = "pending",
-    /**
-     * The work was scheduled, but not yet done.
-     */
-    pastdue = "pastdue",
-    /**
-     * Work is completed.
-     */
-    completed = "completed",
-    /**
-     * The job was cancelled or was not necessary.
-     */
-    cancelled = "cancelled"
-}