@evercam/api 1.0.0-a405572ff → 1.0.0-a7ba6b817

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,3 +1,3 @@
1
1
  # @evercam/api
2
2
 
3
- ??
3
+ //
@@ -1,4 +1,6 @@
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, 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";
3
+ import { KitMetricId } from "@evercam/api/types";
2
4
  export declare const AdminApi: {
3
5
  mediaHub: {
4
6
  getAllMedia(params: {
@@ -93,12 +95,6 @@ export declare const AdminApi: {
93
95
  type: SnapshotExtractionType;
94
96
  }): Promise<void>;
95
97
  };
96
- gateReport: {
97
- getGateReportProjects(params: {
98
- params: PaginationParams;
99
- }): Promise<PaginatedItems<GateReportProject[]>>;
100
- getGateReportProject(projectExid: string): Promise<Project>;
101
- };
102
98
  kits: {
103
99
  getAllKits(params: {
104
100
  params: KitQueryParams;
@@ -107,6 +103,12 @@ export declare const AdminApi: {
107
103
  createKit(params: KitCreatePayload): Promise<AdminKit>;
108
104
  updateKit(id: string, params: PatchPayload<Kit>): Promise<import("axios").AxiosResponse<any, any>>;
109
105
  deleteKit(id: string, params: Record<string, unknown>): Promise<import("axios").AxiosResponse<any, any>>;
106
+ getKitStats({ kitId, metric, fromDate, toDate, }: {
107
+ kitId: number;
108
+ metric: KitMetricId;
109
+ fromDate: string;
110
+ toDate: string;
111
+ }): Promise<import("axios").AxiosResponse<any, any>>;
110
112
  };
111
113
  logs: {
112
114
  getAllCamerasStatusLogs(params: {
@@ -117,6 +119,7 @@ export declare const AdminApi: {
117
119
  getCameraLogs(cameraId: string, payload: {
118
120
  params: CameraAuditLogsQueryParams;
119
121
  }): Promise<PaginatedItems<CameraAuditLog[]>>;
122
+ togglePinNote(id: string): Promise<PaginatedItems<CameraAuditLog[]>>;
120
123
  };
121
124
  nvrs: {
122
125
  getNvrs(params: {
@@ -193,6 +196,15 @@ export declare const AdminApi: {
193
196
  projectId: string;
194
197
  companyId: string;
195
198
  }): Promise<Hdd[]>;
199
+ getAllHdds(params: {
200
+ params: Partial<HDDsQueryParams>;
201
+ }): Promise<import("axios").AxiosResponse<any, any>>;
202
+ deleteHdd(hddId: number): Promise<import("axios").AxiosResponse<any, any>>;
203
+ saveHdd(params: HDDCreateUpdatePayload): Promise<import("axios").AxiosResponse<any, any>>;
204
+ updateHdd(hddId: number, params: HDDCreateUpdatePayload): Promise<import("axios").AxiosResponse<any, any>>;
205
+ saveFootage(hddId: number, params: FootageCreateUpdatePayload): Promise<import("axios").AxiosResponse<any, any>>;
206
+ deleteFootage(hddId: number, footageId: number): Promise<import("axios").AxiosResponse<any, any>>;
207
+ updateFootage(hddId: number, footageId: number, params: FootageCreateUpdatePayload): Promise<import("axios").AxiosResponse<any, any>>;
196
208
  };
197
209
  shareRequests: {
198
210
  getShareRequests(params: {
@@ -278,4 +290,15 @@ export declare const AdminApi: {
278
290
  passwordResetLink: string;
279
291
  }>;
280
292
  };
293
+ widgets: {
294
+ index(params: {
295
+ params: Partial<WidgetsListRequestPayload>;
296
+ }): Promise<PaginatedItems<Widget>>;
297
+ show(id: number): Promise<WidgetFull>;
298
+ update(id: number, payload: WidgetPayload): Promise<WidgetFull>;
299
+ delete(id: number): Promise<import("axios").AxiosResponse<any, any>>;
300
+ };
301
+ zohoDesk: {
302
+ searchTickets(params: Record<string, unknown>): Promise<import("axios").AxiosResponse<any, any>>;
303
+ };
281
304
  };
@@ -1,5 +1,6 @@
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
+ import { CreateCoolifyAppRequestPayload, SaveCoolifyAppRequestPayload } from "@/types/coolify";
3
4
  export declare const getAiApiUrl: () => string | null | undefined;
4
5
  export declare const AiApi: {
5
6
  analyticsParameters: {
@@ -52,6 +53,8 @@ export declare const AiApi: {
52
53
  }): string;
53
54
  getEvents(projectExid: ProjectExid, params: GatReportRequestPayload, extraParams?: AxiosRequestConfig): Promise<GateReportResponsePayload>;
54
55
  getCounts(projectExid: string, payload?: EventCountRequestPayload, extraParams?: AxiosRequestConfig): Promise<EventCountResponsePayload>;
56
+ getGateReportApplications(projectExid: string, anprCameraExid: string): Promise<import("axios").AxiosResponse<any, any>>;
57
+ getGateReportProjectsInfos(): Promise<import("axios").AxiosResponse<any, any>>;
55
58
  };
56
59
  brainTool: {
57
60
  getObjectDetectionsResults(payload?: {}): Promise<import("axios").AxiosResponse<any, any>>;
@@ -70,4 +73,38 @@ export declare const AiApi: {
70
73
  updatedBy: string;
71
74
  }): Promise<import("axios").AxiosResponse<any, any>>;
72
75
  };
76
+ detections: {
77
+ getSimilarSegmentsInTimeIntervals({ cameraExid, iouThreshold, ...params }: SegmentsSimilaritySearchParams): Promise<import("axios").AxiosResponse<any, any>>;
78
+ getDetectionsTracking(cameraExid: CameraExid, params: DetectionsFilters): Promise<TrackingsByLabel>;
79
+ getSegmentsMasks(cameraExid: CameraExid, params: DetectionsFilters): Promise<SegmentsByLabel>;
80
+ getDetectionsPresenceDateIntervals({ cameraExid, ...params }: CountsParams): Promise<DetectionsPresenceByLabel>;
81
+ };
82
+ siteAnalytics: {
83
+ smartSearch({ cameraExid, query, payload, }: {
84
+ cameraExid: CameraExid;
85
+ query: Record<string, unknown>;
86
+ payload: Record<string, unknown>;
87
+ }): Promise<import("axios").AxiosResponse<any, any>>;
88
+ };
89
+ coolify: {
90
+ getCoolifyServers(): Promise<import("axios").AxiosResponse<any, any>>;
91
+ createAppOnCoolify(payload: CreateCoolifyAppRequestPayload): Promise<import("axios").AxiosResponse<any, any>>;
92
+ saveAppOnCoolify(projectExid: string, cameraExid: string, payload: SaveCoolifyAppRequestPayload): Promise<import("axios").AxiosResponse<any, any>>;
93
+ updateApp({ appUuid, appId, payload, cameraExid, projectExid, }: {
94
+ projectExid: string;
95
+ cameraExid: string;
96
+ appId: string;
97
+ appUuid: string;
98
+ payload: Partial<SaveCoolifyAppRequestPayload>;
99
+ }): Promise<import("axios").AxiosResponse<any, any>>;
100
+ deleteApp({ appUuid, appId, cameraExid, projectExid, }: {
101
+ projectExid: string;
102
+ cameraExid: string;
103
+ appId: string;
104
+ appUuid: string;
105
+ }): Promise<import("axios").AxiosResponse<any, any>>;
106
+ startService(serviceId: string): Promise<import("axios").AxiosResponse<any, any>>;
107
+ pauseService(serviceId: string): Promise<import("axios").AxiosResponse<any, any>>;
108
+ restartService(serviceId: string): Promise<import("axios").AxiosResponse<any, any>>;
109
+ };
73
110
  };
@@ -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,5 @@
1
- import type { MilesightCameraVideoConfig, MilesightRequestParams, MilesightCameraNetworkConfiguration, MilesightCameraSystemSettings, MilesightCameraOsdConfiguration, MilesightCameraSdCardInfo, CopilotConversation, CopilotMessage, PaginatedItems, CopilotMessageStep, DetectionsFilters, TrackingsByLabel, CameraExid, CountsParams, CountByPeriod, DetectionsPresenceByLabel, FeedbackPayload, LabsPaginationParams, SegmentsPresenceByLabel, SegmentsByLabel, SegmentsSimilaritySearchParams, LuminanceReading, GrafanaKitMetrics, GrafanaMetricId } 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
+ import { GrafanaMetricId, KitMetricPeriod } from "@evercam/api/types";
2
3
  export declare function getLabsBaseUrl(): string | null | undefined;
3
4
  export declare const EvercamLabsApi: {
4
5
  milesight: {
@@ -21,12 +22,7 @@ export declare const EvercamLabsApi: {
21
22
  submitMessageFeedback<T>({ conversationId, messageId, ...params }: FeedbackPayload<T>): Promise<import("axios").AxiosResponse<any, any>>;
22
23
  };
23
24
  detections: {
24
- getDetectionsTracking(cameraExid: CameraExid, params: DetectionsFilters): Promise<TrackingsByLabel>;
25
- getSegmentsMasks(cameraExid: CameraExid, params: DetectionsFilters): Promise<SegmentsByLabel>;
26
- getDetectionsPresenceDateIntervals({ cameraExid, fromDate, toDate, precision, }: CountsParams): Promise<DetectionsPresenceByLabel>;
27
25
  getSegmentsDateIntervals({ cameraExid, fromDate, toDate, precision, }: CountsParams): Promise<SegmentsPresenceByLabel>;
28
- getCranesMovement({ cameraExid, fromDate, toDate, precision, }: CountsParams): Promise<CountByPeriod[]>;
29
- getSimilarSegmentsInTimeIntervals({ cameraExid, segmentId, ...params }: SegmentsSimilaritySearchParams): Promise<import("axios").AxiosResponse<any, any>>;
30
26
  };
31
27
  googleCloudStorage: {
32
28
  listFiles(prefix?: string): Promise<{
@@ -45,6 +41,6 @@ export declare const EvercamLabsApi: {
45
41
  }): Promise<LuminanceReading[]>;
46
42
  };
47
43
  kits: {
48
- getMetrics(kitId: string, metrics: GrafanaMetricId[]): Promise<GrafanaKitMetrics>;
44
+ getMetrics(kitId: string, metrics: GrafanaMetricId[], period?: KitMetricPeriod): Promise<GrafanaKitMetrics>;
49
45
  };
50
46
  };
@@ -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[];