@evercam/api 1.0.0-2bf5a8b13 → 1.0.0-2c3eef808

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.
Files changed (133) hide show
  1. package/README.md +4 -0
  2. package/dist/api/api/3dFirebaseApi.d.ts +210 -0
  3. package/dist/api/api/adminApi.d.ts +381 -0
  4. package/dist/api/api/aiApi.d.ts +168 -0
  5. package/dist/api/api/authzApi.d.ts +40 -0
  6. package/dist/api/{client → api/client}/axios.d.ts +2 -1
  7. package/dist/api/{client → api/client}/interceptors.d.ts +1 -1
  8. package/dist/api/api/client/swr/Swr.d.ts +14 -0
  9. package/dist/api/api/client/swr/SwrStore.d.ts +10 -0
  10. package/dist/api/api/evercamApi.d.ts +346 -0
  11. package/dist/api/{evercamLabsApi.d.ts → api/evercamLabsApi.d.ts} +9 -6
  12. package/dist/api/{exNvrApi.d.ts → api/exNvrApi.d.ts} +1 -1
  13. package/dist/api/api/index.d.ts +13 -0
  14. package/dist/api/api/ingestApi.d.ts +156 -0
  15. package/dist/api/{ptzApi.d.ts → api/ptzApi.d.ts} +12 -3
  16. package/dist/api/api/videoWallApi.d.ts +9 -0
  17. package/dist/api/{weatherApi.d.ts → api/weatherApi.d.ts} +2 -2
  18. package/dist/api/index.d.ts +3 -13
  19. package/dist/api/types/360.d.ts +395 -0
  20. package/dist/api/types/aconex.d.ts +143 -0
  21. package/dist/api/types/admin.d.ts +51 -0
  22. package/dist/api/types/aiConfigs.d.ts +154 -0
  23. package/dist/{types → api/types}/analytics.d.ts +196 -40
  24. package/dist/{types → api/types}/anpr.d.ts +55 -13
  25. package/dist/{types → api/types}/auditLogs.d.ts +19 -1
  26. package/dist/api/types/authz.d.ts +107 -0
  27. package/dist/{types → api/types}/autodesk.d.ts +7 -7
  28. package/dist/api/types/automation.d.ts +95 -0
  29. package/dist/{types → api/types}/axios.d.ts +30 -7
  30. package/dist/{types → api/types}/bim.d.ts +37 -6
  31. package/dist/{types → api/types}/camera.d.ts +112 -94
  32. package/dist/{types → api/types}/comments.d.ts +26 -11
  33. package/dist/api/types/company.d.ts +115 -0
  34. package/dist/{types → api/types}/compare.d.ts +20 -5
  35. package/dist/{types → api/types}/connector.d.ts +4 -5
  36. package/dist/api/types/coolify.d.ts +36 -0
  37. package/dist/{types → api/types}/copilot.d.ts +11 -6
  38. package/dist/{types → api/types}/countries.d.ts +0 -7
  39. package/dist/{types → api/types}/credentials.d.ts +1 -0
  40. package/dist/{types → api/types}/detections.d.ts +23 -34
  41. package/dist/api/types/drone.d.ts +107 -0
  42. package/dist/{types → api/types}/errors.d.ts +24 -0
  43. package/dist/{types → api/types}/gateReport.d.ts +50 -158
  44. package/dist/api/types/gateReportManagement.d.ts +175 -0
  45. package/dist/{types → api/types}/hdd.d.ts +26 -1
  46. package/dist/{types → api/types}/index.d.ts +14 -1
  47. package/dist/api/types/ingest.d.ts +158 -0
  48. package/dist/{types → api/types}/kit.d.ts +101 -10
  49. package/dist/api/types/map.d.ts +16 -0
  50. package/dist/{types → api/types}/media.d.ts +8 -2
  51. package/dist/api/types/notification.d.ts +57 -0
  52. package/dist/api/types/oauth.d.ts +62 -0
  53. package/dist/api/types/planner.d.ts +132 -0
  54. package/dist/api/types/posthog.d.ts +53 -0
  55. package/dist/{types → api/types}/procore.d.ts +26 -16
  56. package/dist/{types → api/types}/progressPhoto.d.ts +11 -23
  57. package/dist/api/types/project.d.ts +247 -0
  58. package/dist/{types → api/types}/recording.d.ts +9 -13
  59. package/dist/api/types/recycleBin.d.ts +14 -0
  60. package/dist/api/types/ring.d.ts +53 -0
  61. package/dist/{types → api/types}/roi.d.ts +4 -3
  62. package/dist/{types → api/types}/routeParams.d.ts +4 -2
  63. package/dist/{types → api/types}/router.d.ts +20 -1
  64. package/dist/{types → api/types}/shared.d.ts +31 -10
  65. package/dist/api/types/shares.d.ts +58 -0
  66. package/dist/{types → api/types}/sim.d.ts +6 -6
  67. package/dist/api/types/siteAnalytics.d.ts +287 -0
  68. package/dist/api/types/siteAnalyticsManagement.d.ts +92 -0
  69. package/dist/api/types/siteView.d.ts +73 -0
  70. package/dist/api/types/smartSeach.d.ts +5 -0
  71. package/dist/api/types/snapshots.d.ts +104 -0
  72. package/dist/api/types/sso.d.ts +55 -0
  73. package/dist/api/types/storageProvider.d.ts +19 -0
  74. package/dist/api/types/storyblok.d.ts +40 -0
  75. package/dist/{types → api/types}/streaming.d.ts +4 -5
  76. package/dist/{types → api/types}/tag.d.ts +1 -1
  77. package/dist/api/types/time.d.ts +7 -0
  78. package/dist/{types → api/types}/timelapse.d.ts +8 -5
  79. package/dist/{types → api/types}/user.d.ts +106 -40
  80. package/dist/api/types/videoWall.d.ts +66 -0
  81. package/dist/api/types/weather.d.ts +153 -0
  82. package/dist/{types → api/types}/widget.d.ts +96 -16
  83. package/dist/{types → api/types}/xweather.d.ts +4 -4
  84. package/dist/index.d.ts +2 -3
  85. package/dist/index.js +2404 -982
  86. package/dist/index.js.map +1 -1
  87. package/dist/index.umd.cjs +1 -1
  88. package/dist/index.umd.cjs.map +1 -1
  89. package/dist/shared/api/index.d.ts +3 -0
  90. package/dist/shared/components/timelinePlayer/providers/index.d.ts +3 -0
  91. package/dist/shared/components/timelinePlayer/providers/timelineAnprProvider.d.ts +17 -0
  92. package/dist/shared/components/timelinePlayer/providers/timelineDataProvider.d.ts +13 -0
  93. package/dist/shared/components/timelinePlayer/providers/timelineLuminanceProvider.d.ts +16 -0
  94. package/dist/shared/types/components.d.ts +346 -0
  95. package/dist/shared/types/customDataTableFilters.d.ts +10 -0
  96. package/dist/shared/types/imagePlayer.d.ts +41 -0
  97. package/dist/shared/types/index.d.ts +6 -0
  98. package/dist/shared/types/rbac.d.ts +67 -0
  99. package/dist/shared/types/timeline.d.ts +10 -0
  100. package/package.json +7 -4
  101. package/dist/api/3dFirebaseApi.d.ts +0 -10
  102. package/dist/api/adminApi.d.ts +0 -313
  103. package/dist/api/aiApi.d.ts +0 -125
  104. package/dist/api/authzApi.d.ts +0 -21
  105. package/dist/api/evercamApi.d.ts +0 -294
  106. package/dist/api/ingestApi.d.ts +0 -68
  107. package/dist/api/videoWallApi.d.ts +0 -9
  108. package/dist/types/360.d.ts +0 -87
  109. package/dist/types/aconex.d.ts +0 -45
  110. package/dist/types/automation.d.ts +0 -6
  111. package/dist/types/company.d.ts +0 -46
  112. package/dist/types/coolify.d.ts +0 -18
  113. package/dist/types/drone.d.ts +0 -17
  114. package/dist/types/ingest.d.ts +0 -43
  115. package/dist/types/map.d.ts +0 -4
  116. package/dist/types/notification.d.ts +0 -27
  117. package/dist/types/planner.d.ts +0 -28
  118. package/dist/types/project.d.ts +0 -127
  119. package/dist/types/shares.d.ts +0 -196
  120. package/dist/types/siteAnalytics.d.ts +0 -141
  121. package/dist/types/snapshots.d.ts +0 -50
  122. package/dist/types/storageServers.d.ts +0 -4
  123. package/dist/types/time.d.ts +0 -21
  124. package/dist/types/videoWall.d.ts +0 -33
  125. package/dist/types/weather.d.ts +0 -87
  126. /package/dist/api/{client → api/client}/customErrors.d.ts +0 -0
  127. /package/dist/api/{client → api/client}/index.d.ts +0 -0
  128. /package/dist/api/{webRtcApi.d.ts → api/webRtcApi.d.ts} +0 -0
  129. /package/dist/{types → api/types}/nvr.d.ts +0 -0
  130. /package/dist/{types → api/types}/systemCheck.d.ts +0 -0
  131. /package/dist/{types → api/types}/vendorModel.d.ts +0 -0
  132. /package/dist/{types → api/types}/voyageControl.d.ts +0 -0
  133. /package/dist/{utils.d.ts → api/utils.d.ts} +0 -0
package/README.md CHANGED
@@ -1,3 +1,7 @@
1
1
  # @evercam/api
2
2
 
3
3
  //
4
+
5
+
6
+
7
+
@@ -0,0 +1,210 @@
1
+ import { _360Floor, _360FloorId, _360Marker3D, _360Pin, _360ProjectJsonResponse, _360ProjectListItem, _360Scene, _360SceneRoute, _360CalibrationDetails, _360FloorData, _360FloorRef, _360ForgeProject, _360PinData, _360Route, _360Walk, Point3D, DroneBimData, DroneImageryPlan, DroneMarker, DroneModel, DroneProjectData, DroneProjectDataPatch, DroneTag, DroneTransformPatch, ForgeMarker, ForgeProjectData, ForgeView, ItwinProjectData, MapView, PlannerListItem, SitePlan, ProjectExid, SiteViewCameraListItem, SiteViewerType, DroneCameraTransform } from "@evercam/api/types";
2
+ import { AxiosRequestConfig } from "axios";
3
+ export declare const getFirebaseDbApi: () => string;
4
+ export declare const getFirebaseStorageUrl: () => string;
5
+ export declare const getFirebaseStorageToken: () => string;
6
+ export declare const getForgeTokenServerUrl: () => string;
7
+ export declare const _3dFirebaseApi: {
8
+ drone: {
9
+ getProjectInfo(projectExid: ProjectExid): Promise<DroneProjectData>;
10
+ getProjectTags(projectExid: ProjectExid): Promise<Record<string, DroneTag>>;
11
+ patchTags({ projectId, tags, }: {
12
+ projectId: ProjectExid;
13
+ tags: Record<string, DroneTag | null>;
14
+ }): Promise<void>;
15
+ saveMarkers({ projectId, markers, }: {
16
+ projectId: ProjectExid;
17
+ markers: Record<string, DroneMarker>;
18
+ }): Promise<void>;
19
+ patchTransform({ projectId, data, }: {
20
+ projectId: ProjectExid;
21
+ data: DroneTransformPatch;
22
+ }): Promise<void>;
23
+ saveTerrainPoints({ projectId, dateId, points, }: {
24
+ projectId: ProjectExid;
25
+ dateId: string;
26
+ points: Point3D[];
27
+ }): Promise<void>;
28
+ patchImageryPlan({ projectId, plan, }: {
29
+ projectId: ProjectExid;
30
+ plan: Record<string, DroneImageryPlan>;
31
+ }): Promise<void>;
32
+ deleteImageryPlan({ projectId, uuid, }: {
33
+ projectId: ProjectExid;
34
+ uuid: string;
35
+ }): Promise<void>;
36
+ saveImageryPlans({ projectId, plans, }: {
37
+ projectId: ProjectExid;
38
+ plans: Record<string, DroneImageryPlan>;
39
+ }): Promise<void>;
40
+ getBlackListIds(projectId: ProjectExid): Promise<string | null>;
41
+ saveBlackListIds({ projectId, ids, }: {
42
+ projectId: ProjectExid;
43
+ ids: string;
44
+ }): Promise<void>;
45
+ saveModel({ projectId, model, }: {
46
+ projectId: ProjectExid;
47
+ model: DroneModel;
48
+ }): Promise<void>;
49
+ saveModels({ projectId, models, }: {
50
+ projectId: ProjectExid;
51
+ models: DroneModel[];
52
+ }): Promise<void>;
53
+ saveBimData({ projectId, data, }: {
54
+ projectId: ProjectExid;
55
+ data: DroneBimData;
56
+ }): Promise<void>;
57
+ getBimTransparencyFlag(projectId: ProjectExid): Promise<boolean | null>;
58
+ saveCameraTransform({ projectId, isScene3D, transform, }: {
59
+ projectId: ProjectExid;
60
+ isScene3D: boolean;
61
+ transform: Record<string, DroneCameraTransform>;
62
+ }): Promise<void>;
63
+ };
64
+ _360: {
65
+ getProjectInfo(projectExid: ProjectExid, params?: {
66
+ config?: AxiosRequestConfig;
67
+ }): Promise<_360ProjectJsonResponse>;
68
+ getProjectsList(): Promise<_360ProjectListItem[]>;
69
+ updateProjectsList(items: Record<string, _360ProjectListItem>): Promise<void>;
70
+ updateProjectsListItem(index: number, data: _360ProjectListItem): Promise<void>;
71
+ deleteProject(projectId: string): Promise<void>;
72
+ updateProjectInfo(projectId: string, data: Partial<_360ProjectJsonResponse>): Promise<void>;
73
+ updateFloor(projectExid: ProjectExid, dateId: string, floorIndex: string, body: Partial<_360Scene["floors"][number]>): Promise<_360ProjectJsonResponse>;
74
+ getFloor({ projectId, dateId, floorId, }: {
75
+ projectId: ProjectExid;
76
+ dateId: number;
77
+ floorId: _360FloorId;
78
+ }): Promise<_360Floor>;
79
+ getAerialShotsFloor({ projectId, dateId, floorId, }: {
80
+ projectId: ProjectExid;
81
+ dateId: number;
82
+ floorId: _360FloorId;
83
+ }): Promise<_360Floor>;
84
+ update3DMarkers({ projectId, dateId, floorId, markers, }: {
85
+ projectId: ProjectExid;
86
+ dateId: number;
87
+ floorId: _360FloorId;
88
+ markers: Record<string, _360Marker3D>;
89
+ }): Promise<void>;
90
+ updateFloors({ projectId, dateId, floors, }: {
91
+ projectId: ProjectExid;
92
+ dateId: number;
93
+ floors: _360Scene["floors"];
94
+ }): Promise<void>;
95
+ deleteFloor({ projectId, dateId, floorId, }: {
96
+ projectId: ProjectExid;
97
+ dateId: number;
98
+ floorId: _360FloorId;
99
+ }): Promise<void>;
100
+ updateDates(projectId: ProjectExid, dates: _360Scene[]): Promise<void>;
101
+ updatePins({ projectId, dateId, floorId, pins, }: {
102
+ projectId: ProjectExid;
103
+ dateId: number;
104
+ floorId: _360FloorId;
105
+ pins: Record<string, _360Pin>;
106
+ }): Promise<void>;
107
+ getGPXText(url: string): Promise<string>;
108
+ updateRoute(projectExid: ProjectExid, dateId: string, floorIndex: string, body: Partial<_360SceneRoute>): Promise<void>;
109
+ updateFeatureFlag(projectID: string, dateID: string, floorID: string, featureFlagName: string, value: boolean): Promise<void>;
110
+ saveSteps(projectID: string, dateID: string, floorID: string, stepsValue: number): Promise<void>;
111
+ getDates({ projectID, prefix, }: {
112
+ projectID: string;
113
+ prefix?: string;
114
+ }): Promise<_360Scene[] | null>;
115
+ getFloorData({ projectID, dateID, floorID, prefix, }: _360FloorRef & {
116
+ prefix?: string;
117
+ }): Promise<_360FloorData>;
118
+ patchFloor({ projectID, dateID, floorID, body, }: _360FloorRef & {
119
+ body: Record<string, unknown>;
120
+ }): Promise<Record<string, unknown>>;
121
+ deleteMarkers({ projectID, dateID, floorID }: _360FloorRef): Promise<void>;
122
+ patchMarkers({ projectID, dateID, floorID, markers, }: _360FloorRef & {
123
+ markers: Record<string, unknown>;
124
+ }): Promise<Record<string, unknown>>;
125
+ putMarkers({ projectID, dateID, floorID, markers, }: _360FloorRef & {
126
+ markers: Record<string, unknown>;
127
+ }): Promise<any>;
128
+ putFloors({ projectID, dateID, floors, }: {
129
+ projectID: string;
130
+ dateID: string;
131
+ floors: unknown[];
132
+ }): Promise<unknown[]>;
133
+ deleteFloorData({ projectID, dateID, floorID, }: _360FloorRef): Promise<void>;
134
+ putDates({ projectID, dates, }: {
135
+ projectID: string;
136
+ dates: _360Scene[];
137
+ }): Promise<_360Scene[]>;
138
+ deleteDate({ projectID, dateID, }: {
139
+ projectID: string;
140
+ dateID: string;
141
+ }): Promise<void>;
142
+ getPins({ projectID, dateID, floorID, }: _360FloorRef): Promise<Record<string, _360PinData> | null>;
143
+ putPins({ projectID, dateID, floorID, pins, }: _360FloorRef & {
144
+ pins: Record<string, _360PinData>;
145
+ }): Promise<Record<string, _360PinData> | null>;
146
+ patchCalibrationDetails({ projectID, dateID, floorID, details, }: _360FloorRef & {
147
+ details: Partial<_360CalibrationDetails>;
148
+ }): Promise<Partial<_360CalibrationDetails>>;
149
+ getDateWalks(projectExid: ProjectExid, dateId: string): Promise<Record<string, unknown> | null>;
150
+ getRoute({ projectID, dateID, floorID, }: _360FloorRef): Promise<_360Route | null>;
151
+ getAerialShotDate({ projectID, dateID, }: {
152
+ projectID: string;
153
+ dateID: string;
154
+ }): Promise<string>;
155
+ updateGPXFile(projectExid: ProjectExid, dateId: string, floorIndex: string, gpxContent: string): Promise<void>;
156
+ getProjectDates(projectId: ProjectExid): Promise<_360Scene[]>;
157
+ getProjectAerialShotsDates(projectId: ProjectExid): Promise<_360Scene[]>;
158
+ getProjectDateFloors({ projectId, dateId, prefix, }: {
159
+ projectId: ProjectExid;
160
+ dateId: string | number;
161
+ prefix?: string;
162
+ }): Promise<_360Walk>;
163
+ };
164
+ forge: {
165
+ getAccessToken(): Promise<{
166
+ access_token: string;
167
+ }>;
168
+ getProjectInfo(projectExid: ProjectExid): Promise<ForgeProjectData | null>;
169
+ saveSavedView(projectId: string, payload: ForgeView): Promise<void>;
170
+ saveMarkers(projectId: string, markers: ForgeMarker[]): Promise<void>;
171
+ getForgeProject({ projectID, }: {
172
+ projectID: string;
173
+ }): Promise<_360ForgeProject | null>;
174
+ };
175
+ itwin: {
176
+ getProjectInfo(projectId: string): Promise<ItwinProjectData | null>;
177
+ clearBimCompare(projectId: string): Promise<void>;
178
+ clearSiteView(projectId: string, modelIndex: number): Promise<void>;
179
+ };
180
+ siteView: {
181
+ getCamerasList(): Promise<SiteViewCameraListItem[]>;
182
+ updateCamerasList(items: Record<number, SiteViewCameraListItem>): Promise<void>;
183
+ updateCamerasListItem(trueIndex: number, item: SiteViewCameraListItem): Promise<void>;
184
+ updateProjectData({ viewerType, projectId, data, }: {
185
+ viewerType: SiteViewerType;
186
+ projectId: ProjectExid;
187
+ data: ForgeProjectData | ItwinProjectData | DroneProjectDataPatch;
188
+ }): Promise<void>;
189
+ deleteProjectData(viewerType: SiteViewerType, projectId: ProjectExid): Promise<void>;
190
+ readAllData(dbLink: string): Promise<Record<string, unknown>>;
191
+ writeAllData(dbLink: string, data: Record<string, unknown>): Promise<void>;
192
+ };
193
+ map: {
194
+ getMapViews(projectExid: ProjectExid): Promise<MapView[]>;
195
+ updateMapViews(projectExid: ProjectExid, mapViews: Record<string, MapView>): Promise<void>;
196
+ };
197
+ safety: {
198
+ getTPulseLink(projectExid: ProjectExid): Promise<{
199
+ link?: string;
200
+ } | null>;
201
+ updateTPulseLink(projectExid: ProjectExid, link: string): Promise<void>;
202
+ };
203
+ planner: {
204
+ getPlannerList(): Promise<Record<string, PlannerListItem>>;
205
+ getPlannerItem(sitePlanId: string): Promise<PlannerListItem | null>;
206
+ saveSitePlanMetaData(sitePlanId: string, payload: PlannerListItem): Promise<void>;
207
+ getSitePlan(sitePlanId: string): Promise<SitePlan | null>;
208
+ saveSitePlan(sitePlanId: string, payload: SitePlan): Promise<void>;
209
+ };
210
+ };
@@ -0,0 +1,381 @@
1
+ import { FootageCreateUpdatePayload, HDDCreateUpdatePayload, HDDsQueryParams } from "@evercam/api/types/hdd";
2
+ import type { OAuthClient, OAuthClientWithSecret, AdminCreateOAuthClientPayload, UpdateOAuthClientPayload } from "@evercam/api/types/oauth";
3
+ import type { CamerasResponsePayload, CameraUpdateRequestPayload, PaginatedItems, AdminCamera, AdminProjectDetail, AdminProjectListItem, AdminHdd, AdminUser, ProgressPhotosCreateUpdateRequestPayload, Kit, PatchPayload, StorageProvidersResponsePayload, MediaFilterQueryParams, Media, MediaDeleteRequestPayload, AuditLogsParams, AuditLog, SnapshotExtractionQyeryParams, SnapshotExtraction, CameraCreateRequestPayload, CameraDeletePayload, SnapshotTestPayload, SnapshotTestResponse, DuplicatedCameraFields, DuplicatedCameraResponse, MergeDuplicatedCameraPayload, FetchCameraQueryParams, DeleteSnapshotQueryParams, SaveNotePayload, CameraNote, CreateCameraNotePayload, CompanyQueryParams, CompanySummary, CompanyUpdatePayload, SsoProvider, SsoUpdatePayload, SsoCreatePayload, SuppressionsQueryParams, Suppression, SnapshotExtractionType, KitQueryParams, KitCreatePayload, AdminKit, KitMetricStatsEntry, CameraLogsQueryParams, CameraLog, CameraAuditLogsQueryParams, CameraAuditLog, NvrQueryParams, Nvr, SiteVisitCamerasQueryParams, OfflineCameraQueryParams, OfflineCamera, OfflineCameraNoteResponse, UserStatsResponse, UserCameraResponse, UserProjectResponse, ProjectUsers, ProjectCamera, ProjectsQueryParams, ProjectStatusStats, ProjectCreateRequestPayload, ProjectCreateResponse, ProjectUpdateRequestPayload, RouterQueryParams, Router, RouterCreatePayload, GlobalSearchQueryParams, SimCreateUpdatePayload, SimsQueryParams, Sim, SendSmsPayload, SendSmsResponse, SmsHistoryResponse, SmsQueryParams, Sms, ProgressPhotosQueryParams, ProgressPhotoItem, progressPhotosHistoryQueryParams, ProgressPhotosHistory, AdminUserUpdateRequestPayload, AdminQueryParams, Admin, ImpersonateUserResponse, AdminUserQueryParams, AdminCompareQueryParams, AdminCompare, NvrCreatePayload, WidgetsListRequestPayload, AdminWidget, AdminWidgetFull, WidgetPayload, PaginationParams, KitStorageRequestPayload, AdminCompanyUser, AdminCompanyProject, CompanyKit, CompanyCameraSummary, Automation, KitStorage, KitFootageRequestPayload, CommentsListRequestPayload, Comment, KitFootage, KitAlarmItem, KitSupportChecklist, RecycleBin, RecycleBinQueryParams, TransferCloudRecordingsQueryParams, SnapshotTransfer, CheckCameraPortPayload, CameraStatusLog, KitBox, KitBoxCreatePayload, KitBoxQueryParams, AdminInvite, AdminSearchItem, WithZohoParams, ZohoDeskTicketSearchResponse, JsonObject, ProjectStorageQueryParams, ProjectStorage, StorageProvider, AnprExtraction, AnprExtractionCreatePayload } from "@evercam/api/types";
4
+ import { KitMetricId } from "@evercam/api/types";
5
+ import { Tag } from "@evercam/api/types/tag";
6
+ import type { AxiosRequestConfig } from "axios";
7
+ type AxiosPaginationRequestParams = AxiosRequestConfig & {
8
+ params: PaginationParams;
9
+ };
10
+ export declare const AdminApi: {
11
+ mediaHub: {
12
+ getAllMedia(params: {
13
+ params: Partial<MediaFilterQueryParams>;
14
+ }): Promise<PaginatedItems<Media>>;
15
+ deleteMedia(params: Partial<MediaDeleteRequestPayload>): Promise<void>;
16
+ };
17
+ auditLogs: {
18
+ getAuditLogs(params: AxiosRequestConfig & {
19
+ params: Partial<AuditLogsParams>;
20
+ }): Promise<PaginatedItems<AuditLog>[]>;
21
+ };
22
+ cameras: {
23
+ getCamerasStats(params: {
24
+ params: {
25
+ email?: string;
26
+ };
27
+ }): Promise<CamerasResponsePayload>;
28
+ rebootCamera(cameraId: string): Promise<{
29
+ message: string;
30
+ }>;
31
+ focusCamera(cameraId: string, device: string): Promise<{
32
+ message: string;
33
+ }>;
34
+ getStorageProviders(cameraId: string, params?: AxiosRequestConfig & {
35
+ unmaskSecretKeys: boolean;
36
+ }): Promise<StorageProvidersResponsePayload>;
37
+ createStorageProvider(cameraId: string, payload: StorageProvider): Promise<StorageProvidersResponsePayload>;
38
+ updateStorageProvider(cameraId: string, providerId: number, payload: StorageProvider): Promise<StorageProvidersResponsePayload>;
39
+ getStorageDetails(): Promise<JsonObject>;
40
+ getSnapshotExtractions(params: AxiosRequestConfig & {
41
+ params: Partial<SnapshotExtractionQyeryParams>;
42
+ }): Promise<PaginatedItems<SnapshotExtraction>>;
43
+ createCameras(payload: CameraCreateRequestPayload): Promise<{
44
+ cameras: [AdminCamera];
45
+ }>;
46
+ deleteCamera(exid: string, payload: CameraDeletePayload): Promise<void>;
47
+ restoreCamera(exid: string): Promise<{
48
+ message: string;
49
+ }>;
50
+ testSnapshot(payload: SnapshotTestPayload): Promise<SnapshotTestResponse>;
51
+ getDuplicateCameras(params: {
52
+ params: {
53
+ fields?: DuplicatedCameraFields[];
54
+ sort?: string;
55
+ };
56
+ }): Promise<PaginatedItems<DuplicatedCameraResponse>>;
57
+ mergeDuplicateCameras(payload: MergeDuplicatedCameraPayload): Promise<{
58
+ success: boolean;
59
+ }>;
60
+ getCameras(params: {
61
+ params: Partial<FetchCameraQueryParams>;
62
+ }, extraConfig?: AxiosRequestConfig): Promise<PaginatedItems<AdminCamera>>;
63
+ getCompares(params: {
64
+ params: AdminCompareQueryParams;
65
+ }): Promise<PaginatedItems<AdminCompare[]>>;
66
+ getCameraDetails(exid: string): Promise<AdminCamera>;
67
+ getCameraStatusLogs(exid: string, params: {
68
+ params: {
69
+ from: string;
70
+ to: string;
71
+ };
72
+ }): Promise<CameraStatusLog[]>;
73
+ deleteSnapshots(cameraId: string, params: DeleteSnapshotQueryParams): Promise<void>;
74
+ transferCloudRecordings(cameraId: string, params: TransferCloudRecordingsQueryParams): Promise<void>;
75
+ refreshDeviceSettings(cameraId: string): Promise<void>;
76
+ saveNote(cameraId: string, params: SaveNotePayload): Promise<CameraNote>;
77
+ saveCameraNote(cameraId: string, params: CreateCameraNotePayload): Promise<{
78
+ message: string;
79
+ }>;
80
+ update(cameraId: string, params: CameraUpdateRequestPayload): Promise<CamerasResponsePayload>;
81
+ transferOwnership(cameraId: string, newOwnerId: number): Promise<void>;
82
+ portCheck(payload: {
83
+ params: CheckCameraPortPayload;
84
+ }): Promise<CheckCameraPortPayload & {
85
+ open: boolean;
86
+ }>;
87
+ };
88
+ companies: {
89
+ show(id: string, config?: AxiosRequestConfig & {
90
+ params?: WithZohoParams;
91
+ }): Promise<CompanySummary>;
92
+ getCompanyUsers(id: string, params: AxiosPaginationRequestParams): Promise<PaginatedItems<AdminCompanyUser>>;
93
+ getCompanyProjects(id: string, params: AxiosPaginationRequestParams): Promise<PaginatedItems<AdminCompanyProject>>;
94
+ getCompanyKits(id: string, params: AxiosPaginationRequestParams): Promise<PaginatedItems<CompanyKit>>;
95
+ getCompanyCameras(id: string, params: AxiosPaginationRequestParams): Promise<PaginatedItems<CompanyCameraSummary>>;
96
+ getCompanies(params: {
97
+ params: Partial<CompanyQueryParams>;
98
+ }): Promise<PaginatedItems<CompanySummary>>;
99
+ updateCompany(id: string, params: CompanyUpdatePayload): Promise<Omit<CompanyUpdatePayload, "linkedinUrl">>;
100
+ deleteCompany(params: {
101
+ ids: string | string[];
102
+ }): Promise<{
103
+ success: true;
104
+ }>;
105
+ };
106
+ sso: {
107
+ getProviders(params: {
108
+ params: PaginationParams;
109
+ }): Promise<SsoProvider[]>;
110
+ updateProvider(id: string, params: SsoUpdatePayload): Promise<SsoProvider>;
111
+ createProvider(params: SsoCreatePayload): Promise<SsoProvider>;
112
+ deleteProviders(ids: string[]): Promise<{
113
+ success: true;
114
+ }>;
115
+ };
116
+ oauthClients: {
117
+ index(): Promise<{
118
+ items: OAuthClient[];
119
+ }>;
120
+ show(id: number): Promise<OAuthClient>;
121
+ create(payload: AdminCreateOAuthClientPayload): Promise<OAuthClientWithSecret>;
122
+ update(id: number, payload: UpdateOAuthClientPayload): Promise<OAuthClient>;
123
+ delete(id: number): Promise<void>;
124
+ regenerateSecret(id: number): Promise<OAuthClientWithSecret>;
125
+ };
126
+ emailing: {
127
+ performEmailing(template: string, params: JsonObject): Promise<void>;
128
+ suppressions(params: {
129
+ params: SuppressionsQueryParams;
130
+ }): Promise<PaginatedItems<Suppression[]>>;
131
+ deleteSuppression(id: number): Promise<void>;
132
+ };
133
+ extractions: {
134
+ updateCloudRecordings(cameraId: string, params: JsonObject): Promise<void>;
135
+ addExtraction(cameraId: string, params: SnapshotExtractionQyeryParams): Promise<PaginatedItems<SnapshotExtraction>>;
136
+ deleteSnapshotExtraction(cameraId: string, extractionId: number, params: {
137
+ type: SnapshotExtractionType;
138
+ hardDelete?: boolean;
139
+ }): Promise<void>;
140
+ getExtraction(cameraExid: string, extractionId: number): Promise<SnapshotExtraction>;
141
+ reprocessExtraction(cameraId: string, extractionId: number): Promise<void>;
142
+ };
143
+ anprExtractions: {
144
+ list(cameraExid: string): Promise<{
145
+ data: AnprExtraction[];
146
+ }>;
147
+ create(cameraExid: string, payload: AnprExtractionCreatePayload): Promise<{
148
+ data: AnprExtraction;
149
+ }>;
150
+ delete(cameraExid: string, id: number): Promise<{
151
+ message: string;
152
+ }>;
153
+ };
154
+ kits: {
155
+ getAllKits(params: AxiosRequestConfig & {
156
+ params: KitQueryParams;
157
+ }): Promise<PaginatedItems<Kit[]>>;
158
+ getKit(kitId: number): Promise<Kit>;
159
+ createKit(params: KitCreatePayload): Promise<AdminKit>;
160
+ updateKit(id: string, params: PatchPayload<Kit>): Promise<import("axios").AxiosResponse<any, any>>;
161
+ deleteKit(id: string, params: JsonObject): Promise<void>;
162
+ getKitStats<T = KitMetricStatsEntry>({ kitId, metric, fromDate, toDate, }: {
163
+ kitId: number;
164
+ metric: KitMetricId;
165
+ fromDate: string;
166
+ toDate: string;
167
+ }): Promise<T[]>;
168
+ attachTag(kitId: number, tagId: number): Promise<void>;
169
+ detachTag(kitId: number, tagId: number): Promise<void>;
170
+ getStorages(params: {
171
+ params: KitStorageRequestPayload;
172
+ }): Promise<PaginatedItems<KitStorage[]>>;
173
+ getFootage(id: number, params?: {
174
+ params?: KitFootageRequestPayload;
175
+ }): Promise<KitFootage[]>;
176
+ getAlarms(kitId: number): Promise<KitAlarmItem[]>;
177
+ runSupportChecklist(kitId: number): Promise<KitSupportChecklist>;
178
+ getBoxes(params: {
179
+ params: Partial<KitBoxQueryParams>;
180
+ }): Promise<PaginatedItems<KitBox>>;
181
+ createBox(params: KitBoxCreatePayload): Promise<KitBox>;
182
+ updateBox(id: string, params: KitBoxCreatePayload): Promise<KitBox>;
183
+ };
184
+ logs: {
185
+ getAllCamerasStatusLogs(params: {
186
+ params: CameraLogsQueryParams;
187
+ }): Promise<{
188
+ data: CameraLog[];
189
+ }>;
190
+ getCameraLogs(cameraId: string, params: CameraAuditLogsQueryParams): Promise<PaginatedItems<CameraAuditLog[]>>;
191
+ togglePinNote(id: string): Promise<PaginatedItems<CameraAuditLog[]>>;
192
+ };
193
+ nvrs: {
194
+ getNvrs(params: {
195
+ params: NvrQueryParams;
196
+ }): Promise<PaginatedItems<Nvr[]>>;
197
+ createNvr(params: NvrCreatePayload): Promise<Nvr>;
198
+ updateNvr(id: string, params: PatchPayload<Nvr>): Promise<Nvr>;
199
+ rebootNVR(cameraId: string): Promise<{
200
+ message: string;
201
+ }>;
202
+ };
203
+ recycleBin: {
204
+ getAllDeleted(params: {
205
+ params: RecycleBinQueryParams;
206
+ }): Promise<PaginatedItems<RecycleBin[]>>;
207
+ restore(params: {
208
+ type: string;
209
+ camera_ids: number[];
210
+ project_ids: number[];
211
+ }): Promise<void>;
212
+ };
213
+ offlineCameras: {
214
+ getSiteVisitCameras(params: {
215
+ params: Partial<SiteVisitCamerasQueryParams>;
216
+ }): Promise<PaginatedItems<AdminCamera>>;
217
+ getOfflineCameras(params: {
218
+ params: Partial<OfflineCameraQueryParams>;
219
+ }): Promise<PaginatedItems<OfflineCamera>>;
220
+ getOfflineCamerasLastNote(params: {
221
+ cameraIds: number[];
222
+ }): Promise<OfflineCameraNoteResponse>;
223
+ };
224
+ projects: {
225
+ index(params: {
226
+ params: Partial<ProjectsQueryParams>;
227
+ }): Promise<PaginatedItems<AdminProjectListItem>>;
228
+ show(exid: string, params?: WithZohoParams): Promise<{
229
+ data: AdminProjectDetail;
230
+ }>;
231
+ getUsers(id: string): Promise<ProjectUsers>;
232
+ getCameras(id: string): Promise<{
233
+ data: ProjectCamera[];
234
+ }>;
235
+ getProjectsStats(): Promise<ProjectStatusStats>;
236
+ createProject(params: ProjectCreateRequestPayload): Promise<ProjectCreateResponse>;
237
+ updateProject(projectExid: string, params: Partial<ProjectUpdateRequestPayload>): Promise<ProjectCreateResponse>;
238
+ deleteProject(projectExid: string): Promise<{
239
+ success: boolean;
240
+ }>;
241
+ addToProject(projectExid: string, params: {
242
+ cameraExids: string[];
243
+ }): Promise<void>;
244
+ getProjectStorages(params: {
245
+ params: Partial<ProjectStorageQueryParams>;
246
+ }): Promise<PaginatedItems<ProjectStorage[]>>;
247
+ retryProjectStorage(id: number): Promise<{
248
+ message: string;
249
+ }>;
250
+ };
251
+ routers: {
252
+ getRouters(params: {
253
+ params: Partial<RouterQueryParams>;
254
+ }): Promise<PaginatedItems<Router[]>>;
255
+ getRouterTypes(): Promise<string[]>;
256
+ createRouter(params: RouterCreatePayload): Promise<{
257
+ routerId: number;
258
+ }>;
259
+ updateRouter(id: number, params: RouterCreatePayload): Promise<{
260
+ success: boolean;
261
+ }>;
262
+ deleteRouter(id: number): Promise<void>;
263
+ getRouter(id: number): Promise<Router>;
264
+ };
265
+ search: {
266
+ search(params: {
267
+ params: GlobalSearchQueryParams;
268
+ }): Promise<PaginatedItems<AdminSearchItem>>;
269
+ };
270
+ hdds: {
271
+ getHdds(payload: {
272
+ projectId: string;
273
+ companyId: string;
274
+ }): Promise<AdminHdd[]>;
275
+ getAllHdds(params: {
276
+ params: Partial<HDDsQueryParams>;
277
+ }): Promise<PaginatedItems<AdminHdd>>;
278
+ deleteHdd(hddId: number): Promise<void>;
279
+ saveHdd(params: HDDCreateUpdatePayload): Promise<void>;
280
+ updateHdd(hddId: number, params: HDDCreateUpdatePayload): Promise<void>;
281
+ saveFootage(hddId: number, params: FootageCreateUpdatePayload): Promise<void>;
282
+ deleteFootage(hddId: number, footageId: number): Promise<void>;
283
+ updateFootage(hddId: number, footageId: number, params: FootageCreateUpdatePayload): Promise<void>;
284
+ };
285
+ shares: {
286
+ getInvites(params: AxiosPaginationRequestParams): Promise<PaginatedItems<AdminInvite>>;
287
+ };
288
+ sims: {
289
+ deleteSim(simId: number): Promise<{
290
+ deleted: boolean;
291
+ }>;
292
+ createSim(params: Omit<SimCreateUpdatePayload, "cameraId">): Promise<{
293
+ success: boolean;
294
+ }>;
295
+ updateSim(simId: number, params: SimCreateUpdatePayload): Promise<{
296
+ success: boolean;
297
+ }>;
298
+ getSims(params: {
299
+ params: Partial<SimsQueryParams>;
300
+ }): Promise<PaginatedItems<Sim[]>>;
301
+ getSimProviders(): Promise<string[]>;
302
+ getBillPayers(): Promise<string[]>;
303
+ };
304
+ sms: {
305
+ sendSms(number: string, params: SendSmsPayload): Promise<SendSmsResponse>;
306
+ getSimHistory(number: string, params: AxiosPaginationRequestParams): Promise<PaginatedItems<SmsHistoryResponse>>;
307
+ getSms(params: {
308
+ params: Partial<SmsQueryParams>;
309
+ }): Promise<PaginatedItems<Sms[]>>;
310
+ };
311
+ progressPhotos: {
312
+ getProgressPhotos(params: {
313
+ params: Partial<ProgressPhotosQueryParams>;
314
+ }): Promise<PaginatedItems<ProgressPhotoItem[]>>;
315
+ getProgressPhotosHistory(params: {
316
+ params: Partial<progressPhotosHistoryQueryParams>;
317
+ }): Promise<ProgressPhotosHistory>;
318
+ getProgressPhotoTemplate({ id, }: {
319
+ id: string;
320
+ }): Promise<{
321
+ progressPhoto: string;
322
+ }>;
323
+ update(id: string, payload: ProgressPhotosCreateUpdateRequestPayload): Promise<Automation>;
324
+ };
325
+ tags: {
326
+ index(): Promise<Tag[]>;
327
+ create(tag: Tag): Promise<Tag>;
328
+ update(tag: Tag): Promise<Tag>;
329
+ delete(tag: Tag): Promise<void>;
330
+ };
331
+ users: {
332
+ updateUser(id: number, params: Partial<AdminUserUpdateRequestPayload>): Promise<AdminUser>;
333
+ getAdmins(params: {
334
+ params: Partial<AdminQueryParams>;
335
+ }): Promise<PaginatedItems<Admin[]>>;
336
+ deleteAdmin(email: string): Promise<void | {
337
+ message: string;
338
+ }>;
339
+ makeAdmin(email: string): Promise<void | {
340
+ message: string;
341
+ }>;
342
+ deleteUser(email: string, params: {
343
+ verifEmail: string;
344
+ }): Promise<void | {
345
+ message: string;
346
+ }>;
347
+ impersonateUser(email: string): Promise<ImpersonateUserResponse>;
348
+ getUsers(params: {
349
+ params: Partial<AdminUserQueryParams>;
350
+ }): Promise<PaginatedItems<AdminUser>>;
351
+ show(id: number, params?: WithZohoParams): Promise<UserStatsResponse>;
352
+ getProjects(id: number): Promise<UserProjectResponse>;
353
+ getCameras(id: number): Promise<UserCameraResponse>;
354
+ getUserPasswordResetLink(email: string): Promise<{
355
+ passwordResetLink: string;
356
+ }>;
357
+ };
358
+ widgets: {
359
+ index(params: {
360
+ params: Partial<WidgetsListRequestPayload>;
361
+ }): Promise<PaginatedItems<AdminWidget>>;
362
+ show(id: number): Promise<AdminWidgetFull>;
363
+ update(id: number, payload: WidgetPayload): Promise<AdminWidgetFull>;
364
+ delete(id: number): Promise<import("axios").AxiosResponse<any, any>>;
365
+ };
366
+ zohoDesk: {
367
+ searchTickets(params: JsonObject): Promise<ZohoDeskTicketSearchResponse>;
368
+ };
369
+ comments: {
370
+ index(params: {
371
+ params: Partial<CommentsListRequestPayload>;
372
+ }): Promise<PaginatedItems<Comment>>;
373
+ };
374
+ snapshotTransfers: {
375
+ index(params: AxiosRequestConfig & {
376
+ params: Partial<TransferCloudRecordingsQueryParams>;
377
+ }): Promise<PaginatedItems<SnapshotTransfer>>;
378
+ cancel(id: number): Promise<SnapshotTransfer>;
379
+ };
380
+ };
381
+ export {};