@evercam/api 1.0.0-f6f982c6c → 1.0.0-fce98b41d

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1 +1,3 @@
1
1
  # @evercam/api
2
+
3
+ //
@@ -1,4 +1,5 @@
1
- import type { CamerasResponsePayload, CameraUpdateRequestPayload, PaginatedItems, AdminCamera, Project, Hdd, AdminUser, ProgressPhotosCreateUpdateRequestPayload, ProgressPhoto, Kit, PatchPayload, StorageServersResponsePayload, MediaFilterQueryParams, Media, MediaDeleteRequestPayload, AuditLogsParams, AuditLog, SnapshotExtractionQyeryParams, SnapshotExtraction, CameraCreateRequestPayload, CameraDeletePayload, SnapshotTestPayload, SnapshotTestResponse, DuplicatedCameraFields, DuplicatedCameraResponse, MergeDuplicatedCameraPayload, FetchCameraQueryParams, DeleteSnapshotQueryParams, SaveNotePayload, CameraNote, CreateCameraNotePayload, CompanyQueryParams, Company, CompanyUpdatePayload, SuppressionsQueryParams, Suppression, SnapshotExtractionType, PaginationParams, GateReportProject, KitQueryParams, KitCreatePayload, AdminKit, CameraLogsQueryParams, CameraLog, CameraAuditLogsQueryParams, CameraAuditLog, NvrQueryParams, Nvr, SiteVisitCamerasQueryParams, OfflineCameraQueryParams, OfflineCamera, OfflineCameraNoteResponse, UserStatsResponse, EntityStatsQueryParams, EntityStat, UserSession, UserCameraResponse, UserProjectResponse, ProjectUsers, ProjectCamera, ProjectsQueryParams, ProjectStatusStats, ProjectCreateRequestPayload, ProjectCreateResponse, ProjectUpdateRequestPayload, RouterQueryParams, Router, RouterCreatePayload, GlobalSearchQueryParams, CameraShareRequestsQueryParams, CameraShareRequest, CameraShareRequestPayload, ShareCreateResponsePayload, ShareQueryParams, AdminShare, SimCreateUpdatePayload, SimsQueryParams, Sim, SendSmsPayload, SendSmsResponse, SmsHistoryResponse, SmsQueryParams, Sms, ProgressPhotosQueryParams, ProgressPhotoItem, progressPhotosHistoryQueryParams, ProgressPhotosHistory, AdminUserUpdateRequestPayload, AdminQueryParams, Admin, ImpersonateUserResponse, AdminUserQueryParams, AdminCompareQueryParams, AdminCompare, NvrCreatePayload } from "@evercam/api/types";
1
+ import { FootageCreateUpdatePayload, HDDCreateUpdatePayload, HDDsQueryParams } from "@/types/hdd";
2
+ import type { CamerasResponsePayload, CameraUpdateRequestPayload, PaginatedItems, AdminCamera, Project, Hdd, AdminUser, ProgressPhotosCreateUpdateRequestPayload, ProgressPhoto, Kit, PatchPayload, StorageServersResponsePayload, MediaFilterQueryParams, Media, MediaDeleteRequestPayload, AuditLogsParams, AuditLog, SnapshotExtractionQyeryParams, SnapshotExtraction, CameraCreateRequestPayload, CameraDeletePayload, SnapshotTestPayload, SnapshotTestResponse, DuplicatedCameraFields, DuplicatedCameraResponse, MergeDuplicatedCameraPayload, FetchCameraQueryParams, DeleteSnapshotQueryParams, SaveNotePayload, CameraNote, CreateCameraNotePayload, CompanyQueryParams, Company, CompanyUpdatePayload, SuppressionsQueryParams, Suppression, SnapshotExtractionType, PaginationParams, GateReportProject, KitQueryParams, KitCreatePayload, AdminKit, CameraLogsQueryParams, CameraLog, CameraAuditLogsQueryParams, CameraAuditLog, NvrQueryParams, Nvr, SiteVisitCamerasQueryParams, OfflineCameraQueryParams, OfflineCamera, OfflineCameraNoteResponse, UserStatsResponse, EntityStatsQueryParams, EntityStat, UserSession, UserCameraResponse, UserProjectResponse, ProjectUsers, ProjectCamera, ProjectsQueryParams, ProjectStatusStats, ProjectCreateRequestPayload, ProjectCreateResponse, ProjectUpdateRequestPayload, RouterQueryParams, Router, RouterCreatePayload, GlobalSearchQueryParams, CameraShareRequestsQueryParams, CameraShareRequest, CameraShareRequestPayload, ShareCreateResponsePayload, ShareQueryParams, AdminShare, SimCreateUpdatePayload, SimsQueryParams, Sim, SendSmsPayload, SendSmsResponse, SmsHistoryResponse, SmsQueryParams, Sms, ProgressPhotosQueryParams, ProgressPhotoItem, progressPhotosHistoryQueryParams, ProgressPhotosHistory, AdminUserUpdateRequestPayload, AdminQueryParams, Admin, ImpersonateUserResponse, AdminUserQueryParams, AdminCompareQueryParams, AdminCompare, NvrCreatePayload, WidgetsListRequestPayload, Widget, WidgetFull, WidgetPayload } from "@evercam/api/types";
2
3
  import { KitMetricId } from "@evercam/api/types";
3
4
  export declare const AdminApi: {
4
5
  mediaHub: {
@@ -124,6 +125,7 @@ export declare const AdminApi: {
124
125
  getCameraLogs(cameraId: string, payload: {
125
126
  params: CameraAuditLogsQueryParams;
126
127
  }): Promise<PaginatedItems<CameraAuditLog[]>>;
128
+ togglePinNote(id: string): Promise<PaginatedItems<CameraAuditLog[]>>;
127
129
  };
128
130
  nvrs: {
129
131
  getNvrs(params: {
@@ -200,6 +202,15 @@ export declare const AdminApi: {
200
202
  projectId: string;
201
203
  companyId: string;
202
204
  }): Promise<Hdd[]>;
205
+ getAllHdds(params: {
206
+ params: Partial<HDDsQueryParams>;
207
+ }): Promise<import("axios").AxiosResponse<any, any>>;
208
+ deleteHdd(hddId: number): Promise<import("axios").AxiosResponse<any, any>>;
209
+ saveHdd(params: HDDCreateUpdatePayload): Promise<import("axios").AxiosResponse<any, any>>;
210
+ updateHdd(hddId: number, params: HDDCreateUpdatePayload): Promise<import("axios").AxiosResponse<any, any>>;
211
+ saveFootage(hddId: number, params: FootageCreateUpdatePayload): Promise<import("axios").AxiosResponse<any, any>>;
212
+ deleteFootage(hddId: number, footageId: number): Promise<import("axios").AxiosResponse<any, any>>;
213
+ updateFootage(hddId: number, footageId: number, params: FootageCreateUpdatePayload): Promise<import("axios").AxiosResponse<any, any>>;
203
214
  };
204
215
  shareRequests: {
205
216
  getShareRequests(params: {
@@ -285,4 +296,15 @@ export declare const AdminApi: {
285
296
  passwordResetLink: string;
286
297
  }>;
287
298
  };
299
+ widgets: {
300
+ index(params: {
301
+ params: Partial<WidgetsListRequestPayload>;
302
+ }): Promise<PaginatedItems<Widget>>;
303
+ show(id: number): Promise<WidgetFull>;
304
+ update(id: number, payload: WidgetPayload): Promise<WidgetFull>;
305
+ delete(id: number): Promise<import("axios").AxiosResponse<any, any>>;
306
+ };
307
+ zohoDesk: {
308
+ searchTickets(params: Record<string, unknown>): Promise<import("axios").AxiosResponse<any, any>>;
309
+ };
288
310
  };
@@ -1,4 +1,4 @@
1
- import type { AnprQueryParams, AnprEvent, EventCountRequestPayload, EventCountResponsePayload, EventsExportRequestParameters, EventsRequestPayload, EventsResponsePayload, GateReportROI, PaginatedItems, GateReportVerifiedDay, ProjectExid, CameraExid, AnprCountsQueryParams, AnprCount, AnprBasedGateReportExportRequestParams, GateReportResponsePayload, GatReportRequestPayload, AnalyticsParameters, VerifiedDaysQueryParams, EventUpdateRequestPayload, VerifyDayUpdateRequestPayload, ProcessedDaysQueryParams, GateReportEventType, DateTime, RoisQueryParams, GateReportROICreateRequestPayload } from "@evercam/api/types";
1
+ import type { AnprQueryParams, AnprEvent, EventCountRequestPayload, EventCountResponsePayload, EventsExportRequestParameters, EventsRequestPayload, EventsResponsePayload, GateReportROI, PaginatedItems, GateReportVerifiedDay, ProjectExid, CameraExid, AnprCountsQueryParams, AnprCount, AnprBasedGateReportExportRequestParams, GateReportResponsePayload, GatReportRequestPayload, AnalyticsParameters, VerifiedDaysQueryParams, EventUpdateRequestPayload, VerifyDayUpdateRequestPayload, ProcessedDaysQueryParams, GateReportEventType, DateTime, RoisQueryParams, GateReportROICreateRequestPayload, SegmentsSimilaritySearchParams, DetectionsFilters, TrackingsByLabel, SegmentsByLabel, CountsParams, DetectionsPresenceByLabel } from "@evercam/api/types";
2
2
  import type { AxiosPromise, AxiosRequestConfig } from "axios";
3
3
  export declare const getAiApiUrl: () => string | null | undefined;
4
4
  export declare const AiApi: {
@@ -70,4 +70,17 @@ export declare const AiApi: {
70
70
  updatedBy: string;
71
71
  }): Promise<import("axios").AxiosResponse<any, any>>;
72
72
  };
73
+ detections: {
74
+ getSimilarSegmentsInTimeIntervals({ cameraExid, iouThreshold, ...params }: SegmentsSimilaritySearchParams): Promise<import("axios").AxiosResponse<any, any>>;
75
+ getDetectionsTracking(cameraExid: CameraExid, params: DetectionsFilters): Promise<TrackingsByLabel>;
76
+ getSegmentsMasks(cameraExid: CameraExid, params: DetectionsFilters): Promise<SegmentsByLabel>;
77
+ getDetectionsPresenceDateIntervals({ cameraExid, ...params }: CountsParams): Promise<DetectionsPresenceByLabel>;
78
+ };
79
+ siteAnalytics: {
80
+ smartSearch({ cameraExid, query, payload, }: {
81
+ cameraExid: CameraExid;
82
+ query: Record<string, unknown>;
83
+ payload: Record<string, unknown>;
84
+ }): Promise<import("axios").AxiosResponse<any, any>>;
85
+ };
73
86
  };
@@ -1,4 +1,4 @@
1
- import { type AxiosError, type AxiosRequestConfig, type AxiosResponse } from "axios";
1
+ import { AxiosDefaults, type AxiosError, type AxiosRequestConfig, type AxiosResponse } from "axios";
2
2
  import type { AxiosEnvironment } from "../../types";
3
3
  export declare const onRequest: (request: AxiosRequestConfig, axiosEnv: AxiosEnvironment) => Promise<AxiosRequestConfig<any>>;
4
4
  export declare const onResponse: (response: AxiosResponse) => any;
@@ -6,4 +6,5 @@ export declare const onError: (error: AxiosError, axiosEnv: AxiosEnvironment) =>
6
6
  error: AxiosError<unknown, any>;
7
7
  duration: number;
8
8
  }>;
9
+ export declare const ensureCommonHeaders: (target: AxiosDefaults | AxiosRequestConfig) => void;
9
10
  export declare const OnRequestExpiredTokenInterceptor: (request: AxiosRequestConfig, isTokenExpired: () => boolean, handler: () => Promise<void>) => Promise<AxiosRequestConfig<any>>;
@@ -254,7 +254,7 @@ export declare const EvercamApi: {
254
254
  }): Promise<import("axios").AxiosResponse<any, any>>;
255
255
  };
256
256
  widgets: {
257
- index(params: WidgetsListRequestPayload): Promise<PaginatedItems<Widget>>;
257
+ index(params: Partial<WidgetsListRequestPayload>): Promise<PaginatedItems<Widget>>;
258
258
  show(id: number): Promise<WidgetFull>;
259
259
  getByKeys(): Promise<WidgetFull>;
260
260
  setSessionSettings(params: any): Promise<WidgetFull>;
@@ -1,4 +1,4 @@
1
- import type { CameraExid, CopilotConversation, CopilotMessage, CopilotMessageStep, CountByPeriod, CountsParams, DetectionsFilters, DetectionsPresenceByLabel, FeedbackPayload, GrafanaKitMetrics, LabsPaginationParams, LuminanceReading, MilesightCameraNetworkConfiguration, MilesightCameraOsdConfiguration, MilesightCameraSdCardInfo, MilesightCameraSystemSettings, MilesightCameraVideoConfig, MilesightRequestParams, PaginatedItems, SegmentsByLabel, SegmentsPresenceByLabel, SegmentsSimilaritySearchParams, TrackingsByLabel } from "@evercam/api/types";
1
+ import type { CameraExid, CopilotConversation, CopilotMessage, CopilotMessageStep, CountsParams, FeedbackPayload, GrafanaKitMetrics, LabsPaginationParams, LuminanceReading, MilesightCameraNetworkConfiguration, MilesightCameraOsdConfiguration, MilesightCameraSdCardInfo, MilesightCameraSystemSettings, MilesightCameraVideoConfig, MilesightRequestParams, PaginatedItems, SegmentsPresenceByLabel } from "@evercam/api/types";
2
2
  import { GrafanaMetricId, KitMetricPeriod } from "@evercam/api/types";
3
3
  export declare function getLabsBaseUrl(): string | null | undefined;
4
4
  export declare const EvercamLabsApi: {
@@ -22,12 +22,7 @@ export declare const EvercamLabsApi: {
22
22
  submitMessageFeedback<T>({ conversationId, messageId, ...params }: FeedbackPayload<T>): Promise<import("axios").AxiosResponse<any, any>>;
23
23
  };
24
24
  detections: {
25
- getDetectionsTracking(cameraExid: CameraExid, params: DetectionsFilters): Promise<TrackingsByLabel>;
26
- getSegmentsMasks(cameraExid: CameraExid, params: DetectionsFilters): Promise<SegmentsByLabel>;
27
- getDetectionsPresenceDateIntervals({ cameraExid, fromDate, toDate, precision, }: CountsParams): Promise<DetectionsPresenceByLabel>;
28
25
  getSegmentsDateIntervals({ cameraExid, fromDate, toDate, precision, }: CountsParams): Promise<SegmentsPresenceByLabel>;
29
- getCranesMovement({ cameraExid, fromDate, toDate, precision, }: CountsParams): Promise<CountByPeriod[]>;
30
- getSimilarSegmentsInTimeIntervals({ cameraExid, segmentId, ...params }: SegmentsSimilaritySearchParams): Promise<import("axios").AxiosResponse<any, any>>;
31
26
  };
32
27
  googleCloudStorage: {
33
28
  listFiles(prefix?: string): Promise<{
@@ -27,7 +27,7 @@ export declare const PtzApi: {
27
27
  }): Promise<import("axios").AxiosResponse<any, any>>;
28
28
  };
29
29
  controls: {
30
- move({ cameraExid, direction, isRecordingFromNvr }: MoveParams): Promise<import("axios").AxiosResponse<any, any>>;
30
+ move({ cameraExid, direction, useContinuous }: MoveParams): Promise<import("axios").AxiosResponse<any, any>>;
31
31
  zoom({ cameraExid, direction, isRecordingFromNvr }: ZoomParams): Promise<import("axios").AxiosResponse<any, any>>;
32
32
  stop({ cameraExid }: {
33
33
  cameraExid: string;
@@ -3,20 +3,20 @@ export declare const WeatherApi: {
3
3
  current: {
4
4
  getCurrentWeather({ projectExid, weatherProvider, }: {
5
5
  projectExid: string;
6
- weatherProvider: WeatherProvider;
6
+ weatherProvider?: WeatherProvider;
7
7
  }): Promise<WeatherResponsePayload> | undefined;
8
8
  };
9
9
  historical: {
10
10
  getWeatherBeforeDate({ projectExid, weatherProvider, payload, }: {
11
11
  projectExid: string;
12
- weatherProvider: WeatherProvider;
12
+ weatherProvider?: WeatherProvider;
13
13
  payload: HistoryWeatherRequestPayload;
14
14
  }): Promise<WeatherResponsePayload> | undefined;
15
15
  };
16
16
  weather: {
17
17
  getWeatherData({ projectExid, weatherProvider, payload, }: {
18
18
  projectExid: string;
19
- weatherProvider: WeatherProvider;
19
+ weatherProvider?: WeatherProvider;
20
20
  payload: HistoryWeatherRequestPayload;
21
21
  }): Promise<{
22
22
  data: WeatherDataResponse[];