@evercam/api 1.0.0-0261f7ecb

package/dist/types/shares.d.ts

@@ -0,0 +1,192 @@
+import type { CameraExid, DateTime, DateType } from "@/types";
+export type ShareRequest = {
+    cameraId: string;
+    createdAt: DateType | number;
+    email: string;
+    id: number;
+    rights: string;
+    sharerEmail: string;
+    sharerName: string;
+    userId: number;
+};
+export type Share = {
+    cameraId: string;
+    createdAt: DateType | number;
+    email: string;
+    fullname: string;
+    id: number;
+    lastSeenAt: DateType;
+    rights: string;
+    sessionCount: number;
+    sharerEmail: string;
+    sharerId: number;
+    sharerName: string;
+    userId: number;
+};
+export type ShareRequestsResponsePayload = {
+    shareRequests: ShareRequest[];
+};
+export type ShareOwner = {
+    email: string;
+    fullname: string;
+    lastSeenAt: DateType;
+    sessionCount: number;
+};
+export type SharesResponsePayload = {
+    owner: ShareOwner;
+    shares: Share[];
+};
+export type ShareDeletionRequestPayload = {
+    email?: string;
+    key?: string;
+    origin?: string;
+};
+export type SharedUsersResponsePayload = Array<{
+    email: string;
+    name: string;
+}>;
+export type ShareCreateRequestPayload = {
+    email: string[] | string;
+    message?: string;
+    permission?: string;
+    rights: string;
+    apiId?: string;
+    apiKey?: string;
+};
+export type ShareProjectCamerasRequestPayload = {
+    email: string[];
+    cameraExids: CameraExid[];
+    message: string;
+    permission?: string;
+    rights: string;
+};
+export type ShareCreateResponsePayload = {
+    shares: Share[];
+    shareRequests: ShareRequest[];
+};
+export type ShareRequestByKeyResponsePayload = {
+    shareRequests: Array<{
+        id: string;
+        email: string;
+        rights: string;
+        cameraId: string;
+        sharerName: string;
+        userId: string;
+        sharerEmail: string;
+        createdAt: DateType;
+    }>;
+};
+export type ResendShareRequestPayload = {
+    email: string;
+    apiId?: string;
+    apiKey?: string;
+};
+export declare enum SharePermission {
+    Minimum = "minimum",
+    Share = "minimal+share",
+    Full = "full",
+    Custom = "custom"
+}
+export declare enum ShareType {
+    Share = "share",
+    Request = "request"
+}
+export declare enum ShareRequestStatus {
+    All = "",
+    Pending = -1,
+    Cancelled = -2,
+    Failed = -3,
+    Used = 1
+}
+export declare enum ShareVisibility {
+    PublicDiscoverable = "publicDiscoverable",
+    PublicUndiscoverable = "publicUndiscoverable",
+    Private = "private"
+}
+export type ProjectShare = {
+    id: number;
+    projectId: string;
+    userId: number;
+    email: string;
+    fullname: string;
+    sharerId: number;
+    sharerEmail: string;
+    sharerName: string;
+    role: "member" | "admin";
+    cameras: Record<string, string>;
+    message: string | null;
+    updatedAt: DateType;
+    insertedAt: DateType;
+};
+export type ProjectShareRequest = ProjectShare;
+export type ProjectShareResponse = {
+    projectShares: ProjectShare[];
+    projectShareRequests: ProjectShareRequest[];
+};
+export type AdminShare = {
+    sharerId: number;
+    sharerFullname: string;
+    sharerApiId: string;
+    sharerApiKey: string;
+    shareeId: number;
+    shareeFullname: string;
+    shareeApiId: string;
+    shareeApiKey: string;
+    shareeEmail: string;
+    cameraId: number;
+    exid: string;
+    projectId: string;
+    name: string;
+    id: number;
+    message: string;
+    createdAt: DateType;
+};
+export type CameraShareRequestPayload = {
+    email: string[];
+    rights: string;
+    message?: string;
+};
+export type ShareQueryParams = {
+    exid: string;
+    sharerFullname: string;
+    shareeFullname: string;
+    shareeEmail: string;
+};
+export type CameraShare = {
+    sharerId: number;
+    sharerFullname: string;
+    sharerApiId: string;
+    sharerApiKey: string;
+    shareeId: number;
+    shareeFullname: string;
+    shareeApiId: string;
+    shareeApiKey: string;
+    shareeEmail: string;
+    cameraId: number;
+    exid: string;
+    projectId: string;
+    name: string;
+    id: number;
+    message: string;
+    createdAt: DateTime;
+};
+export type CameraShareRequestsQueryParams = {
+    shareeEmail: string;
+    camera: string;
+    sharer: string;
+    status: string;
+};
+export type CameraShareRequest = {
+    id: number;
+    shareeEmail: string;
+    camera: string;
+    sharer: string;
+    message: number;
+    rights: string;
+    status: number;
+    projectId: string;
+    cameraExid: string;
+    apiId: string;
+    apiKey: number;
+    createdAt: DateTime;
+};

package/dist/types/sim.d.ts

@@ -0,0 +1,114 @@
+import { DateTime, PaginationParams } from "@/types";
+export declare enum SmsCommands {
+    Cellular = "cellular",
+    Gpson = "gpson",
+    GPS = "gps",
+    IPUnblock = "ipunblock",
+    IOStatus = "iostatus",
+    IOSet = "ioset",
+    MonitoringStatus = "monitoring_status",
+    MobileOn = "mobileon",
+    MobileOff = "mobileoff",
+    Reboot = "reboot",
+    Restore = "restore",
+    RmsOn = "rms_on",
+    RmsConnect = "rms_connect",
+    RmsStatus = "rms_status",
+    SwitchSIM = "switch_sim",
+    Status = "status",
+    SshOn = "sshon",
+    SshOff = "sshoff",
+    Uci = "uci",
+    VpnOn = "vpnon",
+    VpnOff = "vpnoff",
+    VpnStatus = "vpnstatus",
+    WifiOn = "wifion",
+    WifiOff = "wifioff",
+    Wakeup = "wakeup",
+    WebOn = "webon",
+    WebOff = "weboff"
+}
+export declare enum SmsStatuses {
+    Delivered = "Delivered",
+    Accepted = "accepted",
+    Pending = "Pending"
+}
+export type SimCreateUpdatePayload = {
+    number: string;
+    simProvider: string;
+    billPayer?: string;
+    pin1?: string;
+    pin2?: string;
+    puk?: string;
+    iccid?: string;
+    description?: string;
+    cameraId: string[];
+};
+export type SimsQueryParams = PaginationParams & {
+    simProvider: string;
+    number: string;
+    billPayer: string;
+    iccid: string;
+    cameraName: string;
+    description: string;
+};
+export type Sim = {
+    id: number;
+    number: string;
+    simProvider: string;
+    billPayer: string;
+    lastSms: string;
+    pin1: string;
+    pin2: string;
+    puk: string;
+    iccid: string;
+    description: string;
+    lastSmsAt: DateTime;
+    cameras: {
+        name: string;
+        exid: string;
+        id: number;
+    }[];
+};
+export type SendSmsPayload = {
+    number: string;
+    smsMessage: string;
+};
+export type SendSmsResponse = {
+    status: number;
+    errorText: string;
+};
+export type SmsHistory = {
+    insertedAt: DateTime;
+    type: string;
+    status: string;
+    text: string;
+    deliveryDatetime: DateTime;
+};
+export type SmsHistoryResponse = {
+    singleSimSms: SmsHistory[];
+};
+export type Sms = {
+    id: number;
+    from: string;
+    fromName: string;
+    to: string;
+    toName: string;
+    messageId: string;
+    status: string;
+    text: string;
+    type: string;
+    insertedAt: DateTime;
+    deliveryDatetime: DateTime;
+};
+export type SmsQueryParams = PaginationParams & {
+    dateRange: string;
+    fromName: string;
+    toName: string;
+    fromNumber: string;
+    toNumber: string;
+    smsText: string;
+    smsType: string;
+    smsStatus: SmsStatuses;
+    deliveryDatetime: string;
+};

package/dist/types/siteAnalytics.d.ts

@@ -0,0 +1,84 @@
+import type { BBox, BoundingBox, DetectionLabel } from "@evercam/api/types";
+export declare enum SiteAnalyticsMode {
+    Detections = "detections",
+    Segments = "segments"
+}
+export type SmartSearchOptionData = {
+    id?: string;
+    type: SmartSearchQueryComponentType;
+    value: DetectionLabel | SmartSearchOperatorType | SmartSearchConditionData;
+};
+export type SmartSearchQueryPart = SmartSearchOptionData | SmartSearchQueryPart[];
+export declare enum SmartSearchQueryComponentType {
+    Condition = "condition",
+    Object = "object",
+    Area = "in_area",
+    Time = "time",
+    Operator = "operator"
+}
+export type SmartSearchQueryComponentData = {
+    id: string;
+    type: SmartSearchQueryComponentType;
+    parts: SmartSearchQueryPart[];
+};
+export declare enum SmartSearchCondition {
+    InArea = "in_area",
+    Intersects = "intersects",
+    Time = "time"
+}
+export type SmartSearchConditionData = {
+    condition: SmartSearchCondition;
+    value: string | BoundingBox | DetectionLabel | Date;
+};
+export type SmartSearchQuery = {
+    returnTargets: SmartSearchQueryTargets[];
+    rulesLogic: SmartSearchOperatorType;
+    rules: {
+        logic: SmartSearchOperatorType;
+        conditions: {
+            type: SmartSearchQueryConditionTypes;
+            target: SmartSearchQueryTargets;
+            operator?: SmartSearchQueryOperators;
+            attribute?: string;
+            value: string | number | string[];
+            reference?: {
+                target: SmartSearchQueryTargets;
+                attribute: string;
+                value: string | number | string[];
+            };
+            polygon?: BBox;
+        }[];
+    }[];
+    returnType: SmartSearchQueryReturnType;
+};
+export declare enum SmartSearchQueryTargets {
+    Tracking = "tracking",
+    Segments = "segments"
+}
+export declare enum SmartSearchQueryReturnType {
+    All = "all",
+    FirstLastSeen = "first_last_seen"
+}
+export declare enum SmartSearchOperatorType {
+    And = "AND",
+    Or = "OR"
+}
+export declare enum SmartSearchQueryOperators {
+    Near = "near",
+    Far = "far",
+    Intersects = "intersects",
+    DoesNotIntersect = "does_not_intersect",
+    Inside = "inside",
+    Outside = "outside",
+    DistanceBelow = "distance_below",
+    DistanceAbove = "distance_above",
+    Area = "in_area"
+}
+export declare enum SmartSearchQueryConditionTypes {
+    Selection = "selection",
+    Spatial = "spatial",
+    Area = "area",
+    Iou = "iou",
+    Near = "near",
+    Far = "far"
+}

package/dist/types/snapshots.d.ts

@@ -0,0 +1,50 @@
+import { CameraExid, DateType, PaginationParams, Schedule } from "@/types";
+export type SnapshotExtractionQyeryParams = PaginationParams & {
+    camera: string;
+    cameraExid: CameraExid;
+    status: SnapshotExtractionStatus;
+};
+export declare enum SnapshotExtractionStatus {
+    Completed = "completed",
+    Failed = "failed",
+    Processing = "processing"
+}
+export declare enum SnapshotExtractionType {
+    Cloud = "cloud",
+    Local = "local",
+    Timelapse = "timelapse"
+}
+export type SnapshotExtraction = {
+    id: number;
+    cameraId: number;
+    cameraExid: CameraExid;
+    cameraName: string;
+    fromDate: DateType;
+    toDate: DateType;
+    type: SnapshotExtractionType;
+    notes: string;
+    status: SnapshotExtractionStatus;
+    interval: number;
+    requestor: string;
+    jpegsToDropbox: boolean;
+    injectTo_cr: Boolean;
+    schedule: Schedule;
+    created_at: DateType;
+};
+export type SnapshotTestPayload = {
+    cameraExid?: CameraExid;
+    camUsername: string;
+    camPassword: string;
+    externalUrl: string;
+    jpgUrl: string;
+};
+export type SnapshotTestResponse = {
+    status: string;
+    data: string;
+};
+export type DeleteSnapshotQueryParams = {
+    fromDate: DateType;
+    toDate: DateType;
+    adminEmail: string;
+    adminFullname: string;
+};

package/dist/types/storageServers.d.ts

@@ -0,0 +1,4 @@
+export type StorageServer = string;
+export type StorageServersResponsePayload = {
+    servers: StorageServer[];
+};

package/dist/types/streaming.d.ts

@@ -0,0 +1,118 @@
+import { MilesightCameraNetworkConfiguration, MilesightCameraOsdConfiguration, MilesightCameraSdCardInfo, MilesightCameraSystemSettings, MilesightCameraTimeInfo, MilesightCameraVideoConfig, TaskStatus, DateTime_Z_micros, KitMetricData } from "@/types";
+export declare enum ExNvrHealthCheckTaskId {
+    ExNvrLogin = "exNvrLogin",
+    ExNvrConfigCheck = "exNvrGetDeviceInfo",
+    ExNvrSystemStatus = "exNvrSystemStatus",
+    ExNvrRecordings = "exNvrGetRecordings",
+    CameraSystemConfigCheck = "getCameraSystemInfo",
+    CameraTimeConfigCheck = "getCameraTimeInfo",
+    CameraStreamsConfigCheck = "getCameraStreamsInfo",
+    CameraNetworkConfigCheck = "getCameraNetworkInfo",
+    CameraOsdConfigCheck = "getCameraOsdInfo",
+    CameraStorageConfigCheck = "getCameraStorageInfo"
+}
+export type ExNvrHealthCheckTaskResult<T extends ExNvrHealthCheckTaskId> = T extends ExNvrHealthCheckTaskId.ExNvrLogin ? ExNvrLoginResponse : T extends ExNvrHealthCheckTaskId.ExNvrConfigCheck ? ExNvrDeviceConfig : T extends ExNvrHealthCheckTaskId.ExNvrSystemStatus ? ExNvrSystemStatus : T extends ExNvrHealthCheckTaskId.ExNvrRecordings ? ExNvrRecordingInterval[] : T extends ExNvrHealthCheckTaskId.CameraStreamsConfigCheck ? MilesightCameraVideoConfig : T extends ExNvrHealthCheckTaskId.CameraSystemConfigCheck ? MilesightCameraSystemSettings : T extends ExNvrHealthCheckTaskId.CameraTimeConfigCheck ? MilesightCameraTimeInfo : T extends ExNvrHealthCheckTaskId.CameraNetworkConfigCheck ? MilesightCameraNetworkConfiguration : T extends ExNvrHealthCheckTaskId.CameraOsdConfigCheck ? MilesightCameraOsdConfiguration : T extends ExNvrHealthCheckTaskId.CameraStorageConfigCheck ? MilesightCameraSdCardInfo : never;
+export type ExNvrHealthCheckTask<T extends ExNvrHealthCheckTaskId> = {
+    id: T;
+    status: TaskStatus;
+    duration?: number;
+    result?: ExNvrHealthCheckTaskResult<T>;
+    error?: Error;
+};
+export type ExNvrLoginResponse = {
+    accessToken: string;
+};
+export type ExNvrRecordingInterval = {
+    active: boolean;
+    startDate: DateTime_Z_micros;
+    endDate: DateTime_Z_micros;
+};
+export type ExNvrDeviceConfig = {
+    id: string;
+    name: string;
+    type: string;
+    state: ExNvrDeviceState;
+    credentials: {
+        password: string;
+        username: string;
+    };
+    mac: string;
+    url: string;
+    insertedAt: string;
+    updatedAt: string;
+    settings: {
+        storageAddress: string;
+        overrideOnFullDisk: boolean;
+        overrideOnFullDiskThreshold: number;
+        generateBif: boolean;
+    };
+    vendor: string;
+    model: string;
+    streamConfig: {
+        filename: string | null;
+        duration: string | null;
+        temporaryPath: string | null;
+        snapshotUri: string;
+        streamUri: string;
+        subStreamUri: string;
+    };
+    timezone: string;
+};
+export declare enum ExNvrFootageAvailableStatus {
+    Active = "Active",
+    NotActive = "Not Active",
+    NotAvailable = "Not Available"
+}
+export declare enum ExNvrDeviceState {
+    Recording = "recording",
+    Failed = "failed",
+    Stopped = "stopped"
+}
+export type ExNvrCpuStatus = {
+    load: number[];
+    numCores: number;
+};
+export type ExNvrMemoryStatus = {
+    systemTotalMemory: number;
+    freeMemory: number;
+    totalMemory: number;
+    bufferedMemory: number;
+    cachedMemory: number;
+    totalSwap: number;
+    freeSwap: number;
+    availableMemory: number;
+};
+export type ExNvrSolarChargerStatus = {
+    v: number;
+    vpv: number;
+    ppv: number;
+    i: number;
+    il: number;
+    load: string;
+    relayState: string;
+    offReason: number;
+    h19: number;
+    h20: number;
+    h21: number;
+    h22: number;
+    h23: number;
+    err: number;
+    cs: string;
+    fw: string;
+    pid: string;
+    serialNumber: string;
+};
+export type ExNvrSystemStatus = {
+    version: string;
+    cpu: ExNvrCpuStatus;
+    memory: ExNvrMemoryStatus;
+    solarCharger: ExNvrSolarChargerStatus;
+};
+export declare enum ExNvrMetricId {
+    CpuLoad = "cpu_load",
+    RamUsage = "ram_usage"
+}
+export type ExNvrMetric = KitMetricData & {
+    metricId: ExNvrMetricId;
+    value: number;
+};

package/dist/types/time.d.ts

@@ -0,0 +1,19 @@
+export type DateType = Date | string | number;
+type YYYY = number;
+type MM = number;
+type DD = number;
+type HH = number;
+type mm = number;
+type ss = number;
+type microS = number;
+export type Date_YYYY = `${YYYY}` | string;
+export type Date_YYYY_MM = `${YYYY}-${MM}` | string;
+export type Date_YYYY_MM_DD = `${YYYY}-${MM}-${DD}` | string;
+export type Time_HH_mm_ss = `${HH}:${mm}:${ss}` | string;
+export type Date_HH = `${HH}` | string;
+export type DateTime = `${Date_YYYY_MM_DD}T${Time_HH_mm_ss}` | string;
+export type DateTime_tz = `${Date_YYYY_MM_DD}T${Time_HH_mm_ss}${"+" | "-"}${HH}:${mm}` | string;
+export type DateTime_Z = `${Date_YYYY_MM_DD}T${Time_HH_mm_ss}Z` | string;
+export type DateTime_Z_micros = `${Date_YYYY_MM_DD}T${Time_HH_mm_ss}.${microS}Z` | string;
+export type DateTimeSpaceSeparated = `${Date_YYYY_MM_DD} ${Time_HH_mm_ss}` | string;
+export {};

package/dist/types/timelapse.d.ts

@@ -0,0 +1,99 @@
+import { DateType, Schedule } from "@/types";
+export declare enum TimelapseStatus {
+    Pending = 11,
+    Completed = 5,
+    Failed = 7
+}
+export declare enum TimelapseDuration {
+    ThirtySeconds = 30,
+    SixtySeconds = 60,
+    NintySeconds = 90
+}
+export type TimelapseVideoOptions = {
+    width?: number;
+    height?: number;
+    removeTimestamp: boolean;
+    smoothTransition: boolean;
+    evercamWatermark: boolean;
+    timestampPosition?: TimestampPositionCoordinates;
+};
+export type TimestampPositionCoordinates = {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+};
+export type TimelapseLogoOptions = {
+    id: number;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+export type TimelapseSchedules = string | Schedule;
+export declare enum TimelapseScheduleType {
+    Continuous = "continuous",
+    WorkingHours = "workingHours",
+    Custom = "custom"
+}
+export declare enum TimelapsePeriod {
+    Day = 1,
+    Week = 7,
+    Month = 30,
+    WholeProject = "whole_project",
+    Custom = "custom"
+}
+export declare enum TimelapseType {
+    Hour = "hour",
+    Day = "day",
+    Week = "week",
+    Month = "month",
+    Year = "year",
+    FullProject = "full_project"
+}
+export type TimelapseFilterQueryParams = {
+    from?: DateType;
+    to?: DateType;
+    period?: TimelapsePeriod;
+    duration?: number;
+    schedule?: TimelapseSchedules;
+};
+export type TimelapseCreationRequestPayload = {
+    title: string;
+    duration: number;
+    fromDatetime: string;
+    toDatetime: string;
+    cameraExid: string;
+    schedule: Schedule;
+    videoOptions: TimelapseVideoOptions;
+    logo?: TimelapseLogoOptions;
+};
+export type TimelapseCreationResponsePayload = {
+    Timelapse: {
+        camera: string;
+        createdAt: string;
+        fromDate: string;
+        id: number;
+        duration: number;
+        requestor: string;
+        schedule: Schedule;
+        status: number;
+        toDate: string;
+        updatedAt: string;
+    };
+};
+export type TimelapseSnapshotRequestPayload = {
+    from: string;
+    to: string;
+    schedule: string;
+    count: number;
+};
+export type TimelapseSnapshotResponsePayload = {
+    snapshots: string[];
+};
+export declare enum TimelapseExportStep {
+    Format = 1,
+    Effects = 2,
+    Confirm = 3,
+    Finish = 4
+}