@evercam/api 1.0.0-003a1ed80

package/dist/api/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/api/types/sso.d.ts

@@ -0,0 +1,55 @@
+export type SsoProvider = {
+    id: number;
+    name: string;
+    exid: string;
+    clientId: string;
+    clientSecret: string;
+    scope: string;
+    responseType: string;
+    loginUrl: string;
+    iconUrl: string;
+    options: {
+        showOnLogin: boolean;
+        showOnSignup: boolean;
+    };
+    tokenUri: string;
+    tokenIntrospectionUri: string;
+    userInfoUri: string;
+    enabled: boolean;
+};
+export type SsoUpdatePayload = {
+    name: string;
+    exid: string;
+    clientId: string;
+    clientSecret: string;
+    scope: string;
+    responseType: string;
+    loginUrl: string;
+    iconUrl: string;
+    options: {
+        showOnLogin: boolean;
+        showOnSignup: boolean;
+    };
+    tokenUri: string;
+    tokenIntrospectionUri: string;
+    userInfoUri: string;
+    enabled: boolean;
+};
+export type SsoCreatePayload = {
+    name: string;
+    exid: string;
+    clientId: string;
+    clientSecret: string;
+    scope: string;
+    responseType: string;
+    loginUrl: string;
+    iconUrl: string;
+    options: {
+        showOnLogin: boolean;
+        showOnSignup: boolean;
+    };
+    tokenUri: string;
+    tokenIntrospectionUri: string;
+    userInfoUri: string;
+    enabled: boolean;
+};

package/dist/api/types/storageServers.d.ts

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

package/dist/api/types/streaming.d.ts

@@ -0,0 +1,97 @@
+import { DateTime_Z_micros, KitMetricData } from "@/types";
+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 {
+    Available = "Available",
+    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/api/types/systemCheck.d.ts

@@ -0,0 +1,11 @@
+export declare enum PerformanceStatus {
+    Pending = "pending",
+    Done = "done"
+}
+export declare enum WebGLExtensions {
+    OESTextureFloat = "OES_texture_float",
+    EXTFloatBlend = "EXT_float_blend",
+    EXTTextureFilterAnisotropic = "EXT_texture_filter_anisotropic",
+    OESElementIndexUint = "OES_element_index_uint",
+    WEBGLDebugRendererInfo = "WEBGL_debug_renderer_info"
+}

package/dist/api/types/tag.d.ts

@@ -0,0 +1,12 @@
+import { Kit } from "@/types/kit";
+export type Tag<T = string> = {
+    id?: number;
+    name: T;
+    description?: string;
+    createdAt?: string;
+    updatedAt?: string;
+};
+export type KitTag = {
+    kit: Kit;
+    tag: Tag;
+};

package/dist/api/types/time.d.ts

@@ -0,0 +1,21 @@
+import { Moment } from "moment-timezone";
+export type DateType = Date | string | number;
+export type ExtendedDateType = Moment | DateType;
+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/api/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
+}

package/dist/api/types/user.d.ts

@@ -0,0 +1,271 @@
+import type { DateTime, PaginationParams } from "@/types";
+export type User = {
+    id?: number;
+    fullname?: string;
+    firstname: string;
+    lastname: string;
+    email: string;
+    telephone: string;
+    country: string;
+    isAdmin: boolean;
+    persona: Persona;
+    companyId?: string;
+    companyName?: string;
+    companyExid?: string;
+    features?: Array<UserFeatureFlag>;
+};
+export type AdminUser = {
+    id: number;
+    fullname: string;
+    firstname: string;
+    email: string;
+    telephone: string;
+    country: string;
+    isAdmin: boolean;
+    companyId: string;
+    companyName: string;
+    companyExid: string;
+    features: Array<UserFeatureFlag>;
+    active: boolean;
+    cameraShares: number;
+    camerasCount: number;
+    camerasOwned: number;
+    countryId: number;
+    countryName: string;
+    createdAt: DateTime;
+    integrations: string[];
+    lastSeenAt: DateTime;
+    lastLoginAt: string;
+    lastname: string;
+    persona: string;
+    projects: string[];
+    projectsCount: number;
+    referralUrl?: string;
+    snapmailCount: number;
+    zohoId: string;
+};
+export declare enum UserFeatureFlag {
+    CompanyAdmin = "company-admin",
+    VideoWalls = "video-walls",
+    MassCameraSharing = "mass-camera-sharing",
+    Copilot = "copilot",
+    ProjectSharing = "project-sharing"
+}
+export type ProjectUser = User & {
+    lastSeenAt: string;
+    active: boolean;
+    activeOneMonth: boolean;
+    eventsCount: string;
+    cameraExid: string;
+    cameraRights: string;
+};
+export declare enum Persona {
+    HQ = "HQ",
+    PM = "PM",
+    QS = "QS",
+    Marketing = "Marketing",
+    HS = "H&S",
+    DI = "DI",
+    Other = "Other"
+}
+export type UpdatePasswordRequestPayload = {
+    token: string;
+    password: string;
+};
+export type Credentials = {
+    apiKey: string;
+    apiId: string;
+};
+export type LoginRequestPayload = {
+    username: string;
+    password: string;
+    redirectToZoho?: boolean;
+};
+export type RemotePasswordUpdateRequestPayload = {
+    currentPassword: string;
+    newPassword: string;
+};
+export type LoginResponsePayload = {
+    confirmedAt?: string;
+    country?: string;
+    createdAt?: string;
+    email?: string;
+    firstname?: string;
+    id?: string;
+    isAdmin?: boolean;
+    lastLoginAt?: string;
+    lastname?: string;
+    persona?: Persona;
+    telephone?: string;
+    token?: string;
+    updatedAt?: string;
+    evercamAccount?: string;
+};
+export type LogoutParams = {
+    token: string;
+    fromAdmin?: boolean;
+};
+export type UserSession = {
+    browser: string;
+    createdAt: string;
+    id: number;
+    ipAddress: string;
+    isCurrent: boolean;
+    lastUsedAt: string;
+    os: string;
+};
+export type SessionsListRequestPayload = {
+    authorization: string;
+    browser?: string;
+    os?: string;
+    ipAddress?: string;
+    sort: string;
+    limit: number;
+    page: number;
+};
+export type SessionActivityCamSettingsDetail = {
+    new: any;
+    old: any;
+};
+export type SessionActivityDetail = {
+    agent: string;
+    camSettings: SessionActivityCamSettingsDetail;
+    country: string;
+    countryCode: string;
+    ip: string;
+};
+export type SessionActivity = {
+    cameraExid: string;
+    details: SessionActivityDetail;
+    insertedAt: string;
+    type: string;
+    who: string;
+};
+export type SessionActivitiesListRequestPayload = {
+    limit: number;
+    from: string;
+    to: string;
+};
+export type SignupUserRequestPayload = {
+    telephone: string;
+    token: string;
+    firstname: string;
+    lastname: string;
+    email: string;
+    password: string;
+    shareRequestKey: string;
+    referralUrl: string;
+    persona: string;
+    disablePassword: boolean;
+};
+export type UserUpdateRequestPayload = {
+    firstname: string;
+    lastname: string;
+    email: string;
+    telephone: string;
+    country: string;
+    persona: string;
+};
+export type UserDeleteRequestPayload = {
+    verifEmail: string;
+};
+export type GoogleAuthRequestPayload = {
+    code: string;
+    redirectUri: string;
+};
+export type UserStatsResponse = {
+    data: {
+        userStats: AdminUser;
+    };
+};
+export type UserCamera = {
+    id: number;
+    exid: string;
+    ownerFullname: string;
+    ownerEmail: string;
+    apiId: string;
+    apiKey: string;
+};
+export type UserCameraResponse = {
+    data: UserCamera[];
+};
+export type UserProject = {
+    id: number;
+    exid: string;
+    name: string;
+    startedAt: DateTime;
+};
+export type UserProjectResponse = {
+    data: UserProject[];
+};
+export type AdminUserUpdateRequestPayload = {
+    companyId: string;
+    email: string;
+    persona: Persona;
+    country: string;
+    features: UserFeatureFlag[];
+};
+export type AdminQueryParams = PaginationParams & {
+    email: string;
+    fullname: string;
+};
+export type Admin = {
+    id: number;
+    fullname: string;
+    email: string;
+    createdAt: DateTime;
+    updatedAt: DateTime;
+    lastSignInAt: DateTime;
+    signInCount: number;
+    lastSignInIp: string;
+    apiId: string;
+    apiKey: string;
+};
+export type ImpersonateUserResponse = {
+    id: string;
+    firstname: string;
+    lastname: string;
+    telephone: string;
+    email: string;
+    is_admin: boolean;
+    persona: Persona;
+    country: string;
+    companyId: number;
+    companyExid: string;
+    companyName: string;
+    evercamAccount: boolean;
+    createdAt: DateTime;
+    updatedAt: DateTime;
+    confirmedAt: DateTime;
+    last_loginAt: DateTime;
+    features: UserFeatureFlag[];
+    token: string;
+};
+export type AdminUserQueryParams = PaginationParams & {
+    fullname: string;
+    email: string;
+    telephone: string;
+    persona: Persona;
+    companyName: string;
+    camerasCount: string;
+    projectsCount: string;
+    snapmailCount: string;
+    camerasOwned: string;
+    cameraShares: string;
+    createdAtDate: string;
+    lastLoginAtDate: string;
+    integrations: "procore" | "aconex" | "autodesk";
+    features: UserFeatureFlag.ProjectSharing | UserFeatureFlag.VideoWalls;
+};
+export type SuppressionsQueryParams = PaginationParams & {
+    id: number;
+    email: string;
+    source: string;
+};
+export type Suppression = {
+    id: number;
+    email: string;
+    source: string;
+    insertedAt: DateTime;
+    updatedAt: DateTime;
+};

package/dist/api/types/vendorModel.d.ts

@@ -0,0 +1,15 @@
+export type VendorModel = {
+    cameraCount: number;
+    exid: string;
+    h264Url: string;
+    jpgUrl: string;
+    name: string;
+    online: number;
+    playbackUrl: string;
+};
+export type VendorModelRequestPayload = {
+    sort: string;
+};
+export type VendorModelResponsePayload = {
+    data: VendorModel[];
+};

package/dist/api/types/videoWall.d.ts

@@ -0,0 +1,33 @@
+import { Camera, Media } from "@/types";
+export declare enum VideoWallItemType {
+    LiveView = "live",
+    Video = "video",
+    Image = "image"
+}
+export type VideoWallItem<T extends Camera | Media> = {
+    value: T;
+    type: VideoWallItemType;
+};
+export type VideoWallPresetItemConfig = {
+    camera: Camera;
+    h: number;
+    i: string | number;
+    moved: boolean;
+    w: number;
+    x: number;
+    y: number;
+};
+export type VideoWallPreset = {
+    name?: string;
+    configuration: Array<VideoWallPresetItemConfig>;
+};
+export type VideoWallPresetItem = {
+    i: string | number;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    camera: Camera;
+    weather?: Record<string, unknown>;
+    media?: Media;
+};

package/dist/api/types/voyageControl.d.ts

@@ -0,0 +1,6 @@
+export type VoyageControlConnectorPayload = {
+    email: string;
+    venue: string;
+    apiKey: string;
+    projectExid: string;
+};