@seamapi/http 2.46.0 → 2.47.0

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 (51) hide show
  1. package/README.md +12 -0
  2. package/lib/resources/access-code.d.ts +19 -0
  3. package/lib/resources/acs-entrance.d.ts +1 -1
  4. package/lib/resources/device-provider.d.ts +2 -2
  5. package/lib/resources/device.d.ts +48 -4
  6. package/lib/resources/phone.d.ts +16 -1
  7. package/lib/resources/unmanaged-access-code.d.ts +19 -0
  8. package/lib/resources/unmanaged-device.d.ts +19 -4
  9. package/lib/routes/access-codes/access-codes.d.ts +9 -9
  10. package/lib/routes/access-codes/access-codes.js +3 -12
  11. package/lib/routes/access-codes/access-codes.js.map +1 -1
  12. package/lib/routes/access-grants/unmanaged/unmanaged.d.ts +4 -0
  13. package/lib/routes/access-methods/access-methods.d.ts +5 -1
  14. package/lib/routes/access-methods/access-methods.js +1 -0
  15. package/lib/routes/access-methods/access-methods.js.map +1 -1
  16. package/lib/routes/client-sessions/client-sessions.d.ts +13 -1
  17. package/lib/routes/client-sessions/client-sessions.js +1 -0
  18. package/lib/routes/client-sessions/client-sessions.js.map +1 -1
  19. package/lib/routes/connect-webviews/connect-webviews.d.ts +1 -1
  20. package/lib/routes/customers/customers.d.ts +170 -0
  21. package/lib/routes/devices/devices.d.ts +3 -3
  22. package/lib/routes/devices/unmanaged/unmanaged.d.ts +3 -3
  23. package/lib/routes/events/events.d.ts +4 -4
  24. package/lib/routes/events/events.js +2 -2
  25. package/lib/routes/locks/locks.d.ts +2 -2
  26. package/lib/routes/seam-http-endpoints.d.ts +5 -5
  27. package/lib/routes/seam-http-endpoints.js +3 -3
  28. package/lib/routes/user-identities/user-identities.d.ts +4 -0
  29. package/lib/version.d.ts +1 -1
  30. package/lib/version.js +1 -1
  31. package/package.json +2 -2
  32. package/src/lib/resources/access-code.ts +22 -0
  33. package/src/lib/resources/acs-entrance.ts +1 -1
  34. package/src/lib/resources/device-provider.ts +2 -1
  35. package/src/lib/resources/device.ts +55 -3
  36. package/src/lib/resources/phone.ts +19 -1
  37. package/src/lib/resources/unmanaged-access-code.ts +22 -0
  38. package/src/lib/resources/unmanaged-device.ts +24 -3
  39. package/src/lib/routes/access-codes/access-codes.ts +46 -65
  40. package/src/lib/routes/access-grants/unmanaged/unmanaged.ts +4 -0
  41. package/src/lib/routes/access-methods/access-methods.ts +6 -0
  42. package/src/lib/routes/client-sessions/client-sessions.ts +14 -1
  43. package/src/lib/routes/connect-webviews/connect-webviews.ts +1 -0
  44. package/src/lib/routes/customers/customers.ts +175 -0
  45. package/src/lib/routes/devices/devices.ts +8 -0
  46. package/src/lib/routes/devices/unmanaged/unmanaged.ts +8 -0
  47. package/src/lib/routes/events/events.ts +4 -4
  48. package/src/lib/routes/locks/locks.ts +4 -0
  49. package/src/lib/routes/seam-http-endpoints.ts +5 -4
  50. package/src/lib/routes/user-identities/user-identities.ts +4 -0
  51. package/src/lib/version.ts +1 -1
@@ -369,6 +369,91 @@ export type CustomersCreatePortalParameters = {
369
369
  * Starting date and time for the access grant.
370
370
  */
371
371
  starts_at?: string | Date | Temporal.Instant | undefined;
372
+ /**
373
+ * Parts of the reservation that each get their own access, for example one per room. Each sub-reservation inherits the reservation's name, times, preferred code, guest and custom metadata unless it sets its own, and must set its own location keys. A reservation with sub-reservations must not set location keys itself. Sending this list replaces the reservation's sub-reservations: any not included are removed, and an empty list removes all of them. Omitting it leaves existing sub-reservations unchanged.
374
+ */
375
+ sub_reservations?: Array<{
376
+ /**
377
+ * Building keys associated with the access grant.
378
+ */
379
+ building_keys?: Array<string> | undefined;
380
+ /**
381
+ * Common area keys associated with the access grant.
382
+ */
383
+ common_area_keys?: Array<string> | undefined;
384
+ /**
385
+ * Set key:value pairs for filtering sub-reservations by custom criteria. Merged over the reservation's custom metadata. Set a key to `null` or to an empty string to remove that key from the custom metadata.
386
+ */
387
+ custom_metadata?: Record<string, string | boolean> | undefined;
388
+ /**
389
+ * Ending date and time for the access grant.
390
+ */
391
+ ends_at?: string | Date | Temporal.Instant | undefined;
392
+ /**
393
+ * Facility keys associated with the access grant.
394
+ */
395
+ facility_keys?: Array<string> | undefined;
396
+ /**
397
+ * Guest key associated with the access grant.
398
+ */
399
+ guest_key?: string | undefined;
400
+ /**
401
+ * Whether this is the reservation's primary sub-reservation, for example the room the guest stays in. Only the primary sub-reservation passes the guest's phone number to access systems that require a phone number to be unique per user. At most one sub-reservation of a reservation can be primary. If none is, the first sub-reservation in the list is primary.
402
+ */
403
+ is_primary?: boolean | undefined;
404
+ /**
405
+ * Listing keys associated with the access grant.
406
+ */
407
+ listing_keys?: Array<string> | undefined;
408
+ /**
409
+ * Your name for this access grant resource.
410
+ */
411
+ name?: string | undefined;
412
+ /**
413
+ * Preferred PIN code to use when creating access for this reservation. Set to `null` to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.
414
+ */
415
+ preferred_code?: string | null | undefined;
416
+ /**
417
+ * Property keys associated with the access grant.
418
+ */
419
+ property_keys?: Array<string> | undefined;
420
+ /**
421
+ * Resident key associated with the access grant.
422
+ */
423
+ resident_key?: string | undefined;
424
+ /**
425
+ * Room keys associated with the access grant.
426
+ */
427
+ room_keys?: Array<string> | undefined;
428
+ /**
429
+ * Space keys associated with the access grant.
430
+ */
431
+ space_keys?: Array<string> | undefined;
432
+ /**
433
+ * Starting date and time for the access grant.
434
+ */
435
+ starts_at?: string | Date | Temporal.Instant | undefined;
436
+ /**
437
+ * Your identifier for the sub-reservation. Must be unique across all your reservations and sub-reservations, and stay with the same reservation.
438
+ */
439
+ sub_reservation_key?: string | undefined;
440
+ /**
441
+ * Tenant key associated with the access grant.
442
+ */
443
+ tenant_key?: string | undefined;
444
+ /**
445
+ * Unit keys associated with the access grant.
446
+ */
447
+ unit_keys?: Array<string> | undefined;
448
+ /**
449
+ * User identity key associated with the access grant.
450
+ */
451
+ user_identity_key?: string | undefined;
452
+ /**
453
+ * User key associated with the access grant.
454
+ */
455
+ user_key?: string | undefined;
456
+ }> | undefined;
372
457
  /**
373
458
  * Tenant key associated with the access grant.
374
459
  */
@@ -1271,6 +1356,91 @@ export type CustomersPushDataParameters = {
1271
1356
  * Starting date and time for the access grant.
1272
1357
  */
1273
1358
  starts_at?: string | Date | Temporal.Instant | undefined;
1359
+ /**
1360
+ * Parts of the reservation that each get their own access, for example one per room. Each sub-reservation inherits the reservation's name, times, preferred code, guest and custom metadata unless it sets its own, and must set its own location keys. A reservation with sub-reservations must not set location keys itself. Sending this list replaces the reservation's sub-reservations: any not included are removed, and an empty list removes all of them. Omitting it leaves existing sub-reservations unchanged.
1361
+ */
1362
+ sub_reservations?: Array<{
1363
+ /**
1364
+ * Building keys associated with the access grant.
1365
+ */
1366
+ building_keys?: Array<string> | undefined;
1367
+ /**
1368
+ * Common area keys associated with the access grant.
1369
+ */
1370
+ common_area_keys?: Array<string> | undefined;
1371
+ /**
1372
+ * Set key:value pairs for filtering sub-reservations by custom criteria. Merged over the reservation's custom metadata. Set a key to `null` or to an empty string to remove that key from the custom metadata.
1373
+ */
1374
+ custom_metadata?: Record<string, string | boolean> | undefined;
1375
+ /**
1376
+ * Ending date and time for the access grant.
1377
+ */
1378
+ ends_at?: string | Date | Temporal.Instant | undefined;
1379
+ /**
1380
+ * Facility keys associated with the access grant.
1381
+ */
1382
+ facility_keys?: Array<string> | undefined;
1383
+ /**
1384
+ * Guest key associated with the access grant.
1385
+ */
1386
+ guest_key?: string | undefined;
1387
+ /**
1388
+ * Whether this is the reservation's primary sub-reservation, for example the room the guest stays in. Only the primary sub-reservation passes the guest's phone number to access systems that require a phone number to be unique per user. At most one sub-reservation of a reservation can be primary. If none is, the first sub-reservation in the list is primary.
1389
+ */
1390
+ is_primary?: boolean | undefined;
1391
+ /**
1392
+ * Listing keys associated with the access grant.
1393
+ */
1394
+ listing_keys?: Array<string> | undefined;
1395
+ /**
1396
+ * Your name for this access grant resource.
1397
+ */
1398
+ name?: string | undefined;
1399
+ /**
1400
+ * Preferred PIN code to use when creating access for this reservation. Set to `null` to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.
1401
+ */
1402
+ preferred_code?: string | null | undefined;
1403
+ /**
1404
+ * Property keys associated with the access grant.
1405
+ */
1406
+ property_keys?: Array<string> | undefined;
1407
+ /**
1408
+ * Resident key associated with the access grant.
1409
+ */
1410
+ resident_key?: string | undefined;
1411
+ /**
1412
+ * Room keys associated with the access grant.
1413
+ */
1414
+ room_keys?: Array<string> | undefined;
1415
+ /**
1416
+ * Space keys associated with the access grant.
1417
+ */
1418
+ space_keys?: Array<string> | undefined;
1419
+ /**
1420
+ * Starting date and time for the access grant.
1421
+ */
1422
+ starts_at?: string | Date | Temporal.Instant | undefined;
1423
+ /**
1424
+ * Your identifier for the sub-reservation. Must be unique across all your reservations and sub-reservations, and stay with the same reservation.
1425
+ */
1426
+ sub_reservation_key?: string | undefined;
1427
+ /**
1428
+ * Tenant key associated with the access grant.
1429
+ */
1430
+ tenant_key?: string | undefined;
1431
+ /**
1432
+ * Unit keys associated with the access grant.
1433
+ */
1434
+ unit_keys?: Array<string> | undefined;
1435
+ /**
1436
+ * User identity key associated with the access grant.
1437
+ */
1438
+ user_identity_key?: string | undefined;
1439
+ /**
1440
+ * User key associated with the access grant.
1441
+ */
1442
+ user_key?: string | undefined;
1443
+ }> | undefined;
1274
1444
  /**
1275
1445
  * Tenant key associated with the access grant.
1276
1446
  */
@@ -101,11 +101,11 @@ export type DevicesListParameters = {
101
101
  /**
102
102
  * Device type for which you want to list devices.
103
103
  */
104
- device_type?: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'sonos_speaker' | undefined;
104
+ device_type?: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'yale_access_lock' | 'yale_home_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker' | undefined;
105
105
  /**
106
106
  * Array of device types for which you want to list devices.
107
107
  */
108
- device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'sonos_speaker'> | undefined;
108
+ device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'yale_access_lock' | 'yale_home_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker'> | undefined;
109
109
  /**
110
110
  * Numerical limit on the number of devices to return.
111
111
  */
@@ -113,7 +113,7 @@ export type DevicesListParameters = {
113
113
  /**
114
114
  * Manufacturer for which you want to list devices.
115
115
  */
116
- manufacturer?: 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 'sonos' | undefined;
116
+ manufacturer?: 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'ubiquiti' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 'sonos' | undefined;
117
117
  /**
118
118
  * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
119
119
  */
@@ -84,11 +84,11 @@ export type DevicesUnmanagedListParameters = {
84
84
  /**
85
85
  * Device type for which you want to list devices.
86
86
  */
87
- device_type?: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'sonos_speaker' | undefined;
87
+ device_type?: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'yale_access_lock' | 'yale_home_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker' | undefined;
88
88
  /**
89
89
  * Array of device types for which you want to list devices.
90
90
  */
91
- device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'sonos_speaker'> | undefined;
91
+ device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'yale_access_lock' | 'yale_home_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker'> | undefined;
92
92
  /**
93
93
  * Numerical limit on the number of devices to return.
94
94
  */
@@ -96,7 +96,7 @@ export type DevicesUnmanagedListParameters = {
96
96
  /**
97
97
  * Manufacturer for which you want to list devices.
98
98
  */
99
- manufacturer?: 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 'sonos' | undefined;
99
+ manufacturer?: 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'ubiquiti' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 'sonos' | undefined;
100
100
  /**
101
101
  * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
102
102
  */
@@ -17,11 +17,11 @@ export declare class SeamHttpEvents {
17
17
  createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
18
18
  updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
19
19
  /**
20
- * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place.
20
+ * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place. Events older than 90 days are not returned.
21
21
  */
22
22
  get(parameters: EventsGetParameters, options?: EventsGetOptions): EventsGetRequest;
23
23
  /**
24
- * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place.
24
+ * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place. Only events from the last 90 days are returned.
25
25
  */
26
26
  list(parameters: EventsListParameters, options?: EventsListOptions): EventsListRequest;
27
27
  }
@@ -102,7 +102,7 @@ export type EventsListParameters = RequireAtLeastOne<{
102
102
  */
103
103
  acs_user_id?: string | undefined;
104
104
  /**
105
- * Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.
105
+ * Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a lower timestamp older than 90 days is treated as 90 days ago.
106
106
  */
107
107
  between?: Array<string> | undefined;
108
108
  /**
@@ -142,7 +142,7 @@ export type EventsListParameters = RequireAtLeastOne<{
142
142
  */
143
143
  limit?: number | undefined;
144
144
  /**
145
- * Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`.
145
+ * Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. Only events from the last 90 days are returned, so a `since` older than 90 days is treated as 90 days ago.
146
146
  */
147
147
  since?: string | undefined;
148
148
  /**
@@ -83,7 +83,7 @@ export class SeamHttpEvents {
83
83
  await clientSessions.get();
84
84
  }
85
85
  /**
86
- * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place.
86
+ * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place. Events older than 90 days are not returned.
87
87
  */
88
88
  get(parameters, options = {}) {
89
89
  return new SeamHttpRequest(this, {
@@ -99,7 +99,7 @@ export class SeamHttpEvents {
99
99
  });
100
100
  }
101
101
  /**
102
- * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place.
102
+ * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place. Only events from the last 90 days are returned.
103
103
  */
104
104
  list(parameters, options = {}) {
105
105
  return new SeamHttpRequest(this, {
@@ -98,11 +98,11 @@ export type LocksListParameters = {
98
98
  /**
99
99
  * Device type of the locks that you want to list.
100
100
  */
101
- device_type?: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | undefined;
101
+ device_type?: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'yale_access_lock' | 'yale_home_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | undefined;
102
102
  /**
103
103
  * Device types of the locks that you want to list.
104
104
  */
105
- device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock'> | undefined;
105
+ device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'yale_access_lock' | 'yale_home_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock'> | undefined;
106
106
  /**
107
107
  * Manufacturer of the locks that you want to list.
108
108
  */
@@ -92,9 +92,9 @@ export declare class SeamHttpEndpoints {
92
92
  /**
93
93
  * Returns a list of all [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
94
94
  *
95
- * Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
95
+ * Without `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`, returns access codes across the workspace, or across the customer when `customer_key` is set. Use `limit` and `page_cursor` to page through them.
96
96
  */
97
- get '/access_codes/list'(): (parameters: AccessCodesListParameters, options?: AccessCodesListOptions) => AccessCodesListRequest;
97
+ get '/access_codes/list'(): (parameters?: AccessCodesListParameters, options?: AccessCodesListOptions) => AccessCodesListRequest;
98
98
  /**
99
99
  * Retrieves a backup access code for an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). See also [Managing Backup Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes).
100
100
  *
@@ -623,11 +623,11 @@ export declare class SeamHttpEndpoints {
623
623
  */
624
624
  get '/devices/unmanaged/update'(): (parameters: DevicesUnmanagedUpdateParameters, options?: DevicesUnmanagedUpdateOptions) => DevicesUnmanagedUpdateRequest;
625
625
  /**
626
- * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place.
626
+ * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place. Events older than 90 days are not returned.
627
627
  */
628
628
  get '/events/get'(): (parameters: EventsGetParameters, options?: EventsGetOptions) => EventsGetRequest;
629
629
  /**
630
- * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place.
630
+ * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place. Only events from the last 90 days are returned.
631
631
  */
632
632
  get '/events/list'(): (parameters: EventsListParameters, options?: EventsListOptions) => EventsListRequest;
633
633
  /**
@@ -993,5 +993,5 @@ export declare class SeamHttpEndpoints {
993
993
  get '/workspaces/update'(): (parameters?: WorkspacesUpdateParameters, options?: WorkspacesUpdateOptions) => WorkspacesUpdateRequest;
994
994
  }
995
995
  export type SeamHttpEndpointQueryPaths = '/access_codes/generate_code' | '/access_codes/get' | '/access_codes/list' | '/access_codes/unmanaged/get' | '/access_codes/unmanaged/list' | '/access_grants/get' | '/access_grants/get_related' | '/access_grants/list' | '/access_grants/unmanaged/get' | '/access_grants/unmanaged/list' | '/access_methods/get' | '/access_methods/get_related' | '/access_methods/list' | '/access_methods/unmanaged/get' | '/access_methods/unmanaged/list' | '/acs/access_groups/get' | '/acs/access_groups/list' | '/acs/access_groups/list_accessible_entrances' | '/acs/access_groups/list_users' | '/acs/credentials/get' | '/acs/credentials/list' | '/acs/credentials/list_accessible_entrances' | '/acs/encoders/get' | '/acs/encoders/list' | '/acs/entrances/get' | '/acs/entrances/list' | '/acs/entrances/list_credentials_with_access' | '/acs/systems/get' | '/acs/systems/list' | '/acs/systems/list_compatible_credential_manager_acs_systems' | '/acs/users/get' | '/acs/users/list' | '/acs/users/list_accessible_entrances' | '/action_attempts/get' | '/action_attempts/list' | '/client_sessions/get' | '/client_sessions/list' | '/connect_webviews/get' | '/connect_webviews/list' | '/connected_accounts/get' | '/connected_accounts/list' | '/devices/get' | '/devices/list' | '/devices/list_device_providers' | '/devices/unmanaged/get' | '/devices/unmanaged/list' | '/events/get' | '/events/list' | '/instant_keys/get' | '/instant_keys/list' | '/locks/get' | '/locks/list' | '/media/get' | '/noise_sensors/list' | '/noise_sensors/noise_thresholds/get' | '/noise_sensors/noise_thresholds/list' | '/phones/get' | '/phones/list' | '/spaces/get' | '/spaces/get_related' | '/spaces/list' | '/thermostats/list' | '/thermostats/schedules/get' | '/thermostats/schedules/list' | '/user_identities/get' | '/user_identities/list' | '/user_identities/list_accessible_devices' | '/user_identities/list_accessible_entrances' | '/user_identities/list_acs_systems' | '/user_identities/list_acs_users' | '/user_identities/unmanaged/get' | '/user_identities/unmanaged/list' | '/webhooks/get' | '/webhooks/list' | '/workspaces/get' | '/workspaces/list';
996
- export type SeamHttpEndpointPaginatedQueryPaths = '/access_codes/list' | '/access_codes/unmanaged/list' | '/access_grants/list' | '/access_grants/unmanaged/list' | '/access_methods/list' | '/acs/credentials/list' | '/acs/encoders/list' | '/acs/entrances/list' | '/acs/users/list' | '/action_attempts/list' | '/connect_webviews/list' | '/connected_accounts/list' | '/devices/list' | '/devices/unmanaged/list' | '/spaces/list' | '/user_identities/list' | '/user_identities/unmanaged/list';
996
+ export type SeamHttpEndpointPaginatedQueryPaths = '/access_codes/list' | '/access_codes/unmanaged/list' | '/access_grants/list' | '/access_grants/unmanaged/list' | '/access_methods/list' | '/acs/credentials/list' | '/acs/encoders/list' | '/acs/entrances/list' | '/acs/users/list' | '/action_attempts/list' | '/client_sessions/list' | '/connect_webviews/list' | '/connected_accounts/list' | '/devices/list' | '/devices/unmanaged/list' | '/spaces/list' | '/user_identities/list' | '/user_identities/unmanaged/list';
997
997
  export type SeamHttpEndpointMutationPaths = '/access_codes/create' | '/access_codes/create_multiple' | '/access_codes/delete' | '/access_codes/pull_backup_access_code' | '/access_codes/report_device_constraints' | '/access_codes/update' | '/access_codes/update_multiple' | '/access_codes/simulate/create_unmanaged_access_code' | '/access_codes/unmanaged/convert_to_managed' | '/access_codes/unmanaged/delete' | '/access_codes/unmanaged/update' | '/access_grants/create' | '/access_grants/delete' | '/access_grants/request_access_methods' | '/access_grants/update' | '/access_grants/unmanaged/update' | '/access_methods/assign_card' | '/access_methods/delete' | '/access_methods/encode' | '/access_methods/unlock_door' | '/acs/access_groups/add_user' | '/acs/access_groups/delete' | '/acs/access_groups/remove_user' | '/acs/credentials/assign' | '/acs/credentials/create' | '/acs/credentials/delete' | '/acs/credentials/unassign' | '/acs/credentials/update' | '/acs/encoders/encode_credential' | '/acs/encoders/scan_credential' | '/acs/encoders/scan_to_assign_credential' | '/acs/encoders/simulate/next_credential_encode_will_fail' | '/acs/encoders/simulate/next_credential_encode_will_succeed' | '/acs/encoders/simulate/next_credential_scan_will_fail' | '/acs/encoders/simulate/next_credential_scan_will_succeed' | '/acs/entrances/grant_access' | '/acs/entrances/unlock' | '/acs/systems/report_devices' | '/acs/users/add_to_access_group' | '/acs/users/create' | '/acs/users/delete' | '/acs/users/remove_from_access_group' | '/acs/users/revoke_access_to_all_entrances' | '/acs/users/suspend' | '/acs/users/unsuspend' | '/acs/users/update' | '/cameras/live_views/create' | '/cameras/live_views/offer' | '/cameras/live_views/stop' | '/client_sessions/create' | '/client_sessions/delete' | '/client_sessions/get_or_create' | '/client_sessions/grant_access' | '/client_sessions/revoke' | '/connect_webviews/create' | '/connect_webviews/delete' | '/connected_accounts/delete' | '/connected_accounts/sync' | '/connected_accounts/update' | '/connected_accounts/simulate/disconnect' | '/customers/create_portal' | '/customers/delete_data' | '/customers/push_data' | '/devices/report_provider_metadata' | '/devices/update' | '/devices/simulate/connect' | '/devices/simulate/connect_to_hub' | '/devices/simulate/disconnect' | '/devices/simulate/disconnect_from_hub' | '/devices/simulate/paid_subscription' | '/devices/simulate/remove' | '/devices/unmanaged/update' | '/instant_keys/delete' | '/locks/configure_auto_lock' | '/locks/lock_door' | '/locks/unlock_door' | '/locks/simulate/keypad_code_entry' | '/locks/simulate/manual_lock_via_keypad' | '/noise_sensors/noise_thresholds/create' | '/noise_sensors/noise_thresholds/delete' | '/noise_sensors/noise_thresholds/update' | '/noise_sensors/simulate/trigger_noise_threshold' | '/phones/deactivate' | '/phones/simulate/create_sandbox_phone' | '/spaces/add_acs_entrances' | '/spaces/add_connected_account' | '/spaces/add_devices' | '/spaces/create' | '/spaces/delete' | '/spaces/remove_acs_entrances' | '/spaces/remove_connected_account' | '/spaces/remove_devices' | '/spaces/update' | '/thermostats/activate_climate_preset' | '/thermostats/activate_weekly_program' | '/thermostats/cool' | '/thermostats/create_climate_preset' | '/thermostats/delete_climate_preset' | '/thermostats/heat' | '/thermostats/heat_cool' | '/thermostats/off' | '/thermostats/set_fallback_climate_preset' | '/thermostats/set_fan_mode' | '/thermostats/set_hvac_mode' | '/thermostats/set_temperature_threshold' | '/thermostats/update_climate_preset' | '/thermostats/update_weekly_program' | '/thermostats/daily_programs/create' | '/thermostats/daily_programs/delete' | '/thermostats/daily_programs/update' | '/thermostats/schedules/create' | '/thermostats/schedules/delete' | '/thermostats/schedules/update' | '/thermostats/simulate/hvac_mode_adjusted' | '/thermostats/simulate/temperature_reached' | '/user_identities/add_acs_user' | '/user_identities/create' | '/user_identities/delete' | '/user_identities/generate_instant_key' | '/user_identities/grant_access_to_device' | '/user_identities/merge' | '/user_identities/remove_acs_user' | '/user_identities/revoke_access_to_device' | '/user_identities/update' | '/user_identities/unmanaged/update' | '/webhooks/create' | '/webhooks/delete' | '/webhooks/update' | '/workspaces/create' | '/workspaces/reset_sandbox' | '/workspaces/update';
@@ -188,7 +188,7 @@ export class SeamHttpEndpoints {
188
188
  /**
189
189
  * Returns a list of all [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
190
190
  *
191
- * Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
191
+ * Without `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`, returns access codes across the workspace, or across the customer when `customer_key` is set. Use `limit` and `page_cursor` to page through them.
192
192
  */
193
193
  get '/access_codes/list'() {
194
194
  const { client, defaults } = this;
@@ -1397,7 +1397,7 @@ export class SeamHttpEndpoints {
1397
1397
  };
1398
1398
  }
1399
1399
  /**
1400
- * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place.
1400
+ * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place. Events older than 90 days are not returned.
1401
1401
  */
1402
1402
  get '/events/get'() {
1403
1403
  const { client, defaults } = this;
@@ -1407,7 +1407,7 @@ export class SeamHttpEndpoints {
1407
1407
  };
1408
1408
  }
1409
1409
  /**
1410
- * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place.
1410
+ * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place. Only events from the last 90 days are returned.
1411
1411
  */
1412
1412
  get '/events/list'() {
1413
1413
  const { client, defaults } = this;
@@ -225,6 +225,10 @@ export type UserIdentitiesListParameters = {
225
225
  * `acs_system_id` of the credential manager by which you want to filter the list of user identities.
226
226
  */
227
227
  credential_manager_acs_system_id?: string | undefined;
228
+ /**
229
+ * Customer key for which you want to list user identities.
230
+ */
231
+ customer_key?: string | undefined;
228
232
  /**
229
233
  * Maximum number of records to return per page.
230
234
  */
package/lib/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- declare const seamapiJavascriptHttpVersion = "2.46.0";
1
+ declare const seamapiJavascriptHttpVersion = "2.47.0";
2
2
  export default seamapiJavascriptHttpVersion;
package/lib/version.js CHANGED
@@ -1,3 +1,3 @@
1
- const seamapiJavascriptHttpVersion = '2.46.0';
1
+ const seamapiJavascriptHttpVersion = '2.47.0';
2
2
  export default seamapiJavascriptHttpVersion;
3
3
  //# sourceMappingURL=version.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/http",
3
- "version": "2.46.0",
3
+ "version": "2.47.0",
4
4
  "description": "JavaScript HTTP client for the Seam API written in TypeScript.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -88,7 +88,7 @@
88
88
  "@seamapi/blueprint": "^1.10.0",
89
89
  "@seamapi/fake-seam-connect": "^2.0.4",
90
90
  "@seamapi/smith": "^1.1.0",
91
- "@seamapi/types": "1.1142.0",
91
+ "@seamapi/types": "1.1174.0",
92
92
  "@types/jsonwebtoken": "^9.0.6",
93
93
  "@types/node": "^24.10.9",
94
94
  "ava": "^8.0.1",
@@ -1179,6 +1179,28 @@ export type AccessCode = {
1179
1179
  */
1180
1180
  warning_code: 'being_deleted'
1181
1181
  } /**
1182
+ * Seam had been unable to reach the device for an extended period when this access code was created, so the code is unlikely to be set until the device reconnects. Check the device's connection. This warning clears automatically when the device comes back online or the code is set on the device.
1183
+ */
1184
+ | {
1185
+ /**
1186
+ * Date and time at which Seam created the warning.
1187
+ */
1188
+ created_at?: string | undefined
1189
+ /**
1190
+ * Date and time since which Seam has been unable to reach the device.
1191
+ */
1192
+ device_unreachable_since: string
1193
+
1194
+ /**
1195
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
1196
+ */
1197
+ message: string
1198
+
1199
+ /**
1200
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
1201
+ */
1202
+ warning_code: 'device_unreachable_for_extended_period'
1203
+ } /**
1182
1204
  * An unknown issue occurred with the access code.
1183
1205
  */
1184
1206
  | {
@@ -380,7 +380,7 @@ export type AcsEntrance = {
380
380
  */
381
381
  warnings: Array<
382
382
  /**
383
- * Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.
383
+ * Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://www.seam.co/help/salto-ks-lock-loses-access-code-support for troubleshooting steps.
384
384
  */
385
385
  | {
386
386
  /**
@@ -81,7 +81,7 @@ export type DeviceProvider = {
81
81
  */
82
82
  can_simulate_removal?: boolean | undefined
83
83
  /**
84
- * Indicates whether the camera supports streaming live video through a camera live view session.
84
+ * Indicates whether the camera can stream live video through a camera live view session. `false` while the camera is offline.
85
85
  */
86
86
  can_stream_live_video?: boolean | undefined
87
87
  /**
@@ -156,6 +156,7 @@ export type DeviceProvider = {
156
156
  | 'tapo'
157
157
  | 'arlo'
158
158
  | 'reolink'
159
+ | 'unifi_protect'
159
160
  | 'ical'
160
161
  | 'lodgify'
161
162
  | 'hostaway'
@@ -84,7 +84,7 @@ export type Device = {
84
84
  */
85
85
  can_simulate_removal?: boolean | undefined
86
86
  /**
87
- * Indicates whether the camera supports streaming live video through a camera live view session.
87
+ * Indicates whether the camera can stream live video through a camera live view session. `false` while the camera is offline.
88
88
  */
89
89
  can_stream_live_video?: boolean | undefined
90
90
  /**
@@ -173,7 +173,7 @@ export type Device = {
173
173
  }
174
174
  | undefined
175
175
  /**
176
- * Type of the device.
176
+ * Type of the device. The `august_lock` and `yale_lock` values are deprecated. Use `yale_access_lock` in place of `august_lock`, and `yale_access_lock` or `yale_home_lock` in place of `yale_lock`.
177
177
  */
178
178
  device_type:
179
179
  | 'akuvox_lock'
@@ -193,6 +193,8 @@ export type Device = {
193
193
  | 'smartthings_lock'
194
194
  | 'wyze_lock'
195
195
  | 'yale_lock'
196
+ | 'yale_access_lock'
197
+ | 'yale_home_lock'
196
198
  | 'two_n_intercom'
197
199
  | 'controlbyweb_device'
198
200
  | 'ttlock_lock'
@@ -223,6 +225,7 @@ export type Device = {
223
225
  | 'tapo_camera'
224
226
  | 'arlo_camera'
225
227
  | 'reolink_camera'
228
+ | 'unifi_protect_camera'
226
229
  | 'sonos_speaker'
227
230
 
228
231
  /**
@@ -2059,6 +2062,37 @@ export type Device = {
2059
2062
  time_zone?: string | null | undefined
2060
2063
  }
2061
2064
  | undefined
2065
+ /**
2066
+ * Metadata for a UniFi Protect camera.
2067
+ */
2068
+ unifi_protect_metadata?:
2069
+ | {
2070
+ /**
2071
+ * Camera ID reported by UniFi Protect.
2072
+ */
2073
+ camera_id?: string | undefined
2074
+ /**
2075
+ * Camera name reported by UniFi Protect.
2076
+ */
2077
+ camera_name?: string | undefined
2078
+ /**
2079
+ * Whether the camera has a microphone.
2080
+ */
2081
+ has_mic?: boolean | undefined
2082
+ /**
2083
+ * MAC address reported by the UniFi Protect camera.
2084
+ */
2085
+ mac?: string | undefined
2086
+ /**
2087
+ * Model reported by the UniFi Protect camera.
2088
+ */
2089
+ model?: string | undefined
2090
+ /**
2091
+ * Name of the UniFi Protect console that manages the camera.
2092
+ */
2093
+ nvr_name?: string | undefined
2094
+ }
2095
+ | undefined
2062
2096
  /**
2063
2097
  * Metadata for an ASSA ABLOY Visionline system.
2064
2098
  */
@@ -3159,7 +3193,7 @@ export type Device = {
3159
3193
  */
3160
3194
  warning_code: 'salto_ks_subscription_limit_almost_reached'
3161
3195
  } /**
3162
- * Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.
3196
+ * Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://www.seam.co/help/salto-ks-lock-loses-access-code-support for troubleshooting steps.
3163
3197
  */
3164
3198
  | {
3165
3199
  /**
@@ -3420,6 +3454,24 @@ export type Device = {
3420
3454
  * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
3421
3455
  */
3422
3456
  warning_code: 'max_access_codes_reached'
3457
+ } /**
3458
+ * Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable.
3459
+ */
3460
+ | {
3461
+ /**
3462
+ * Date and time at which Seam created the warning.
3463
+ */
3464
+ created_at: string
3465
+
3466
+ /**
3467
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
3468
+ */
3469
+ message: string
3470
+
3471
+ /**
3472
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
3473
+ */
3474
+ warning_code: 'cloud_recording_not_enabled'
3423
3475
  }
3424
3476
  >
3425
3477