@evercam/api 1.0.0-213bdb2b3 → 1.0.0-27a9f9459

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,5 +1,7 @@
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";
2
3
  import { KitMetricId } from "@evercam/api/types";
4
+ import { Tag } from "@/types/tag";
3
5
  export declare const AdminApi: {
4
6
  mediaHub: {
5
7
  getAllMedia(params: {
@@ -94,12 +96,6 @@ export declare const AdminApi: {
94
96
  type: SnapshotExtractionType;
95
97
  }): Promise<void>;
96
98
  };
97
- gateReport: {
98
- getGateReportProjects(params: {
99
- params: PaginationParams;
100
- }): Promise<PaginatedItems<GateReportProject[]>>;
101
- getGateReportProject(projectExid: string): Promise<Project>;
102
- };
103
99
  kits: {
104
100
  getAllKits(params: {
105
101
  params: KitQueryParams;
@@ -114,6 +110,8 @@ export declare const AdminApi: {
114
110
  fromDate: string;
115
111
  toDate: string;
116
112
  }): Promise<import("axios").AxiosResponse<any, any>>;
113
+ attachTag(kitId: number, tagId: number): Promise<void>;
114
+ detachTag(kitId: number, tagId: number): Promise<void>;
117
115
  };
118
116
  logs: {
119
117
  getAllCamerasStatusLogs(params: {
@@ -201,6 +199,15 @@ export declare const AdminApi: {
201
199
  projectId: string;
202
200
  companyId: string;
203
201
  }): Promise<Hdd[]>;
202
+ getAllHdds(params: {
203
+ params: Partial<HDDsQueryParams>;
204
+ }): Promise<import("axios").AxiosResponse<any, any>>;
205
+ deleteHdd(hddId: number): Promise<import("axios").AxiosResponse<any, any>>;
206
+ saveHdd(params: HDDCreateUpdatePayload): Promise<import("axios").AxiosResponse<any, any>>;
207
+ updateHdd(hddId: number, params: HDDCreateUpdatePayload): Promise<import("axios").AxiosResponse<any, any>>;
208
+ saveFootage(hddId: number, params: FootageCreateUpdatePayload): Promise<import("axios").AxiosResponse<any, any>>;
209
+ deleteFootage(hddId: number, footageId: number): Promise<import("axios").AxiosResponse<any, any>>;
210
+ updateFootage(hddId: number, footageId: number, params: FootageCreateUpdatePayload): Promise<import("axios").AxiosResponse<any, any>>;
204
211
  };
205
212
  shareRequests: {
206
213
  getShareRequests(params: {
@@ -262,6 +269,12 @@ export declare const AdminApi: {
262
269
  }>;
263
270
  update(id: string, payload: ProgressPhotosCreateUpdateRequestPayload): Promise<ProgressPhoto>;
264
271
  };
272
+ tags: {
273
+ index(): Promise<Tag[]>;
274
+ create(tag: Tag): Promise<Tag>;
275
+ update(tag: Tag): Promise<Tag>;
276
+ delete(tag: Tag): Promise<void>;
277
+ };
265
278
  users: {
266
279
  updateUser(id: number, params: Partial<AdminUserUpdateRequestPayload>): Promise<AdminUser>;
267
280
  getAdmins(params: {
@@ -286,4 +299,15 @@ export declare const AdminApi: {
286
299
  passwordResetLink: string;
287
300
  }>;
288
301
  };
302
+ widgets: {
303
+ index(params: {
304
+ params: Partial<WidgetsListRequestPayload>;
305
+ }): Promise<PaginatedItems<Widget>>;
306
+ show(id: number): Promise<WidgetFull>;
307
+ update(id: number, payload: WidgetPayload): Promise<WidgetFull>;
308
+ delete(id: number): Promise<import("axios").AxiosResponse<any, any>>;
309
+ };
310
+ zohoDesk: {
311
+ searchTickets(params: Record<string, unknown>): Promise<import("axios").AxiosResponse<any, any>>;
312
+ };
289
313
  };
@@ -1,5 +1,6 @@
1
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(params: Record<string, unknown>): Promise<import("axios").AxiosResponse<any, any>>;
55
58
  };
56
59
  brainTool: {
57
60
  getObjectDetectionsResults(payload?: {}): Promise<import("axios").AxiosResponse<any, any>>;
@@ -76,4 +79,32 @@ export declare const AiApi: {
76
79
  getSegmentsMasks(cameraExid: CameraExid, params: DetectionsFilters): Promise<SegmentsByLabel>;
77
80
  getDetectionsPresenceDateIntervals({ cameraExid, ...params }: CountsParams): Promise<DetectionsPresenceByLabel>;
78
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
+ };
79
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,4 @@
1
- import type { CameraExid, CopilotConversation, CopilotMessage, CopilotMessageStep, CountByPeriod, CountsParams, FeedbackPayload, GrafanaKitMetrics, LabsPaginationParams, LuminanceReading, MilesightCameraNetworkConfiguration, MilesightCameraOsdConfiguration, MilesightCameraSdCardInfo, MilesightCameraSystemSettings, MilesightCameraVideoConfig, MilesightRequestParams, PaginatedItems, SegmentsPresenceByLabel } 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: {
@@ -10,6 +10,10 @@ export declare const EvercamLabsApi: {
10
10
  getOsdConfiguration({ host, httpPort, username, password }: MilesightRequestParams, config?: {}): Promise<MilesightCameraOsdConfiguration>;
11
11
  getSdCardInfo({ host, httpPort, username, password }: MilesightRequestParams, config?: {}): Promise<MilesightCameraSdCardInfo>;
12
12
  };
13
+ posthog: {
14
+ getEvents(params: any): Promise<PaginatedItems<any>>;
15
+ getUsers(params: any): Promise<any>;
16
+ };
13
17
  copilot: {
14
18
  getAllConversations(params: LabsPaginationParams & {
15
19
  cameraExid?: string;
@@ -23,7 +27,6 @@ export declare const EvercamLabsApi: {
23
27
  };
24
28
  detections: {
25
29
  getSegmentsDateIntervals({ cameraExid, fromDate, toDate, precision, }: CountsParams): Promise<SegmentsPresenceByLabel>;
26
- getCranesMovement({ cameraExid, fromDate, toDate, precision, }: CountsParams): Promise<CountByPeriod[]>;
27
30
  };
28
31
  googleCloudStorage: {
29
32
  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;
@@ -1,23 +1,25 @@
1
1
  import { HistoryWeatherRequestPayload, WeatherDataResponse, WeatherProvider, WeatherResponsePayload } from "@evercam/api/types";
2
+ import { AxiosRequestConfig } from "axios";
2
3
  export declare const WeatherApi: {
3
4
  current: {
4
5
  getCurrentWeather({ projectExid, weatherProvider, }: {
5
6
  projectExid: string;
6
- weatherProvider: WeatherProvider;
7
+ weatherProvider?: WeatherProvider;
7
8
  }): Promise<WeatherResponsePayload> | undefined;
8
9
  };
9
10
  historical: {
10
11
  getWeatherBeforeDate({ projectExid, weatherProvider, payload, }: {
11
12
  projectExid: string;
12
- weatherProvider: WeatherProvider;
13
+ weatherProvider?: WeatherProvider;
13
14
  payload: HistoryWeatherRequestPayload;
14
15
  }): Promise<WeatherResponsePayload> | undefined;
15
16
  };
16
17
  weather: {
17
- getWeatherData({ projectExid, weatherProvider, payload, }: {
18
+ getWeatherData({ projectExid, weatherProvider, payload, config, }: {
18
19
  projectExid: string;
19
- weatherProvider: WeatherProvider;
20
+ weatherProvider?: WeatherProvider;
20
21
  payload: HistoryWeatherRequestPayload;
22
+ config?: AxiosRequestConfig;
21
23
  }): Promise<{
22
24
  data: WeatherDataResponse[];
23
25
  }> | undefined;