@bikefinder/api-client 0.5.0 → 0.7.2

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.
@@ -102,6 +102,24 @@ export type AdminEvidenceHistoryRequest = {
102
102
  export type AdminEvidenceHistorySource =
103
103
  "data" | "sanitizedData" | "bluetooth" | "audit" | "commandPackets";
104
104
 
105
+ export type AdminEvidenceInsuranceRecords = "contracts" | "creationAttempts";
106
+
107
+ export type AdminEvidenceLayout = "legacy";
108
+
109
+ export type AdminEvidenceOperationalDomain =
110
+ "runtime" | "firmware" | "commands" | "statistics";
111
+
112
+ export type AdminEvidencePage = {
113
+ snapshot: AdminEvidenceSnapshot;
114
+ nextAfter: null | string;
115
+ scannedRecordCount: number;
116
+ };
117
+
118
+ export type AdminEvidencePageRequest = {
119
+ accountIds: Array<string>;
120
+ after?: null | string;
121
+ };
122
+
105
123
  export type AdminEvidenceSnapshot = {
106
124
  documents: Array<AdminEvidenceDocument>;
107
125
  relatedDocuments: Array<AdminEvidenceDocument>;
@@ -114,6 +132,15 @@ export type AdminFavoriteRequest = {
114
132
 
115
133
  export type AdminGeneration = "gen1" | "gen2";
116
134
 
135
+ export type AdminInsuranceEvidenceRequest = {
136
+ accountIds: Array<string>;
137
+ provider: AdminInsuranceProvider;
138
+ records?: AdminEvidenceInsuranceRecords;
139
+ after?: null | string;
140
+ };
141
+
142
+ export type AdminInsuranceProvider = "cycler" | "hepster" | "tryg";
143
+
117
144
  export type AdminLinkSubscriptionRequest = {
118
145
  subscriptionId: string;
119
146
  };
@@ -148,37 +175,20 @@ export type AdminNotificationRequest = {
148
175
  log?: null | string;
149
176
  };
150
177
 
151
- export type AdminOperationalDomain = {
152
- state: JsonElement;
153
- updatedAt: AdminTimestamp;
154
- };
155
-
156
- export type AdminOperationalDomains = {
157
- battery: null | AdminOperationalDomain;
158
- runtime: null | AdminOperationalDomain;
159
- statistics: null | AdminOperationalDomain;
160
- firmware: null | AdminOperationalDomain;
161
- };
162
-
163
- export type AdminOperationalState = {
164
- schemaVersion: number;
165
- deviceId: string;
166
- deviceEpoch: string;
167
- deviceCreatedAt: AdminTimestamp;
168
- domains: AdminOperationalDomains;
178
+ export type AdminOperationalEvidence = {
179
+ domain: AdminEvidenceOperationalDomain;
180
+ layout: AdminEvidenceLayout;
181
+ snapshot: AdminEvidenceSnapshot;
169
182
  };
170
183
 
171
- export type AdminPublicStates = {
172
- contact: null | AdminDocument;
173
- battery: null | AdminDocument;
174
- location: null | AdminDocument;
175
- configuration: null | AdminDocument;
184
+ export type AdminOperationalEvidenceRequest = {
185
+ accountIds: Array<string>;
186
+ domain: AdminEvidenceOperationalDomain;
176
187
  };
177
188
 
178
189
  export type AdminReadResult = {
179
190
  documents: Array<AdminDocument>;
180
191
  nextCursor: null | string;
181
- states: null | AdminPublicStates;
182
192
  };
183
193
 
184
194
  export type AdminRelationshipChangeRequest = {
@@ -289,7 +299,6 @@ export type AdminTrackerFactsRequest = {
289
299
 
290
300
  export type AdminTrackerView = {
291
301
  tracker: AdminReadResult;
292
- operationalState: null | AdminOperationalState;
293
302
  };
294
303
 
295
304
  export type CommandSuccess = {
@@ -298,8 +307,6 @@ export type CommandSuccess = {
298
307
 
299
308
  export type IFormFile = Blob | File;
300
309
 
301
- export type JsonElement = unknown;
302
-
303
310
  export type PhotoUploadResult = {
304
311
  id: string;
305
312
  };
@@ -326,6 +333,201 @@ export type ProblemDetails = {
326
333
  };
327
334
  };
328
335
 
336
+ export type AdminQueryTrackerOperationalEvidenceData = {
337
+ body: AdminOperationalEvidenceRequest;
338
+ path: {
339
+ trackerId: string;
340
+ };
341
+ query?: never;
342
+ url: "/v1/admin/product-evidence/trackers/{trackerId}/operational-queries";
343
+ };
344
+
345
+ export type AdminQueryTrackerOperationalEvidenceErrors = {
346
+ /**
347
+ * Bad Request
348
+ */
349
+ 400: ProblemDetails;
350
+ /**
351
+ * Unauthorized
352
+ */
353
+ 401: ProblemDetails;
354
+ /**
355
+ * Forbidden
356
+ */
357
+ 403: ProblemDetails;
358
+ /**
359
+ * Conflict
360
+ */
361
+ 409: ProblemDetails;
362
+ /**
363
+ * Payload Too Large
364
+ */
365
+ 413: ProblemDetails;
366
+ /**
367
+ * Unsupported Media Type
368
+ */
369
+ 415: ProblemDetails;
370
+ /**
371
+ * Too Many Requests
372
+ */
373
+ 429: ProblemDetails;
374
+ /**
375
+ * Internal Server Error
376
+ */
377
+ 500: ProblemDetails;
378
+ /**
379
+ * Bad Gateway
380
+ */
381
+ 502: ProblemDetails;
382
+ /**
383
+ * Service Unavailable
384
+ */
385
+ 503: ProblemDetails;
386
+ };
387
+
388
+ export type AdminQueryTrackerOperationalEvidenceError =
389
+ AdminQueryTrackerOperationalEvidenceErrors[keyof AdminQueryTrackerOperationalEvidenceErrors];
390
+
391
+ export type AdminQueryTrackerOperationalEvidenceResponses = {
392
+ /**
393
+ * OK
394
+ */
395
+ 200: AdminOperationalEvidence;
396
+ };
397
+
398
+ export type AdminQueryTrackerOperationalEvidenceResponse =
399
+ AdminQueryTrackerOperationalEvidenceResponses[keyof AdminQueryTrackerOperationalEvidenceResponses];
400
+
401
+ export type AdminQueryTrackerJobEvidenceData = {
402
+ body: AdminEvidencePageRequest;
403
+ path: {
404
+ trackerId: string;
405
+ };
406
+ query?: never;
407
+ url: "/v1/admin/product-evidence/trackers/{trackerId}/job-queries";
408
+ };
409
+
410
+ export type AdminQueryTrackerJobEvidenceErrors = {
411
+ /**
412
+ * Bad Request
413
+ */
414
+ 400: ProblemDetails;
415
+ /**
416
+ * Unauthorized
417
+ */
418
+ 401: ProblemDetails;
419
+ /**
420
+ * Forbidden
421
+ */
422
+ 403: ProblemDetails;
423
+ /**
424
+ * Conflict
425
+ */
426
+ 409: ProblemDetails;
427
+ /**
428
+ * Payload Too Large
429
+ */
430
+ 413: ProblemDetails;
431
+ /**
432
+ * Unsupported Media Type
433
+ */
434
+ 415: ProblemDetails;
435
+ /**
436
+ * Too Many Requests
437
+ */
438
+ 429: ProblemDetails;
439
+ /**
440
+ * Internal Server Error
441
+ */
442
+ 500: ProblemDetails;
443
+ /**
444
+ * Bad Gateway
445
+ */
446
+ 502: ProblemDetails;
447
+ /**
448
+ * Service Unavailable
449
+ */
450
+ 503: ProblemDetails;
451
+ };
452
+
453
+ export type AdminQueryTrackerJobEvidenceError =
454
+ AdminQueryTrackerJobEvidenceErrors[keyof AdminQueryTrackerJobEvidenceErrors];
455
+
456
+ export type AdminQueryTrackerJobEvidenceResponses = {
457
+ /**
458
+ * OK
459
+ */
460
+ 200: AdminEvidencePage;
461
+ };
462
+
463
+ export type AdminQueryTrackerJobEvidenceResponse =
464
+ AdminQueryTrackerJobEvidenceResponses[keyof AdminQueryTrackerJobEvidenceResponses];
465
+
466
+ export type AdminQuerySubscriptionInsuranceEvidenceData = {
467
+ body: AdminInsuranceEvidenceRequest;
468
+ path: {
469
+ subscriptionId: string;
470
+ };
471
+ query?: never;
472
+ url: "/v1/admin/product-evidence/subscriptions/{subscriptionId}/insurance-queries";
473
+ };
474
+
475
+ export type AdminQuerySubscriptionInsuranceEvidenceErrors = {
476
+ /**
477
+ * Bad Request
478
+ */
479
+ 400: ProblemDetails;
480
+ /**
481
+ * Unauthorized
482
+ */
483
+ 401: ProblemDetails;
484
+ /**
485
+ * Forbidden
486
+ */
487
+ 403: ProblemDetails;
488
+ /**
489
+ * Conflict
490
+ */
491
+ 409: ProblemDetails;
492
+ /**
493
+ * Payload Too Large
494
+ */
495
+ 413: ProblemDetails;
496
+ /**
497
+ * Unsupported Media Type
498
+ */
499
+ 415: ProblemDetails;
500
+ /**
501
+ * Too Many Requests
502
+ */
503
+ 429: ProblemDetails;
504
+ /**
505
+ * Internal Server Error
506
+ */
507
+ 500: ProblemDetails;
508
+ /**
509
+ * Bad Gateway
510
+ */
511
+ 502: ProblemDetails;
512
+ /**
513
+ * Service Unavailable
514
+ */
515
+ 503: ProblemDetails;
516
+ };
517
+
518
+ export type AdminQuerySubscriptionInsuranceEvidenceError =
519
+ AdminQuerySubscriptionInsuranceEvidenceErrors[keyof AdminQuerySubscriptionInsuranceEvidenceErrors];
520
+
521
+ export type AdminQuerySubscriptionInsuranceEvidenceResponses = {
522
+ /**
523
+ * OK
524
+ */
525
+ 200: AdminEvidencePage;
526
+ };
527
+
528
+ export type AdminQuerySubscriptionInsuranceEvidenceResponse =
529
+ AdminQuerySubscriptionInsuranceEvidenceResponses[keyof AdminQuerySubscriptionInsuranceEvidenceResponses];
530
+
329
531
  export type AdminListAccountTrackerEvidenceData = {
330
532
  body?: never;
331
533
  path: {
@@ -1046,9 +1248,7 @@ export type AdminGetTrackerData = {
1046
1248
  path: {
1047
1249
  trackerId: string;
1048
1250
  };
1049
- query?: {
1050
- domains?: Array<"battery" | "configuration" | "contact" | "location">;
1051
- };
1251
+ query?: never;
1052
1252
  url: "/v1/admin/trackers/{trackerId}";
1053
1253
  };
1054
1254
 
@@ -1251,73 +1451,6 @@ export type AdminListTrackerHistoryResponses = {
1251
1451
  export type AdminListTrackerHistoryResponse =
1252
1452
  AdminListTrackerHistoryResponses[keyof AdminListTrackerHistoryResponses];
1253
1453
 
1254
- export type AdminGetTrackerOperationalStateData = {
1255
- body?: never;
1256
- path: {
1257
- trackerId: string;
1258
- };
1259
- query: {
1260
- domains: Array<"battery" | "firmware" | "runtime" | "statistics">;
1261
- };
1262
- url: "/v1/admin/trackers/{trackerId}/operational-state";
1263
- };
1264
-
1265
- export type AdminGetTrackerOperationalStateErrors = {
1266
- /**
1267
- * Bad Request
1268
- */
1269
- 400: ProblemDetails;
1270
- /**
1271
- * Unauthorized
1272
- */
1273
- 401: ProblemDetails;
1274
- /**
1275
- * Forbidden
1276
- */
1277
- 403: ProblemDetails;
1278
- /**
1279
- * Not Found
1280
- */
1281
- 404: ProblemDetails;
1282
- /**
1283
- * Conflict
1284
- */
1285
- 409: ProblemDetails;
1286
- /**
1287
- * Payload Too Large
1288
- */
1289
- 413: ProblemDetails;
1290
- /**
1291
- * Too Many Requests
1292
- */
1293
- 429: ProblemDetails;
1294
- /**
1295
- * Internal Server Error
1296
- */
1297
- 500: ProblemDetails;
1298
- /**
1299
- * Bad Gateway
1300
- */
1301
- 502: ProblemDetails;
1302
- /**
1303
- * Service Unavailable
1304
- */
1305
- 503: ProblemDetails;
1306
- };
1307
-
1308
- export type AdminGetTrackerOperationalStateError =
1309
- AdminGetTrackerOperationalStateErrors[keyof AdminGetTrackerOperationalStateErrors];
1310
-
1311
- export type AdminGetTrackerOperationalStateResponses = {
1312
- /**
1313
- * OK
1314
- */
1315
- 200: AdminOperationalState;
1316
- };
1317
-
1318
- export type AdminGetTrackerOperationalStateResponse =
1319
- AdminGetTrackerOperationalStateResponses[keyof AdminGetTrackerOperationalStateResponses];
1320
-
1321
1454
  export type AdminRequestTrackerModeData = {
1322
1455
  body: AdminModeRequest;
1323
1456
  path: {
@@ -89,12 +89,39 @@ export const zAdminEvidenceHistorySource = z.enum([
89
89
  "commandPackets",
90
90
  ]);
91
91
 
92
+ export const zAdminEvidenceInsuranceRecords = z
93
+ .enum(["contracts", "creationAttempts"])
94
+ .default("contracts");
95
+
96
+ export const zAdminEvidenceLayout = z.enum(["legacy"]);
97
+
98
+ export const zAdminEvidenceOperationalDomain = z.enum([
99
+ "runtime",
100
+ "firmware",
101
+ "commands",
102
+ "statistics",
103
+ ]);
104
+
105
+ export const zAdminEvidencePageRequest = z.object({
106
+ accountIds: z.array(z.string()).min(1).max(20),
107
+ after: z.string().min(1).max(254).nullish(),
108
+ });
109
+
92
110
  export const zAdminFavoriteRequest = z.object({
93
111
  comment: z.string().max(4000),
94
112
  });
95
113
 
96
114
  export const zAdminGeneration = z.enum(["gen1", "gen2"]);
97
115
 
116
+ export const zAdminInsuranceProvider = z.enum(["cycler", "hepster", "tryg"]);
117
+
118
+ export const zAdminInsuranceEvidenceRequest = z.object({
119
+ accountIds: z.array(z.string()).min(1).max(20),
120
+ provider: zAdminInsuranceProvider,
121
+ records: zAdminEvidenceInsuranceRecords.optional(),
122
+ after: z.string().min(1).max(254).nullish(),
123
+ });
124
+
98
125
  export const zAdminLinkSubscriptionRequest = z.object({
99
126
  subscriptionId: z.string(),
100
127
  });
@@ -138,6 +165,11 @@ export const zAdminNotificationRequest = z.object({
138
165
  log: z.string().max(1000).nullish(),
139
166
  });
140
167
 
168
+ export const zAdminOperationalEvidenceRequest = z.object({
169
+ accountIds: z.array(z.string()).min(1).max(20),
170
+ domain: zAdminEvidenceOperationalDomain,
171
+ });
172
+
141
173
  export const zAdminRelationshipKind = z.enum([
142
174
  "subscriptionBinding",
143
175
  "deviceAccount",
@@ -226,17 +258,9 @@ export const zAdminDocument = z.object({
226
258
  fields: zAdminSupportValue,
227
259
  });
228
260
 
229
- export const zAdminPublicStates = z.object({
230
- contact: zAdminDocument.nullable(),
231
- battery: zAdminDocument.nullable(),
232
- location: zAdminDocument.nullable(),
233
- configuration: zAdminDocument.nullable(),
234
- });
235
-
236
261
  export const zAdminReadResult = z.object({
237
262
  documents: z.array(zAdminDocument),
238
263
  nextCursor: z.string().nullable(),
239
- states: zAdminPublicStates.nullable(),
240
264
  });
241
265
 
242
266
  export const zAdminTimestamp = z.object({
@@ -281,6 +305,25 @@ export const zAdminEvidenceSnapshot = z.object({
281
305
  readAt: zAdminTimestamp,
282
306
  });
283
307
 
308
+ export const zAdminEvidencePage = z.object({
309
+ snapshot: zAdminEvidenceSnapshot,
310
+ nextAfter: z.string().nullable(),
311
+ scannedRecordCount: z
312
+ .int()
313
+ .min(-2147483648, {
314
+ error: "Invalid value: Expected int32 to be >= -2147483648",
315
+ })
316
+ .max(2147483647, {
317
+ error: "Invalid value: Expected int32 to be <= 2147483647",
318
+ }),
319
+ });
320
+
321
+ export const zAdminOperationalEvidence = z.object({
322
+ domain: zAdminEvidenceOperationalDomain,
323
+ layout: zAdminEvidenceLayout,
324
+ snapshot: zAdminEvidenceSnapshot,
325
+ });
326
+
284
327
  export const zAdminTrackerCommand = z.enum([
285
328
  "changeEncryptionKey",
286
329
  "changeRareConfigs",
@@ -310,46 +353,16 @@ export const zAdminTrackerFactsRequest = z.object({
310
353
  domain: zAdminEvidenceDomain,
311
354
  });
312
355
 
356
+ export const zAdminTrackerView = z.object({
357
+ tracker: zAdminReadResult,
358
+ });
359
+
313
360
  export const zCommandSuccess = z.object({
314
361
  success: z.boolean(),
315
362
  });
316
363
 
317
364
  export const zIFormFile = z.string();
318
365
 
319
- export const zJsonElement = z.unknown();
320
-
321
- export const zAdminOperationalDomain = z.object({
322
- state: zJsonElement,
323
- updatedAt: zAdminTimestamp,
324
- });
325
-
326
- export const zAdminOperationalDomains = z.object({
327
- battery: zAdminOperationalDomain.nullable(),
328
- runtime: zAdminOperationalDomain.nullable(),
329
- statistics: zAdminOperationalDomain.nullable(),
330
- firmware: zAdminOperationalDomain.nullable(),
331
- });
332
-
333
- export const zAdminOperationalState = z.object({
334
- schemaVersion: z
335
- .int()
336
- .min(-2147483648, {
337
- error: "Invalid value: Expected int32 to be >= -2147483648",
338
- })
339
- .max(2147483647, {
340
- error: "Invalid value: Expected int32 to be <= 2147483647",
341
- }),
342
- deviceId: z.string(),
343
- deviceEpoch: z.string(),
344
- deviceCreatedAt: zAdminTimestamp,
345
- domains: zAdminOperationalDomains,
346
- });
347
-
348
- export const zAdminTrackerView = z.object({
349
- tracker: zAdminReadResult,
350
- operationalState: zAdminOperationalState.nullable(),
351
- });
352
-
353
366
  export const zPhotoUploadResult = z.object({
354
367
  id: z.string(),
355
368
  });
@@ -373,6 +386,49 @@ export const zProblemDetails = z.object({
373
386
  errors: z.record(z.string(), z.array(z.string())).optional(),
374
387
  });
375
388
 
389
+ export const zAdminQueryTrackerOperationalEvidenceBody =
390
+ zAdminOperationalEvidenceRequest;
391
+
392
+ export const zAdminQueryTrackerOperationalEvidencePath = z.object({
393
+ trackerId: z
394
+ .string()
395
+ .length(32)
396
+ .regex(/^[a-f0-9]{32}$/),
397
+ });
398
+
399
+ /**
400
+ * OK
401
+ */
402
+ export const zAdminQueryTrackerOperationalEvidenceResponse =
403
+ zAdminOperationalEvidence;
404
+
405
+ export const zAdminQueryTrackerJobEvidenceBody = zAdminEvidencePageRequest;
406
+
407
+ export const zAdminQueryTrackerJobEvidencePath = z.object({
408
+ trackerId: z
409
+ .string()
410
+ .length(32)
411
+ .regex(/^[a-f0-9]{32}$/),
412
+ });
413
+
414
+ /**
415
+ * OK
416
+ */
417
+ export const zAdminQueryTrackerJobEvidenceResponse = zAdminEvidencePage;
418
+
419
+ export const zAdminQuerySubscriptionInsuranceEvidenceBody =
420
+ zAdminInsuranceEvidenceRequest;
421
+
422
+ export const zAdminQuerySubscriptionInsuranceEvidencePath = z.object({
423
+ subscriptionId: z.string(),
424
+ });
425
+
426
+ /**
427
+ * OK
428
+ */
429
+ export const zAdminQuerySubscriptionInsuranceEvidenceResponse =
430
+ zAdminEvidencePage;
431
+
376
432
  export const zAdminListAccountTrackerEvidencePath = z.object({
377
433
  accountId: z.string(),
378
434
  });
@@ -534,12 +590,6 @@ export const zAdminGetTrackerPath = z.object({
534
590
  .regex(/^[a-f0-9]{32}$/),
535
591
  });
536
592
 
537
- export const zAdminGetTrackerQuery = z.object({
538
- domains: z
539
- .array(z.enum(["battery", "configuration", "contact", "location"]))
540
- .optional(),
541
- });
542
-
543
593
  /**
544
594
  * OK
545
595
  */
@@ -581,22 +631,6 @@ export const zAdminListTrackerHistoryQuery = z.object({
581
631
  */
582
632
  export const zAdminListTrackerHistoryResponse = zAdminReadResult;
583
633
 
584
- export const zAdminGetTrackerOperationalStatePath = z.object({
585
- trackerId: z
586
- .string()
587
- .length(32)
588
- .regex(/^[a-f0-9]{32}$/),
589
- });
590
-
591
- export const zAdminGetTrackerOperationalStateQuery = z.object({
592
- domains: z.array(z.enum(["battery", "firmware", "runtime", "statistics"])),
593
- });
594
-
595
- /**
596
- * OK
597
- */
598
- export const zAdminGetTrackerOperationalStateResponse = zAdminOperationalState;
599
-
600
634
  export const zAdminRequestTrackerModeBody = zAdminModeRequest;
601
635
 
602
636
  export const zAdminRequestTrackerModePath = z.object({