@evercam/api 1.0.0-ae97ae0a0 → 1.0.0-api-fixes-7de7fc3dd

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 (40) hide show
  1. package/dist/api/api/adminApi.d.ts +61 -57
  2. package/dist/api/api/aiApi.d.ts +1 -0
  3. package/dist/api/api/evercamApi.d.ts +26 -29
  4. package/dist/api/api/ingestApi.d.ts +3 -0
  5. package/dist/api/types/aconex.d.ts +2 -1
  6. package/dist/api/types/admin.d.ts +20 -4
  7. package/dist/api/types/analytics.d.ts +2 -1
  8. package/dist/api/types/anpr.d.ts +0 -1
  9. package/dist/api/types/auditLogs.d.ts +44 -37
  10. package/dist/api/types/bim.d.ts +48 -37
  11. package/dist/api/types/camera.d.ts +56 -43
  12. package/dist/api/types/comments.d.ts +24 -16
  13. package/dist/api/types/company.d.ts +23 -12
  14. package/dist/api/types/compare.d.ts +27 -23
  15. package/dist/api/types/hdd.d.ts +58 -24
  16. package/dist/api/types/kit.d.ts +19 -15
  17. package/dist/api/types/media.d.ts +13 -0
  18. package/dist/api/types/notification.d.ts +34 -28
  19. package/dist/api/types/nvr.d.ts +28 -0
  20. package/dist/api/types/oauth.d.ts +1 -0
  21. package/dist/api/types/progressPhoto.d.ts +24 -21
  22. package/dist/api/types/project.d.ts +57 -14
  23. package/dist/api/types/recording.d.ts +4 -3
  24. package/dist/api/types/roi.d.ts +2 -1
  25. package/dist/api/types/router.d.ts +23 -2
  26. package/dist/api/types/shared.d.ts +50 -43
  27. package/dist/api/types/sim.d.ts +1 -4
  28. package/dist/api/types/snapshots.d.ts +55 -8
  29. package/dist/api/types/storageProvider.d.ts +15 -3
  30. package/dist/api/types/timelapse.d.ts +38 -12
  31. package/dist/api/types/user.d.ts +76 -64
  32. package/dist/api/types/videoWall.d.ts +8 -8
  33. package/dist/api/types/weather.d.ts +90 -16
  34. package/dist/api/types/widget.d.ts +56 -47
  35. package/dist/index.js +259 -238
  36. package/dist/index.js.map +1 -1
  37. package/dist/index.umd.cjs +1 -1
  38. package/dist/index.umd.cjs.map +1 -1
  39. package/dist/shared/types/components.d.ts +6 -1
  40. package/package.json +1 -1
@@ -1,8 +1,13 @@
1
1
  import { CameraExid, DateType, PaginationParams, Schedule } from "@evercam/api/types";
2
2
  export type SnapshotExtractionQyeryParams = PaginationParams & {
3
- camera: string;
4
- cameraExid: CameraExid;
5
- status: SnapshotExtractionStatus;
3
+ camera?: string;
4
+ cameraExid?: CameraExid;
5
+ status?: SnapshotExtractionStatus;
6
+ requestor?: string;
7
+ type?: SnapshotExtractionType;
8
+ from?: string;
9
+ to?: string;
10
+ sort?: string;
6
11
  };
7
12
  export declare enum SnapshotExtractionStatus {
8
13
  Cancelling = "canceling",
@@ -25,16 +30,49 @@ export type SnapshotExtraction = {
25
30
  fromDate: DateType;
26
31
  toDate: DateType;
27
32
  type: SnapshotExtractionType;
28
- notes: string;
33
+ notes: string | null;
29
34
  status: SnapshotExtractionStatus;
30
35
  interval: number;
31
36
  requestor: string;
32
37
  jpegsToDropbox: boolean;
33
- injectTo_cr: Boolean;
38
+ injectToCr: boolean;
39
+ schedule: Schedule;
40
+ createdAt: DateType;
41
+ jpegCount?: number;
42
+ expectedCount?: number;
43
+ uploadCounts?: {
44
+ cr: number;
45
+ dropbox: number;
46
+ };
47
+ obanJobId?: number | null;
48
+ };
49
+ export type SnapshotExtractionCreatePayload = {
50
+ fromDate: DateType;
51
+ toDate: DateType;
52
+ interval: number;
34
53
  schedule: Schedule;
35
- created_at: DateType;
54
+ type: SnapshotExtractionType;
55
+ requestor?: string;
56
+ jpegsToDropbox?: boolean;
57
+ injectToCr?: boolean;
58
+ };
59
+ export type SnapshotExtractionCreatedResponse = {
60
+ id: number;
61
+ camera: string;
62
+ fromDate: DateType;
63
+ toDate: DateType;
64
+ interval: number;
65
+ schedule: Schedule;
66
+ status: number;
67
+ requestor: string;
36
68
  jpegCount?: number;
37
- obanJobId?: number;
69
+ expectedCount?: number;
70
+ uploadCounts?: {
71
+ cr: number;
72
+ dropbox: number;
73
+ };
74
+ createdAt: DateType;
75
+ updatedAt: DateType;
38
76
  };
39
77
  export type SnapshotTestPayload = {
40
78
  cameraExid?: CameraExid;
@@ -82,6 +120,7 @@ export type SnapshotTransferCamera = {
82
120
  name: string;
83
121
  };
84
122
  export type SnapshotTransferRequestor = {
123
+ id?: number;
85
124
  email: string;
86
125
  firstname: string;
87
126
  lastname: string;
@@ -93,7 +132,7 @@ export declare enum SnapshotTransferStatus {
93
132
  Pending = "pending",
94
133
  Cancelled = "cancelled"
95
134
  }
96
- export type TransferCloudRecordingsQueryParams = PaginationParams & {
135
+ export type TransferCloudRecordingsQueryParams = {
97
136
  targetCameraExid: CameraExid;
98
137
  fromDate: DateType;
99
138
  toDate: DateType;
@@ -102,3 +141,11 @@ export type TransferCloudRecordingsQueryParams = PaginationParams & {
102
141
  adminEmail?: string;
103
142
  adminFullname?: string;
104
143
  };
144
+ export type SnapshotTransferIndexParams = PaginationParams & {
145
+ sourceCamera?: string;
146
+ targetCamera?: string;
147
+ status?: SnapshotTransferStatus;
148
+ requestor?: string;
149
+ fromDate?: DateType;
150
+ toDate?: DateType;
151
+ };
@@ -1,14 +1,26 @@
1
1
  import type { DateType } from "@evercam/api/types";
2
+ export type StorageProviderS3Config = {
3
+ accessKeyId: string;
4
+ secretAccessKey: string;
5
+ bucket: string;
6
+ region?: string;
7
+ };
8
+ export type StorageProviderSeaweedfsConfig = {
9
+ jwtSigningKey?: string;
10
+ jwtReadSigningKey?: string;
11
+ };
12
+ export type StorageProviderConfig = StorageProviderS3Config | StorageProviderSeaweedfsConfig;
2
13
  export type StorageProvider = {
3
14
  id?: number;
4
- cameraId: number;
5
15
  type: string;
6
16
  provider: string;
7
- url: string;
8
17
  startDate: DateType;
9
18
  endDate: DateType;
10
- config: Record<string, any>;
19
+ url?: string;
20
+ config: StorageProviderConfig;
21
+ cameraId?: number;
11
22
  insertedAt?: DateType;
23
+ updatedAt?: DateType;
12
24
  };
13
25
  export type StorageProvidersResponsePayload = {
14
26
  providers: StorageProvider[];
@@ -70,20 +70,46 @@ export type TimelapseCreationRequestPayload = {
70
70
  schedule: Schedule;
71
71
  videoOptions: TimelapseVideoOptions;
72
72
  logo?: TimelapseLogoOptions;
73
+ public?: boolean;
73
74
  };
74
75
  export type TimelapseCreationResponsePayload = {
75
- Timelapse: {
76
- camera: string;
77
- createdAt: string;
78
- fromDate: string;
79
- id: number;
80
- duration: number;
81
- requestor: string;
82
- schedule: Schedule;
83
- status: number;
84
- toDate: string;
85
- updatedAt: string;
86
- };
76
+ id: number;
77
+ exid: string;
78
+ camera: string;
79
+ fromDate: string;
80
+ toDate: string;
81
+ duration: number;
82
+ schedule: Schedule;
83
+ status: number;
84
+ requestor: string;
85
+ createdAt: string;
86
+ updatedAt: string;
87
+ notes?: string | null;
88
+ category?: string | null;
89
+ isUrgent?: boolean | null;
90
+ };
91
+ export type TimelapseArchiveResponse = {
92
+ id: number;
93
+ exid: string;
94
+ cameraExid: string;
95
+ title: string;
96
+ fromDate: string;
97
+ toDate: string;
98
+ createdAt: string;
99
+ status: string;
100
+ requesterName: string;
101
+ requesterEmail: string;
102
+ public: boolean;
103
+ type: string;
104
+ format: string;
105
+ thumbnailUrl: string;
106
+ completedAt: string | null;
107
+ notes: string | null;
108
+ category: string | null;
109
+ isUrgent: boolean | null;
110
+ bucket: string;
111
+ sourceProduct: string | null;
112
+ featureType: string | null;
87
113
  };
88
114
  export type TimelapseSnapshotRequestPayload = {
89
115
  from: string;
@@ -29,7 +29,7 @@ export type AdminUser = {
29
29
  telephone: string;
30
30
  country: string;
31
31
  isAdmin: boolean;
32
- companyId: string;
32
+ companyId: number;
33
33
  companyName: string;
34
34
  companyExid: string;
35
35
  features: Array<UserFeatureFlag>;
@@ -133,6 +133,15 @@ export type ConfirmUserRequestPayload = {
133
133
  export type DeleteActiveSessionRequestPayload = {
134
134
  authorization: string;
135
135
  };
136
+ export declare enum UserSessionType {
137
+ Password = "password",
138
+ Impersonation = "impersonation",
139
+ Sso = "sso",
140
+ Widget = "widget",
141
+ ApiKey = "api_key",
142
+ OauthAccess = "oauth_access",
143
+ OauthRefresh = "oauth_refresh"
144
+ }
136
145
  export type UserSession = {
137
146
  browser: string;
138
147
  createdAt: string;
@@ -141,6 +150,8 @@ export type UserSession = {
141
150
  isCurrent: boolean;
142
151
  lastUsedAt: string;
143
152
  os: string;
153
+ type: UserSessionType;
154
+ impersonatedBy: string | null;
144
155
  };
145
156
  export type SessionsListRequestPayload = {
146
157
  authorization: string;
@@ -151,28 +162,25 @@ export type SessionsListRequestPayload = {
151
162
  limit: number;
152
163
  page: number;
153
164
  };
154
- export type SessionActivityCamSettingsDetail = {
155
- new: any;
156
- old: any;
157
- };
158
- export type SessionActivityDetail = {
159
- agent: string;
160
- camSettings: SessionActivityCamSettingsDetail;
161
- country: string;
162
- countryCode: string;
163
- ip: string;
164
- };
165
165
  export type SessionActivity = {
166
- cameraExid: string;
167
- details: SessionActivityDetail;
168
- insertedAt: string;
169
- type: string;
166
+ id: number;
170
167
  who: string;
168
+ action: string;
169
+ entity: string | null;
170
+ insertedAt: string;
171
+ userDetails: Record<string, unknown> | null;
172
+ details: Record<string, unknown> | null;
171
173
  };
172
174
  export type SessionActivitiesListRequestPayload = {
173
- limit: number;
174
- from: string;
175
- to: string;
175
+ action?: string;
176
+ entity?: string[];
177
+ from?: string;
178
+ to?: string;
179
+ cameraId?: number;
180
+ routerId?: string;
181
+ sort?: string;
182
+ page?: number;
183
+ limit?: number;
176
184
  };
177
185
  export type SignupUserRequestPayload = {
178
186
  telephone: string;
@@ -195,16 +203,18 @@ export type UserUpdateRequestPayload = {
195
203
  };
196
204
  export type UserDeleteRequestPayload = {
197
205
  verifEmail: string;
206
+ newOwnerEmail?: string;
198
207
  };
199
208
  export type GoogleAuthRequestPayload = {
200
- code: string;
201
- redirectUri: string;
209
+ code?: string;
210
+ redirectUri?: string;
211
+ idToken?: string;
202
212
  };
203
213
  export type ProjectContact = {
204
214
  name: string;
205
215
  role: ContactRole | string;
206
216
  email?: string;
207
- phone?: string;
217
+ phone?: string | null;
208
218
  photo?: string;
209
219
  };
210
220
  export type ProjectContactsResponsePayload = {
@@ -230,21 +240,38 @@ export type UserProject = {
230
240
  id: number;
231
241
  exid: string;
232
242
  name: string;
233
- startedAt: string;
243
+ status?: string;
244
+ startedAt?: string;
245
+ insertedAt?: string;
246
+ endDate?: string | null;
247
+ timezone?: string;
248
+ archiveTier?: string | null;
249
+ featureFlags?: string[];
250
+ companyId?: number | null;
251
+ camerasCount?: number;
252
+ camerasRestrictionType?: string | null;
253
+ geographicBounds?: unknown | null;
254
+ owner?: {
255
+ id: number;
256
+ name: string;
257
+ email: string;
258
+ };
234
259
  };
235
260
  export type UserProjectResponse = {
236
261
  data: UserProject[];
237
262
  };
238
263
  export type AdminUserUpdateRequestPayload = {
239
- companyId: string;
240
- email: string;
241
- persona: Persona;
242
- country: string;
243
- features: UserFeatureFlag[];
264
+ companyId?: number;
265
+ email?: string;
266
+ persona?: Persona;
267
+ country?: string;
268
+ features?: UserFeatureFlag[];
244
269
  };
245
270
  export type AdminQueryParams = PaginationParams & {
246
- email: string;
247
- fullname: string;
271
+ email?: string;
272
+ fullname?: string;
273
+ roles?: number[];
274
+ sort?: string;
248
275
  };
249
276
  export type Admin = {
250
277
  id: number;
@@ -257,47 +284,32 @@ export type Admin = {
257
284
  lastSignInIp: string;
258
285
  apiId: string;
259
286
  apiKey: string;
287
+ roles?: string[];
260
288
  };
261
289
  export type ImpersonateUserResponse = {
262
- id: string;
263
- firstname: string;
264
- lastname: string;
265
- telephone: string;
266
- email: string;
267
- isAdmin: boolean;
268
- persona: Persona;
269
- country: string;
270
- companyId: number;
271
- companyExid: string;
272
- companyName: string;
273
- evercamAccount: boolean;
274
- createdAt: string;
275
- updatedAt: string;
276
- confirmedAt: string;
277
- lastLoginAt: string;
278
- features: UserFeatureFlag[];
279
290
  token: string;
280
291
  };
281
292
  export type AdminUserQueryParams = PaginationParams & {
282
- fullname: string;
283
- email: string;
284
- telephone: string;
285
- persona: Persona;
286
- companyName: string;
287
- camerasCount: string;
288
- projectsCount: string;
289
- snapmailCount: string;
290
- camerasOwned: string;
291
- cameraShares: string;
292
- createdAtDate: string;
293
- lastLoginAtDate: string;
294
- integrations: "procore" | "aconex" | "autodesk";
295
- features: UserFeatureFlag.ProjectSharing | UserFeatureFlag.VideoWalls;
293
+ fullname?: string;
294
+ email?: string;
295
+ telephone?: string;
296
+ persona?: Persona;
297
+ companyName?: string;
298
+ camerasCount?: string;
299
+ projectsCount?: string;
300
+ snapmailCount?: string;
301
+ camerasOwned?: string;
302
+ cameraShares?: string;
303
+ createdAtDate?: string;
304
+ lastLoginAtDate?: string;
305
+ integrations?: "procore" | "aconex" | "autodesk";
306
+ features?: UserFeatureFlag.ProjectSharing | UserFeatureFlag.VideoWalls;
307
+ countryId?: number;
296
308
  };
297
309
  export type SuppressionsQueryParams = PaginationParams & {
298
- id: number;
299
- email: string;
300
- source: string;
310
+ id?: number;
311
+ email?: string;
312
+ source?: string;
301
313
  };
302
314
  export type Suppression = {
303
315
  id: number;
@@ -31,22 +31,22 @@ export type VideoWallPresetMeta = {
31
31
  gridSize: number;
32
32
  };
33
33
  export type VideoWallSource = "default" | "widget";
34
- export interface VideoWall {
34
+ export type VideoWall = {
35
35
  id: number;
36
36
  exid: string;
37
37
  name: string;
38
- source: VideoWallSource;
39
- config: Record<string, any>;
38
+ config: Record<string, unknown>;
40
39
  insertedAt: string;
41
40
  updatedAt: string;
42
- user: {
41
+ source?: VideoWallSource;
42
+ user?: {
43
43
  id: number;
44
44
  firstname: string;
45
45
  lastname: string;
46
46
  email: string;
47
47
  };
48
- }
49
- export interface VideoWallListParams extends PaginationParams {
48
+ };
49
+ export type VideoWallListParams = PaginationParams & {
50
50
  projectExid?: string;
51
51
  id?: number;
52
52
  exid?: string;
@@ -56,11 +56,11 @@ export interface VideoWallListParams extends PaginationParams {
56
56
  project?: string;
57
57
  user?: string;
58
58
  source?: VideoWallSource;
59
- }
59
+ };
60
60
  export type VideoWallCreateUpdatePayload = {
61
61
  projectExid?: string;
62
62
  name: string;
63
63
  source?: VideoWallSource;
64
- config: Record<string, unknown>;
64
+ config?: Record<string, unknown>;
65
65
  scope?: string;
66
66
  };
@@ -4,42 +4,116 @@ export type HistoryWeatherRequestPayload = {
4
4
  provider: WeatherProvider;
5
5
  };
6
6
  export type WeatherReportParams = {
7
- startDate: string;
8
- endDate: string;
7
+ startDate?: string;
8
+ endDate?: string;
9
+ startHour?: string;
10
+ endHour?: string;
9
11
  weatherConditionIds?: number[];
12
+ weatherDescription?: string;
13
+ minTemp?: number;
14
+ maxTemp?: number;
10
15
  minMinTemp?: number;
11
16
  maxMinTemp?: number;
12
17
  minMaxTemp?: number;
13
18
  maxMaxTemp?: number;
14
- minMinPrecip?: number;
15
- maxMinPrecip?: number;
16
- minMaxPrecip?: number;
17
- maxMaxPrecip?: number;
18
- minMinWindSpeed?: number;
19
- maxMinWindSpeed?: number;
20
- minMaxWindSpeed?: number;
21
- maxMaxWindSpeed?: number;
22
- minMinHumidity?: number;
23
- maxMinHumidity?: number;
24
- minMaxHumidity?: number;
25
- maxMaxHumidity?: number;
19
+ minSunhour?: number;
20
+ maxSunhour?: number;
21
+ minTotalsnow?: number;
22
+ maxTotalsnow?: number;
23
+ minFeelsLike?: number;
24
+ maxFeelsLike?: number;
25
+ minMinFeelsLike?: number;
26
+ maxMinFeelsLike?: number;
27
+ minMaxFeelsLike?: number;
28
+ maxMaxFeelsLike?: number;
29
+ minPressure?: number;
30
+ maxPressure?: number;
26
31
  minMinPressure?: number;
27
32
  maxMinPressure?: number;
28
33
  minMaxPressure?: number;
29
34
  maxMaxPressure?: number;
35
+ minHumidity?: number;
36
+ maxHumidity?: number;
37
+ minMinHumidity?: number;
38
+ maxMinHumidity?: number;
39
+ minMaxHumidity?: number;
40
+ maxMaxHumidity?: number;
41
+ minClouds?: number;
42
+ maxClouds?: number;
30
43
  minMinClouds?: number;
31
44
  maxMinClouds?: number;
32
45
  minMaxClouds?: number;
33
46
  maxMaxClouds?: number;
47
+ minWindSpeed?: number;
48
+ maxWindSpeed?: number;
49
+ minMinWindSpeed?: number;
50
+ maxMinWindSpeed?: number;
51
+ minMaxWindSpeed?: number;
52
+ maxMaxWindSpeed?: number;
53
+ minMinWindDegree?: number;
54
+ maxMinWindDegree?: number;
55
+ minMaxWindDegree?: number;
56
+ maxMaxWindDegree?: number;
57
+ minMinWindchill?: number;
58
+ maxMinWindchill?: number;
59
+ minMaxWindchill?: number;
60
+ maxMaxWindchill?: number;
61
+ minMinWindgust?: number;
62
+ maxMinWindgust?: number;
63
+ minMaxWindgust?: number;
64
+ maxMaxWindgust?: number;
65
+ minPrecip?: number;
66
+ maxPrecip?: number;
67
+ minMinPrecip?: number;
68
+ maxMinPrecip?: number;
69
+ minMaxPrecip?: number;
70
+ maxMaxPrecip?: number;
71
+ minHeatindex?: number;
72
+ maxHeatindex?: number;
73
+ minMinHeatindex?: number;
74
+ maxMinHeatindex?: number;
75
+ minMaxHeatindex?: number;
76
+ maxMaxHeatindex?: number;
77
+ minDewpoint?: number;
78
+ maxDewpoint?: number;
79
+ minMinDewpoint?: number;
80
+ maxMinDewpoint?: number;
81
+ minMaxDewpoint?: number;
82
+ maxMaxDewpoint?: number;
83
+ minUvIndex?: number;
84
+ maxUvIndex?: number;
85
+ minMinUvIndex?: number;
86
+ maxMinUvIndex?: number;
34
87
  minMaxUvIndex?: number;
35
88
  maxMaxUvIndex?: number;
89
+ minChanceofrain?: number;
90
+ maxChanceofrain?: number;
91
+ minChanceofsnow?: number;
92
+ maxChanceofsnow?: number;
93
+ minChanceofremdry?: number;
94
+ maxChanceofremdry?: number;
95
+ minChanceofwindy?: number;
96
+ maxChanceofwindy?: number;
97
+ minChanceofovercast?: number;
98
+ maxChanceofovercast?: number;
99
+ minChanceofsunshine?: number;
100
+ maxChanceofsunshine?: number;
101
+ minChanceoffrost?: number;
102
+ maxChanceoffrost?: number;
103
+ minChanceofhightemp?: number;
104
+ maxChanceofhightemp?: number;
105
+ minChanceoffog?: number;
106
+ maxChanceoffog?: number;
107
+ minChanceofthunder?: number;
108
+ maxChanceofthunder?: number;
36
109
  };
37
110
  export declare enum WeatherReportScope {
111
+ Hourly = "hourly",
38
112
  Daily = "daily"
39
113
  }
40
114
  export type WeatherReportRequestPayload = WeatherReportParams & {
41
- scope: WeatherReportScope;
42
- includeRecent: boolean;
115
+ scope?: WeatherReportScope;
116
+ includeRecent?: boolean;
43
117
  };
44
118
  export type CurrentWeatherRequestPayload = {
45
119
  provider: WeatherProvider;