@evercam/api 1.0.0-22d695927 → 1.0.0-231be134a

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 (93) hide show
  1. package/README.md +4 -0
  2. package/dist/api/api/3dFirebaseApi.d.ts +204 -10
  3. package/dist/api/api/adminApi.d.ts +139 -98
  4. package/dist/api/api/aiApi.d.ts +125 -82
  5. package/dist/api/api/authzApi.d.ts +34 -15
  6. package/dist/api/api/client/axios.d.ts +2 -1
  7. package/dist/api/api/client/swr/Swr.d.ts +1 -1
  8. package/dist/api/api/evercamApi.d.ts +146 -99
  9. package/dist/api/api/evercamLabsApi.d.ts +9 -7
  10. package/dist/api/api/exNvrApi.d.ts +1 -1
  11. package/dist/api/api/ingestApi.d.ts +121 -33
  12. package/dist/api/api/ptzApi.d.ts +12 -3
  13. package/dist/api/api/videoWallApi.d.ts +7 -7
  14. package/dist/api/api/weatherApi.d.ts +2 -2
  15. package/dist/api/types/360.d.ts +310 -9
  16. package/dist/api/types/aconex.d.ts +104 -6
  17. package/dist/api/types/admin.d.ts +51 -0
  18. package/dist/api/types/aiConfigs.d.ts +154 -0
  19. package/dist/api/types/analytics.d.ts +174 -43
  20. package/dist/api/types/anpr.d.ts +53 -13
  21. package/dist/api/types/auditLogs.d.ts +19 -1
  22. package/dist/api/types/authz.d.ts +107 -0
  23. package/dist/api/types/autodesk.d.ts +7 -7
  24. package/dist/api/types/automation.d.ts +86 -1
  25. package/dist/api/types/axios.d.ts +19 -10
  26. package/dist/api/types/bim.d.ts +37 -6
  27. package/dist/api/types/camera.d.ts +109 -92
  28. package/dist/api/types/comments.d.ts +26 -11
  29. package/dist/api/types/company.d.ts +43 -2
  30. package/dist/api/types/compare.d.ts +20 -5
  31. package/dist/api/types/connector.d.ts +5 -5
  32. package/dist/api/types/coolify.d.ts +20 -2
  33. package/dist/api/types/copilot.d.ts +11 -6
  34. package/dist/api/types/credentials.d.ts +1 -0
  35. package/dist/api/types/detections.d.ts +23 -32
  36. package/dist/api/types/drone.d.ts +96 -6
  37. package/dist/api/types/errors.d.ts +12 -0
  38. package/dist/api/types/gateReport.d.ts +50 -158
  39. package/dist/api/types/gateReportManagement.d.ts +175 -0
  40. package/dist/api/types/hammertech.d.ts +98 -0
  41. package/dist/api/types/hdd.d.ts +26 -1
  42. package/dist/api/types/index.d.ts +15 -1
  43. package/dist/api/types/ingest.d.ts +114 -3
  44. package/dist/api/types/kit.d.ts +80 -8
  45. package/dist/api/types/map.d.ts +12 -0
  46. package/dist/api/types/media.d.ts +10 -3
  47. package/dist/api/types/notification.d.ts +32 -2
  48. package/dist/api/types/oauth.d.ts +62 -0
  49. package/dist/api/types/observations.d.ts +85 -0
  50. package/dist/api/types/planner.d.ts +101 -1
  51. package/dist/api/types/posthog.d.ts +35 -0
  52. package/dist/api/types/procore.d.ts +13 -6
  53. package/dist/api/types/progressPhoto.d.ts +6 -32
  54. package/dist/api/types/project.d.ts +137 -18
  55. package/dist/api/types/recording.d.ts +9 -12
  56. package/dist/api/types/recycleBin.d.ts +14 -0
  57. package/dist/api/types/ring.d.ts +53 -0
  58. package/dist/api/types/roi.d.ts +4 -3
  59. package/dist/api/types/routeParams.d.ts +2 -1
  60. package/dist/api/types/router.d.ts +20 -1
  61. package/dist/api/types/shared.d.ts +30 -9
  62. package/dist/api/types/shares.d.ts +6 -144
  63. package/dist/api/types/sim.d.ts +6 -6
  64. package/dist/api/types/siteAnalytics.d.ts +191 -46
  65. package/dist/api/types/siteAnalyticsManagement.d.ts +92 -0
  66. package/dist/api/types/siteView.d.ts +73 -0
  67. package/dist/api/types/smartSeach.d.ts +5 -0
  68. package/dist/api/types/snapshots.d.ts +55 -1
  69. package/dist/api/types/sso.d.ts +55 -0
  70. package/dist/api/types/storageProvider.d.ts +19 -0
  71. package/dist/api/types/storyblok.d.ts +40 -0
  72. package/dist/api/types/streaming.d.ts +3 -3
  73. package/dist/api/types/tag.d.ts +1 -1
  74. package/dist/api/types/time.d.ts +4 -18
  75. package/dist/api/types/timelapse.d.ts +8 -5
  76. package/dist/api/types/user.d.ts +106 -35
  77. package/dist/api/types/videoWall.d.ts +47 -14
  78. package/dist/api/types/weather.d.ts +77 -11
  79. package/dist/api/types/widget.d.ts +96 -16
  80. package/dist/api/types/xweather.d.ts +4 -4
  81. package/dist/index.js +2266 -1013
  82. package/dist/index.js.map +1 -1
  83. package/dist/index.umd.cjs +1 -1
  84. package/dist/index.umd.cjs.map +1 -1
  85. package/dist/shared/types/components.d.ts +199 -17
  86. package/dist/shared/types/customDataTableFilters.d.ts +10 -0
  87. package/dist/shared/types/imagePlayer.d.ts +10 -3
  88. package/dist/shared/types/index.d.ts +3 -0
  89. package/dist/shared/types/observations.d.ts +21 -0
  90. package/dist/shared/types/rbac.d.ts +67 -0
  91. package/dist/shared/types/timeline.d.ts +2 -1
  92. package/package.json +6 -4
  93. package/dist/api/types/storageServers.d.ts +0 -4
package/README.md CHANGED
@@ -1,3 +1,7 @@
1
1
  # @evercam/api
2
2
 
3
3
  //
4
+
5
+
6
+
7
+
@@ -1,16 +1,210 @@
1
- import { _360ProjectJsonResponse, DroneProjectJsonResponse, ProjectExid } from "@evercam/api/types";
2
- export declare const getFirebaseDbApi: () => string | null | undefined;
3
- export declare const getFirebaseStorageUrl: () => string | null | undefined;
4
- export declare const getFirebaseStorageToken: () => string | null | undefined;
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;
5
7
  export declare const _3dFirebaseApi: {
6
8
  drone: {
7
- getProjectInfo(projectExid: ProjectExid): Promise<DroneProjectJsonResponse>;
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>;
8
63
  };
9
64
  _360: {
10
- getProjectInfo(projectExid: ProjectExid): Promise<_360ProjectJsonResponse>;
11
- updateFloor(projectExid: ProjectExid, dateId: string, floorIndex: string, body: any): Promise<_360ProjectJsonResponse>;
12
- updateFeatureFlag(projectID: string, dateID: string, floorID: string, featureFlagName: string, value: boolean): Promise<any>;
13
- saveSteps(projectID: string, dateID: string, floorID: string, stepsValue: number): Promise<any>;
14
- updateGPXFile(projectExid: ProjectExid, dateId: string, floorIndex: string, gpxContent: any): Promise<any>;
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>;
15
209
  };
16
210
  };
@@ -1,7 +1,12 @@
1
- import { FootageCreateUpdatePayload, HDDCreateUpdatePayload, HDDsQueryParams } from "@/types/hdd";
2
- import type { CamerasResponsePayload, CameraUpdateRequestPayload, PaginatedItems, AdminCamera, Project, Hdd, AdminUser, ProgressPhotosCreateUpdateRequestPayload, 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, 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, KitStorageRequestPayload, CompanyUser, CompanyProject, Automation, KitStorage, KitFootageRequestPayload, KitFootageResponsePayload } from "@evercam/api/types";
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";
3
4
  import { KitMetricId } from "@evercam/api/types";
4
- import { Tag } from "@/types/tag";
5
+ import { Tag } from "@evercam/api/types/tag";
6
+ import type { AxiosRequestConfig } from "axios";
7
+ type AxiosPaginationRequestParams = AxiosRequestConfig & {
8
+ params: PaginationParams;
9
+ };
5
10
  export declare const AdminApi: {
6
11
  mediaHub: {
7
12
  getAllMedia(params: {
@@ -10,7 +15,7 @@ export declare const AdminApi: {
10
15
  deleteMedia(params: Partial<MediaDeleteRequestPayload>): Promise<void>;
11
16
  };
12
17
  auditLogs: {
13
- getAuditLogs(params: {
18
+ getAuditLogs(params: AxiosRequestConfig & {
14
19
  params: Partial<AuditLogsParams>;
15
20
  }): Promise<PaginatedItems<AuditLog>[]>;
16
21
  };
@@ -26,9 +31,13 @@ export declare const AdminApi: {
26
31
  focusCamera(cameraId: string, device: string): Promise<{
27
32
  message: string;
28
33
  }>;
29
- getStorageServers(): Promise<StorageServersResponsePayload>;
30
- getStorageDetails(): Promise<import("axios").AxiosResponse<any, any>>;
31
- getSnapshotExtractions(params: {
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 & {
32
41
  params: Partial<SnapshotExtractionQyeryParams>;
33
42
  }): Promise<PaginatedItems<SnapshotExtraction>>;
34
43
  createCameras(payload: CameraCreateRequestPayload): Promise<{
@@ -50,12 +59,19 @@ export declare const AdminApi: {
50
59
  }>;
51
60
  getCameras(params: {
52
61
  params: Partial<FetchCameraQueryParams>;
53
- }): Promise<PaginatedItems<AdminCamera>>;
62
+ }, extraConfig?: AxiosRequestConfig): Promise<PaginatedItems<AdminCamera>>;
54
63
  getCompares(params: {
55
64
  params: AdminCompareQueryParams;
56
65
  }): Promise<PaginatedItems<AdminCompare[]>>;
57
66
  getCameraDetails(exid: string): Promise<AdminCamera>;
67
+ getCameraStatusLogs(exid: string, params: {
68
+ params: {
69
+ from: string;
70
+ to: string;
71
+ };
72
+ }): Promise<CameraStatusLog[]>;
58
73
  deleteSnapshots(cameraId: string, params: DeleteSnapshotQueryParams): Promise<void>;
74
+ transferCloudRecordings(cameraId: string, params: TransferCloudRecordingsQueryParams): Promise<void>;
59
75
  refreshDeviceSettings(cameraId: string): Promise<void>;
60
76
  saveNote(cameraId: string, params: SaveNotePayload): Promise<CameraNote>;
61
77
  saveCameraNote(cameraId: string, params: CreateCameraNotePayload): Promise<{
@@ -63,88 +79,107 @@ export declare const AdminApi: {
63
79
  }>;
64
80
  update(cameraId: string, params: CameraUpdateRequestPayload): Promise<CamerasResponsePayload>;
65
81
  transferOwnership(cameraId: string, newOwnerId: number): Promise<void>;
82
+ portCheck(payload: {
83
+ params: CheckCameraPortPayload;
84
+ }): Promise<CheckCameraPortPayload & {
85
+ open: boolean;
86
+ }>;
66
87
  };
67
88
  companies: {
68
- show(id: string, params: {
69
- with_zoho?: boolean;
70
- }): Promise<Company>;
71
- getCompanyUsers(id: string, params: {
72
- params: {
73
- page: number;
74
- limit: number;
75
- };
76
- }): Promise<PaginatedItems<CompanyUser>>;
77
- getCompanyProjects(id: string, params: {
78
- params: {
79
- page: number;
80
- limit: number;
81
- };
82
- }): Promise<PaginatedItems<CompanyProject>>;
83
- getCompanyKits(id: string, params: {
84
- params: {
85
- page: number;
86
- limit: number;
87
- sort?: string;
88
- };
89
- }): Promise<PaginatedItems<Kit[]>>;
90
- getCompanyCameras(id: string, params: Record<string, string>): Promise<import("axios").AxiosResponse<any, any>>;
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>>;
91
96
  getCompanies(params: {
92
97
  params: Partial<CompanyQueryParams>;
93
- }): Promise<PaginatedItems<Company[]>>;
98
+ }): Promise<PaginatedItems<CompanySummary>>;
94
99
  updateCompany(id: string, params: CompanyUpdatePayload): Promise<Omit<CompanyUpdatePayload, "linkedinUrl">>;
95
100
  deleteCompany(params: {
96
101
  ids: string | string[];
97
102
  }): Promise<{
98
103
  success: true;
99
104
  }>;
100
- reSyncCompanies(params: {
101
- companyIds: string[];
102
- }): Promise<{
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<{
103
113
  success: true;
104
114
  }>;
105
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
+ };
106
126
  emailing: {
107
- performEmailing(template: string, params: Record<string, unknown>): Promise<import("axios").AxiosResponse<any, any>>;
127
+ performEmailing(template: string, params: JsonObject): Promise<void>;
108
128
  suppressions(params: {
109
129
  params: SuppressionsQueryParams;
110
130
  }): Promise<PaginatedItems<Suppression[]>>;
111
131
  deleteSuppression(id: number): Promise<void>;
112
132
  };
113
133
  extractions: {
114
- updateCloudRecordings(cameraId: string, params: Record<string, unknown>): Promise<import("axios").AxiosResponse<any, any>>;
134
+ updateCloudRecordings(cameraId: string, params: JsonObject): Promise<void>;
115
135
  addExtraction(cameraId: string, params: SnapshotExtractionQyeryParams): Promise<PaginatedItems<SnapshotExtraction>>;
116
- getExtractionStatus(cameraId: string, extractionId: number, params: {
117
- type: SnapshotExtractionType;
118
- }): Promise<{
119
- status: string;
120
- jpegs: number;
121
- }>;
122
136
  deleteSnapshotExtraction(cameraId: string, extractionId: number, params: {
123
137
  type: SnapshotExtractionType;
138
+ hardDelete?: boolean;
124
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
+ }>;
125
153
  };
126
154
  kits: {
127
- getAllKits(params: {
155
+ getAllKits(params: AxiosRequestConfig & {
128
156
  params: KitQueryParams;
129
157
  }): Promise<PaginatedItems<Kit[]>>;
130
158
  getKit(kitId: number): Promise<Kit>;
131
159
  createKit(params: KitCreatePayload): Promise<AdminKit>;
132
160
  updateKit(id: string, params: PatchPayload<Kit>): Promise<import("axios").AxiosResponse<any, any>>;
133
- deleteKit(id: string, params: Record<string, unknown>): Promise<import("axios").AxiosResponse<any, any>>;
134
- getKitStats({ kitId, metric, fromDate, toDate, }: {
161
+ deleteKit(id: string, params: JsonObject): Promise<void>;
162
+ getKitStats<T = KitMetricStatsEntry>({ kitId, metric, fromDate, toDate, }: {
135
163
  kitId: number;
136
164
  metric: KitMetricId;
137
165
  fromDate: string;
138
166
  toDate: string;
139
- }): Promise<import("axios").AxiosResponse<any, any>>;
167
+ }): Promise<T[]>;
140
168
  attachTag(kitId: number, tagId: number): Promise<void>;
141
169
  detachTag(kitId: number, tagId: number): Promise<void>;
142
170
  getStorages(params: {
143
171
  params: KitStorageRequestPayload;
144
172
  }): Promise<PaginatedItems<KitStorage[]>>;
145
- getFootage(id: number, params: {
146
- params: KitFootageRequestPayload;
147
- }): Promise<KitFootageResponsePayload[]>;
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>;
148
183
  };
149
184
  logs: {
150
185
  getAllCamerasStatusLogs(params: {
@@ -152,21 +187,29 @@ export declare const AdminApi: {
152
187
  }): Promise<{
153
188
  data: CameraLog[];
154
189
  }>;
155
- getCameraLogs(cameraId: string, payload: {
156
- params: CameraAuditLogsQueryParams;
157
- }): Promise<PaginatedItems<CameraAuditLog[]>>;
190
+ getCameraLogs(cameraId: string, params: CameraAuditLogsQueryParams): Promise<PaginatedItems<CameraAuditLog[]>>;
158
191
  togglePinNote(id: string): Promise<PaginatedItems<CameraAuditLog[]>>;
159
192
  };
160
193
  nvrs: {
161
194
  getNvrs(params: {
162
195
  params: NvrQueryParams;
163
196
  }): Promise<PaginatedItems<Nvr[]>>;
164
- createNvr(params: NvrCreatePayload): Promise<import("axios").AxiosResponse<any, any>>;
165
- updateNvr(id: string, params: PatchPayload<Nvr>): Promise<import("axios").AxiosResponse<any, any>>;
197
+ createNvr(params: NvrCreatePayload): Promise<Nvr>;
198
+ updateNvr(id: string, params: PatchPayload<Nvr>): Promise<Nvr>;
166
199
  rebootNVR(cameraId: string): Promise<{
167
200
  message: string;
168
201
  }>;
169
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
+ };
170
213
  offlineCameras: {
171
214
  getSiteVisitCameras(params: {
172
215
  params: Partial<SiteVisitCamerasQueryParams>;
@@ -181,9 +224,9 @@ export declare const AdminApi: {
181
224
  projects: {
182
225
  index(params: {
183
226
  params: Partial<ProjectsQueryParams>;
184
- }): Promise<PaginatedItems<Project>>;
185
- show(exid: string, params?: Record<string, unknown>): Promise<{
186
- data: Project;
227
+ }): Promise<PaginatedItems<AdminProjectListItem>>;
228
+ show(exid: string, params?: WithZohoParams): Promise<{
229
+ data: AdminProjectDetail;
187
230
  }>;
188
231
  getUsers(id: string): Promise<ProjectUsers>;
189
232
  getCameras(id: string): Promise<{
@@ -198,6 +241,12 @@ export declare const AdminApi: {
198
241
  addToProject(projectExid: string, params: {
199
242
  cameraExids: string[];
200
243
  }): Promise<void>;
244
+ getProjectStorages(params: {
245
+ params: Partial<ProjectStorageQueryParams>;
246
+ }): Promise<PaginatedItems<ProjectStorage[]>>;
247
+ retryProjectStorage(id: number): Promise<{
248
+ message: string;
249
+ }>;
201
250
  };
202
251
  routers: {
203
252
  getRouters(params: {
@@ -216,45 +265,25 @@ export declare const AdminApi: {
216
265
  search: {
217
266
  search(params: {
218
267
  params: GlobalSearchQueryParams;
219
- }): Promise<PaginatedItems<Record<string, unknown>>>;
268
+ }): Promise<PaginatedItems<AdminSearchItem>>;
220
269
  };
221
270
  hdds: {
222
271
  getHdds(payload: {
223
272
  projectId: string;
224
273
  companyId: string;
225
- }): Promise<Hdd[]>;
274
+ }): Promise<AdminHdd[]>;
226
275
  getAllHdds(params: {
227
276
  params: Partial<HDDsQueryParams>;
228
- }): Promise<import("axios").AxiosResponse<any, any>>;
229
- deleteHdd(hddId: number): Promise<import("axios").AxiosResponse<any, any>>;
230
- saveHdd(params: HDDCreateUpdatePayload): Promise<import("axios").AxiosResponse<any, any>>;
231
- updateHdd(hddId: number, params: HDDCreateUpdatePayload): Promise<import("axios").AxiosResponse<any, any>>;
232
- saveFootage(hddId: number, params: FootageCreateUpdatePayload): Promise<import("axios").AxiosResponse<any, any>>;
233
- deleteFootage(hddId: number, footageId: number): Promise<import("axios").AxiosResponse<any, any>>;
234
- updateFootage(hddId: number, footageId: number, params: FootageCreateUpdatePayload): Promise<import("axios").AxiosResponse<any, any>>;
235
- };
236
- shareRequests: {
237
- getShareRequests(params: {
238
- params: Partial<CameraShareRequestsQueryParams>;
239
- }): Promise<PaginatedItems<CameraShareRequest[]>>;
240
- deleteShareRequest(params: {
241
- ids: number[];
242
- }): Promise<{
243
- success: boolean;
244
- }>;
245
- updateShareRequestStatus(params: {
246
- ids: number[];
247
- status: string;
248
- }): Promise<{
249
- success: boolean;
250
- }>;
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>;
251
284
  };
252
285
  shares: {
253
- createShares(cameraExid: string, payload: CameraShareRequestPayload): Promise<ShareCreateResponsePayload>;
254
- getShares(params: {
255
- params: Partial<ShareQueryParams>;
256
- }): Promise<PaginatedItems<AdminShare[]>>;
257
- deleteShares(ids: number[]): Promise<void>;
286
+ getInvites(params: AxiosPaginationRequestParams): Promise<PaginatedItems<AdminInvite>>;
258
287
  };
259
288
  sims: {
260
289
  deleteSim(simId: number): Promise<{
@@ -263,18 +292,18 @@ export declare const AdminApi: {
263
292
  createSim(params: Omit<SimCreateUpdatePayload, "cameraId">): Promise<{
264
293
  success: boolean;
265
294
  }>;
266
- updateSim(simId: number, params: CameraShareRequestPayload): Promise<{
295
+ updateSim(simId: number, params: SimCreateUpdatePayload): Promise<{
267
296
  success: boolean;
268
297
  }>;
269
298
  getSims(params: {
270
299
  params: Partial<SimsQueryParams>;
271
300
  }): Promise<PaginatedItems<Sim[]>>;
272
- getSimProviders(): Promise<import("axios").AxiosResponse<any, any>>;
273
- getBillPayers(): Promise<import("axios").AxiosResponse<any, any>>;
301
+ getSimProviders(): Promise<string[]>;
302
+ getBillPayers(): Promise<string[]>;
274
303
  };
275
304
  sms: {
276
305
  sendSms(number: string, params: SendSmsPayload): Promise<SendSmsResponse>;
277
- getSimHistory(number: string): Promise<SmsHistoryResponse>;
306
+ getSimHistory(number: string, params: AxiosPaginationRequestParams): Promise<PaginatedItems<SmsHistoryResponse>>;
278
307
  getSms(params: {
279
308
  params: Partial<SmsQueryParams>;
280
309
  }): Promise<PaginatedItems<Sms[]>>;
@@ -311,7 +340,7 @@ export declare const AdminApi: {
311
340
  message: string;
312
341
  }>;
313
342
  deleteUser(email: string, params: {
314
- verifyEmail: string;
343
+ verifEmail: string;
315
344
  }): Promise<void | {
316
345
  message: string;
317
346
  }>;
@@ -319,7 +348,7 @@ export declare const AdminApi: {
319
348
  getUsers(params: {
320
349
  params: Partial<AdminUserQueryParams>;
321
350
  }): Promise<PaginatedItems<AdminUser>>;
322
- show(id: number, params: Record<string, unknown>): Promise<UserStatsResponse>;
351
+ show(id: number, params?: WithZohoParams): Promise<UserStatsResponse>;
323
352
  getProjects(id: number): Promise<UserProjectResponse>;
324
353
  getCameras(id: number): Promise<UserCameraResponse>;
325
354
  getUserPasswordResetLink(email: string): Promise<{
@@ -329,12 +358,24 @@ export declare const AdminApi: {
329
358
  widgets: {
330
359
  index(params: {
331
360
  params: Partial<WidgetsListRequestPayload>;
332
- }): Promise<PaginatedItems<Widget>>;
333
- show(id: number): Promise<WidgetFull>;
334
- update(id: number, payload: WidgetPayload): Promise<WidgetFull>;
361
+ }): Promise<PaginatedItems<AdminWidget>>;
362
+ show(id: number): Promise<AdminWidgetFull>;
363
+ update(id: number, payload: WidgetPayload): Promise<AdminWidgetFull>;
335
364
  delete(id: number): Promise<import("axios").AxiosResponse<any, any>>;
336
365
  };
337
366
  zohoDesk: {
338
- searchTickets(params: Record<string, unknown>): Promise<import("axios").AxiosResponse<any, any>>;
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>;
339
379
  };
340
380
  };
381
+ export {};