@evercam/api 1.0.0-ae97ae0a0 → 1.0.0-api-fixes-7de7fc3dd

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

@@ -1,4 +1,4 @@
-import { CameraExid, CountryCode, CountryId, DateType, Nvr, PaginationParams, PowerType, Project, Router, Schedule, Tag } from "@evercam/api/types";
+import { CountryCode, CountryId, DateType, Nvr, PaginationParams, PowerType, Project, Router, Schedule, Tag } from "@evercam/api/types";
 export type Kit = {
     alarms: KitAlarm[];
     countryCode: CountryCode;
@@ -307,10 +307,16 @@ export type KitCreatePayload = {
 };
 export type KitMetricStatsEntry = {
     timestamp: string;
-    voltage: number;
-    current: number;
-    panelVoltage: number;
-    panelPower: number;
+    voltage?: number;
+    current?: number;
+    panelVoltage?: number;
+    panelPower?: number;
+    yieldTotal?: number;
+    yieldToday?: number;
+    yieldYesterday?: number;
+    maxPowerToday?: number;
+    maxPowerYesterday?: number;
+    stateOfCharge?: number;
 };
 export type KitUpdatePayload = {
     countryId: number;
@@ -332,12 +338,8 @@ export type KitStorage = {
     serial: string;
     status: string;
     type: string;
-    metadata: {
-        formFactor: string;
-    };
+    metadata: Record<string, string>;
     model: string;
-    insertedAt: string;
-    updatedAt: string;
     vendor: string;
     kitId: number;
     capacity: number;
@@ -345,8 +347,8 @@ export type KitStorage = {
     tran: KitStorageTransport;
 };
 export type KitFootageRequestPayload = {
-    cameraId: CameraExid;
-    storageId: number;
+    cameraId?: number;
+    storageId?: number;
 };
 export type KitFootage = {
     id: number;
@@ -367,6 +369,7 @@ export type KitBox = {
     gatewaySerial: string;
     gatewayMac: string;
     gatewayConfig: Record<string, unknown> | null;
+    kitSerials?: string[];
     insertedAt: string;
     updatedAt: string;
 };
@@ -377,7 +380,8 @@ export type KitBoxCreatePayload = {
     gatewayConfig?: Record<string, unknown>;
 };
 export type KitBoxQueryParams = PaginationParams & {
-    id: string;
-    gatewaySerial: string;
-    gatewayMac: string;
+    id?: string;
+    gatewaySerial?: string;
+    gatewayMac?: string;
+    hasKits?: boolean;
 };

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

@@ -15,6 +15,7 @@ export type Media = {
     url?: string;
     exid?: MediaExid;
     embedCode?: string;
+    embedTime?: boolean;
     fileName?: string;
     format?: string;
     frames?: number;
@@ -26,6 +27,12 @@ export type Media = {
     thumbnailUrl?: string;
     mediaUrl?: string;
     camera?: string;
+    notes?: string | null;
+    category?: string | null;
+    isUrgent?: boolean;
+    bucket?: string | null;
+    sourceProduct?: string | null;
+    featureType?: string | null;
 };
 export declare enum MediaType {
     EditedImage = "edit",
@@ -70,8 +77,12 @@ export type MediaFilterQueryParams = {
     toDate?: string;
     cameraName?: string;
     requesterEmail?: string;
+    requestorName?: string;
     type?: MediaType;
+    status?: string;
     cameraExid?: string;
+    projectExid?: string;
+    projectName?: string;
     page?: number;
     limit?: number;
     camera?: string;
@@ -79,7 +90,9 @@ export type MediaFilterQueryParams = {
 export type MediaUpdateRequestPayload = {
     name?: string;
     title?: string;
+    status?: number;
     public?: boolean;
+    url?: string;
 };
 export type MediaCreateRequestPayload = {
     fromDate: DateType;

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

@@ -5,53 +5,59 @@ export declare enum NotificationType {
     TimelapseCreated = "timelapse_created",
     TimelapseFailed = "timelapse_failed",
     DroneProcessing = "drone_processing_done",
-    Processing360 = "three_sixty_done"
+    Processing360 = "three_sixty_done",
+    Other = "other"
 }
-export interface NotificationContextBase {
+export type NotificationContextBase = {
     cameraExid?: string;
     projectExid?: string;
-}
-export interface CameraShareContext extends NotificationContextBase {
+    cameraName?: string;
+};
+export type CameraShareContext = NotificationContextBase & {
     cameraExid: string;
     projectExid: string;
     shareId: number;
-}
-export interface CameraStatusChangeContext extends NotificationContextBase {
+};
+export type CameraStatusChangeContext = NotificationContextBase & {
     cameraExid: string;
     projectExid: string;
     newStatus: string;
-}
-export interface MentionContext extends NotificationContextBase {
-}
-export interface TimelapseCreatedContext extends NotificationContextBase {
+};
+export type MentionContext = NotificationContextBase;
+export type TimelapseCreatedContext = NotificationContextBase & {
     cameraExid: string;
     projectExid: string;
     archiveExid: string;
-}
-export interface TimelapseFailedContext extends NotificationContextBase {
+};
+export type TimelapseFailedContext = NotificationContextBase & {
     cameraExid: string;
     projectExid: string;
-}
-export interface DroneProcessingContext extends NotificationContextBase {
+};
+export type DroneProcessingContext = NotificationContextBase & {
     projectExid: string;
     droneDate: string;
-}
-export interface Processing360Context extends NotificationContextBase {
+};
+export type Processing360Context = NotificationContextBase & {
     projectExid: string;
     date: string;
     floor: string;
-}
+};
 export type NotificationContext = CameraShareContext | CameraStatusChangeContext | MentionContext | TimelapseCreatedContext | TimelapseFailedContext | DroneProcessingContext | Processing360Context;
 export type Notification = {
-    id: number;
-    type: NotificationType;
-    insertedAt: string;
-    initiatorId: number;
-    initiatorFullname: string;
-    initiatorEmail: string;
-    targetId: number;
-    targetFullname: string;
-    targetEmail: string;
-    readTimestamp: string | null;
-    context: NotificationContext;
+    id?: number;
+    type?: NotificationType;
+    insertedAt?: string;
+    initiatorId?: number;
+    initiatorFullname?: string;
+    initiatorEmail?: string;
+    targetId?: number;
+    targetFullname?: string;
+    targetEmail?: string;
+    readTimestamp?: string | null;
+    context?: NotificationContext;
+};
+export type NotificationsListParams = {
+    page?: number;
+    limit?: number;
+    sort?: string;
 };

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

@@ -24,6 +24,34 @@ export declare enum NvrHddStatus {
     Ok = "ok",
     Unformatted = "unformatted"
 }
+export type NvrSetting = {
+    exid: string;
+    name: string;
+    externalHost: string;
+    model: string;
+    deviceName: string;
+    macAddress: string;
+    firmwareVersion: string;
+    resolution: string;
+    bitrateType: string;
+    videoQuality: string;
+    frameRate: number;
+    bitrate: number;
+    videoEncoding: string;
+    hddName: string;
+    hddCapacity: string;
+    freeSpace: string;
+    hddStatus: string;
+    hddProperty: string;
+    nvrStatus: string;
+    timeMode: string;
+    localTime: string;
+    timezone: string;
+    addressingFormatType: string;
+    hostName: string;
+    portNo: string;
+    synchronizeInterval: string;
+};
 export type NvrCreatePayload = {
     serial?: string;
     httpUrl: string;

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

@@ -24,6 +24,7 @@ export type CreateOAuthClientPayload = {
     scopes?: string[];
     description?: string;
     logoUrl?: string;
+    userId?: number;
 };
 export type AdminCreateOAuthClientPayload = CreateOAuthClientPayload & {
     clientId?: string;

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

@@ -1,22 +1,19 @@
-import { Automation, AutomationType, DateType, PaginationParams } from "@evercam/api/types";
+import { Automation, DateType, PaginationParams } from "@evercam/api/types";
 export type ProgressPhotosCreateUpdateRequestPayload = {
     cameraExids?: string;
     notifyDays?: string;
-    compareDelay?: AutomationType;
     notifyTime?: string;
+    timezone?: string;
+    name?: string;
     provider?: string;
     type?: string;
     config?: {
-        compareDelay?: AutomationType;
-        period?: number;
         recipients?: string;
-        projectId?: number;
         companyId?: number;
-        catergoryId?: string;
+        projectId?: number;
+        categoryId?: number;
     };
-    subject?: string;
     isPaused?: boolean;
-    timezone?: string;
 };
 export type ProgressPhotosUnSubscribeParams = {
     email: string;
@@ -37,30 +34,35 @@ export type CameraOption = {
     exid: string;
     name: string;
 };
-export interface ProgressPhotoItem {
+export type ProgressPhotoItemConfig = {
+    recipients?: string;
+    companyId?: number;
+    projectId?: number;
+};
+export type ProgressPhotoItem = {
     id: number;
     cameras: CameraOption[] | string[] | string;
     insertedAt: string;
+    name: string;
     provider: string;
-    config: {
-        recipients: string | string[];
-        sendSnapshotAs: string;
-    };
+    config: ProgressPhotoItemConfig;
     isPaused: boolean;
     notifyDays: string | string[];
     notifyTime: string;
-    api_id: string;
-    api_key: string;
+    apiId: string;
+    apiKey: string;
     timezone: string;
     exid: string;
     fullname: string;
-}
+};
 export type ProgressPhotosQueryParams = PaginationParams & {
-    fullname: string;
-    recipients: string;
-    notifyTime: string;
-    timezone: string;
-    cameras: string;
+    fullname?: string;
+    name?: string;
+    recipients?: string;
+    notifyTime?: string;
+    timezone?: string;
+    cameras?: string;
+    sort?: string;
 };
 export type progressPhotosHistoryQueryParams = {
     insertedAt: DateType[];
@@ -75,4 +77,5 @@ export type ProgressPhotosHistory = {
     failedCameraIds: string;
     subject: string;
     recipients: string;
+    insertedAt: string;
 };

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

@@ -66,7 +66,7 @@ export declare enum ProjectArchiveTier {
     No = "No"
 }
 export type UpdateCameraRestrictionPayload = {
-    isAccessRestricted?: boolean;
+    isAccessRestricted: boolean;
 };
 export type Logo = {
     id: number;
@@ -95,7 +95,7 @@ export declare enum ProjectFeatureFlag {
     NoGdpr = "no_gdpr"
 }
 export type ProjectBatteryReading = {
-    exid: number;
+    exid: string;
     voltage: number;
     lastSeen: DateType;
 };
@@ -164,11 +164,11 @@ export type ProjectRole = {
     name: string;
 };
 export type ProjectMember = {
-    id: string;
+    id: number;
     key?: string;
     email: string;
     fullname: string;
-    lastSeenAt?: string;
+    lastSeenAt?: string | null;
     role: ProjectRole;
     permissions?: string[];
     subRoles?: Array<{
@@ -178,9 +178,11 @@ export type ProjectMember = {
     company?: {
         name: string;
     } | null;
+    telephone?: string | null;
+    persona?: string | null;
 };
 export type ProjectInvite = {
-    id?: string;
+    id?: number;
     email: string;
     role?: ProjectRole;
     permissions?: string[];
@@ -194,6 +196,7 @@ export type ProjectMembersResponsePayload = {
     users: ProjectMember[];
     invites: ProjectInvite[];
     errors: ProjectUserError[];
+    emailFailures?: string[];
 };
 export type ProjectMembersRequestPayload = {
     roleId: number;
@@ -224,19 +227,36 @@ export type ProjectUsersResponsePayload = {
     errors: ProjectUserError[];
 };
 export type ProjectStorageQueryParams = PaginationParams & {
-    cameraName: string;
-    cameraExid: CameraExid;
+    cameraName?: string;
+    cameraExid?: CameraExid;
+    projectName?: string;
+    projectExid?: string;
+    archiveTier?: string;
+    status?: ProjectStorageStatus;
+    requester?: string;
+    createdAtFrom?: string;
+    createdAtTo?: string;
+    scheduleAtFrom?: string;
+    scheduleAtTo?: string;
+    sort?: string;
+};
+export type ProjectStorageCamera = {
+    archiveId: number;
+    name: string;
+    exid: string;
+    errorMessage?: string;
     status: ProjectStorageStatus;
 };
 export type ProjectStorage = {
     id: number;
-    cameraExid: CameraExid;
-    cameraName: string;
-    projectExid: string;
-    projectName: string;
-    status: ProjectStorageStatus;
-    requestor: string;
-    created_at: DateType;
+    exid: string;
+    name: string;
+    requester: string;
+    archiveTier: string;
+    scheduleAt: string;
+    endDate: string;
+    insertedAt: string;
+    cameras: ProjectStorageCamera[];
 };
 export declare enum ProjectStorageStatus {
     New = "new",
@@ -245,3 +265,26 @@ export declare enum ProjectStorageStatus {
     Completed = "completed",
     Failed = "failed"
 }
+export type ProjectTransferOwnershipResponse = {
+    project: {
+        id: number;
+        exid: string;
+        name: string;
+        status: string;
+        userId: number;
+        zohoId: string | null;
+    };
+};
+export type ProjectTeamMembersResponse = {
+    exid?: string;
+    name?: string;
+    cameras?: Array<{
+        exid?: string;
+        name?: string;
+        shares?: Array<{
+            email?: string;
+            fullname?: string;
+            rights?: string;
+        }>;
+    }>;
+};

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

@@ -2,15 +2,16 @@ import { ApiCredentials } from "@evercam/api/types";
 import { CancelToken } from "axios";
 export type Snapshot = {
     createdAt: string;
-    data: string;
+    data: string | null;
     status?: string;
 };
-export type NearestSnapshotRequestPayload = {
+export type SnapshotRequestPayload = {
     apiKey?: string;
     apiId?: string;
     token?: string;
     cancelToken?: object;
     includeImage?: boolean;
+    view?: boolean;
 };
 export type AvailableDaysRequestPayload = {
     cameraId: string;
@@ -36,7 +37,7 @@ export type AvailableHoursResponsePayload = {
 export type NearestSnapshotResponsePayload = {
     snapshots: Array<{
         createdAt: string;
-        data: string;
+        data: string | null;
         notes?: string;
     }>;
 };

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

@@ -3,7 +3,8 @@ export declare enum RoiType {
     AnprContext = "anpr_context",
     ExclusionZone = "exclusion_zone",
     WorkflowArea = "workflow_area",
-    SiteAnalytics = "site_analytics"
+    SiteAnalytics = "site_analytics",
+    Ppe = "ppe_roi"
 }
 export declare enum RoiShapeType {
     Polygon = "polygon",

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

@@ -8,11 +8,14 @@ export type SimProvider = {
 export type Router = {
     id?: number;
     kitId: number | null;
+    kitSerial?: string;
+    kitName?: string;
     routerType: string;
     routerUserId: string;
     routerPassword: string;
     serialNumber: number | null;
     rmsUrl?: string;
+    rmsId?: number;
     externalHost?: string;
     routerHttpPort: number | null;
     vpnPassword: string;
@@ -29,8 +32,12 @@ export type Router = {
     sims: Array<Pick<Sim, "id" | "number">>;
     billPayers?: Array<RouterBillPayer>;
     simProviders?: Array<SimProvider>;
-    projects?: Pick<Project, "exid" | "id" | "name">[];
-    cameras?: Pick<Camera, "id" | "name">[];
+    projects?: Pick<Project, "exid" | "name">[];
+    cameras?: Pick<Camera, "id" | "name"> & {
+        exid: string;
+    }[];
+    lastSms?: string;
+    lastSmsAt?: string;
 };
 export declare enum PowerType {
     Mains = "mains",
@@ -55,6 +62,20 @@ export type RouterQueryParams = PaginationParams & {
     routerType: string;
     vpnServer: string;
     serialNumber: string;
+    kitSerial: string;
+    kitName: string;
+    cameras: string;
+    projects: string;
+    sims: string;
+    billPayers: string;
+    lastSms: string;
+    lastSmsAt: string;
+    hasBattery: string;
+    powerType: PowerType;
+    powerSchedule: PowerSchedule;
+    status: RouterStatus;
+    routerHttpPort: string;
+    sort: string;
 };
 export type RouterCreatePayload = {
     serialNumber: number;

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

@@ -13,51 +13,58 @@ export type JsonObject = {
 };
 export type JsonArray = JsonValue[];
 export type BatteryReading = {
-    id: number;
-    voltage: number;
-    datetime: DateType;
-    serialNo: string;
-    iValue: number;
-    vpvValue: number;
-    ppvValue: number;
-    csValue: number;
-    errValue: number;
-    h19Value: number;
-    h20Value: number;
-    h21Value: number;
-    h22Value: number;
-    h23Value: number;
-    ilValue: number;
-    mpptValue: number;
-    loadValue: number;
-    pValue: number;
-    consumedAmphours: number;
-    socValue: number;
-    timeToGo: number;
-    alarm: string;
-    relay: string;
-    arValue: number;
-    bmvValue: number;
-    h1Value: number;
-    h2Value: number;
-    h3Value: number;
-    h4Value: number;
-    h5Value: number;
-    h6Value: number;
-    h7Value: number;
-    h8Value: number;
-    h9Value: number;
-    h10Value: number;
-    h11Value: number;
-};
-export interface PaginatedItems<T> {
+    id?: number;
+    voltage?: number;
+    datetime?: DateType;
+    serialNo?: string;
+    iValue?: number;
+    vpvValue?: number;
+    ppvValue?: number;
+    csValue?: number;
+    errValue?: number;
+    h19Value?: number;
+    h20Value?: number;
+    h21Value?: number;
+    h22Value?: number;
+    h23Value?: number;
+    ilValue?: number;
+    mpptValue?: number;
+    loadValue?: number;
+    pValue?: number;
+    consumedAmphours?: number;
+    socValue?: number;
+    timeToGo?: number;
+    alarm?: string;
+    relay?: string;
+    arValue?: number;
+    bmvValue?: number;
+    h1Value?: number;
+    h2Value?: number;
+    h3Value?: number;
+    h4Value?: number;
+    h5Value?: number;
+    h6Value?: number;
+    h7Value?: number;
+    h8Value?: number;
+    h9Value?: number;
+    h10Value?: number;
+    h11Value?: number;
+};
+export type BatteryReadingRequestPayload = {
+    fromDate: string;
+    toDate: string;
+    sort?: string;
+    page?: number;
+    limit?: number;
+};
+export type PaginatedItems<T> = {
     from: number;
     items: Array<T>;
     limit: number;
     page: number;
     to: number;
     total: number;
-}
+};
 export declare enum UnitSystem {
     Imperial = "imperial",
     Metric = "metric"
@@ -156,14 +163,14 @@ export type Exid = string;
 export type EntityByExid<Entity extends unknown> = Record<Exid, Entity>;
 export type BatteryVoltage = {
     date: DateType;
-    max_value: number;
-    min_value: number;
+    maxValue: number;
+    minValue: number;
 };
 export type GlobalSearchQueryParams = PaginationParams & {
     resource: "projects" | "users" | "cameras" | "companies" | "sims" | "routers";
     term: string;
-    email: string;
-    featureFlag: string;
+    email?: string;
+    featureFlag?: string;
 };
 export type TimelineDateInterval = {
     fromDate: string;

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

@@ -83,10 +83,7 @@ export type SmsHistory = {
     type: string;
     status: string;
     text: string;
-    deliveryDatetime: string;
-};
-export type SmsHistoryResponse = {
-    singleSimSms: SmsHistory[];
+    deliveredAt: string;
 };
 export type Sms = {
     id: number;