@seamapi/http 2.35.0 → 2.37.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.
@@ -365,7 +365,7 @@ export type AccessCode = {
365
365
  */
366
366
  message: string;
367
367
  } /**
368
- * Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
368
+ * Indicates that the provider's system to which this device belongs is not letting Seam act on it, so Seam cannot manage access codes or unlock the device. The error message says which of three causes applies. Seam's integration user may not have sufficient permissions on the provider's system, or may have been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. The provider account or site may not have a valid subscription with the provider: set up or renew that subscription with the provider. Or the provider may have rejected the credential Seam uses to operate the device's hub: contact Seam support to re-activate it.
369
369
  */ | {
370
370
  /**
371
371
  * Date and time at which Seam created the error.
@@ -110,7 +110,7 @@ export type AcsSystem = {
110
110
  */
111
111
  message: string;
112
112
  } /**
113
- * Indicates that Seam's integration user does not have sufficient permissions on the provider's system backing this [access control system](https://www.seam.co/docs/low-level-apis/access-systems). Access cannot be managed until permissions are restored. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
113
+ * Indicates that the provider's system backing this [access control system](https://www.seam.co/docs/low-level-apis/access-systems) is not letting Seam act on it, so access cannot be managed until this is resolved. The error message says which of two causes applies. Either Seam's integration user does not have sufficient permissions on the provider's system, or has been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. Or the provider account or site does not have a valid subscription with the provider: set up or renew that subscription with the provider.
114
114
  */ | {
115
115
  /**
116
116
  * Date and time at which Seam created the error.
@@ -90,7 +90,7 @@ export type DeviceProvider = {
90
90
  /**
91
91
  * Name of the device provider.
92
92
  */
93
- device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara';
93
+ device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara';
94
94
  /**
95
95
  * Display name for the device provider.
96
96
  */
@@ -151,7 +151,7 @@ export type Device = {
151
151
  /**
152
152
  * Type of the device.
153
153
  */
154
- 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' | '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';
154
+ 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' | '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';
155
155
  /**
156
156
  * Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.
157
157
  */
@@ -208,7 +208,7 @@ export type Device = {
208
208
  */
209
209
  message: string;
210
210
  } /**
211
- * Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
211
+ * Indicates that the provider's system to which this device belongs is not letting Seam act on it, so Seam cannot manage access codes or unlock the device. The error message says which of three causes applies. Seam's integration user may not have sufficient permissions on the provider's system, or may have been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. The provider account or site may not have a valid subscription with the provider: set up or renew that subscription with the provider. Or the provider may have rejected the credential Seam uses to operate the device's hub: contact Seam support to re-activate it.
212
212
  */ | {
213
213
  /**
214
214
  * Date and time at which Seam created the error.
@@ -1406,6 +1406,23 @@ export type Device = {
1406
1406
  */
1407
1407
  timezone_raw_offset_ms?: number | undefined;
1408
1408
  } | undefined;
1409
+ /**
1410
+ * Metadata for a Reolink camera.
1411
+ */
1412
+ reolink_metadata?: {
1413
+ /**
1414
+ * Firmware version reported by the camera.
1415
+ */
1416
+ firmware_version?: string | undefined;
1417
+ /**
1418
+ * Hardware version reported by the camera.
1419
+ */
1420
+ hardware_version?: string | undefined;
1421
+ /**
1422
+ * Model reported by the Reolink camera.
1423
+ */
1424
+ model?: string | undefined;
1425
+ } | undefined;
1409
1426
  /**
1410
1427
  * Metadata for a Ring device.
1411
1428
  */
@@ -38,6 +38,10 @@ export type Media = {
38
38
  * Short-lived URL from which you can download the media. Null unless `status` is `available`. The URL expires after about five minutes. Call `/media/get` again for a new URL.
39
39
  */
40
40
  url: string | null;
41
+ /**
42
+ * Video codec used to encode the media. Only present for video media. `hevc` (H.265) playback support varies by browser and device, so check compatibility before assuming a clip plays inline.
43
+ */
44
+ video_codec?: 'h264' | 'hevc' | undefined;
41
45
  /**
42
46
  * ID of the workspace that contains the media.
43
47
  */
@@ -68,6 +68,27 @@ export type Space = {
68
68
  * Unique key for the space within the workspace.
69
69
  */
70
70
  space_key?: string | undefined;
71
+ /**
72
+ * Warnings associated with the space.
73
+ */
74
+ warnings: Array<
75
+ /**
76
+ * Indicates that the space is being deleted. Seam removes it, revokes its access grants, and detaches its devices and entrances shortly.
77
+ */
78
+ {
79
+ /**
80
+ * Date and time at which Seam created the warning.
81
+ */
82
+ created_at: string;
83
+ /**
84
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
85
+ */
86
+ message: string;
87
+ /**
88
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
89
+ */
90
+ warning_code: 'being_deleted';
91
+ }>;
71
92
  /**
72
93
  * ID of the workspace associated with the space.
73
94
  */
@@ -371,7 +371,7 @@ export type UnmanagedAccessCode = {
371
371
  */
372
372
  message: string;
373
373
  } /**
374
- * Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
374
+ * Indicates that the provider's system to which this device belongs is not letting Seam act on it, so Seam cannot manage access codes or unlock the device. The error message says which of three causes applies. Seam's integration user may not have sufficient permissions on the provider's system, or may have been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. The provider account or site may not have a valid subscription with the provider: set up or renew that subscription with the provider. Or the provider may have rejected the credential Seam uses to operate the device's hub: contact Seam support to re-activate it.
375
375
  */ | {
376
376
  /**
377
377
  * Date and time at which Seam created the error.
@@ -113,7 +113,7 @@ export type UnmanagedDevice = {
113
113
  /**
114
114
  * Type of the device.
115
115
  */
116
- 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' | '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';
116
+ 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' | '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';
117
117
  /**
118
118
  * Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.
119
119
  */
@@ -170,7 +170,7 @@ export type UnmanagedDevice = {
170
170
  */
171
171
  message: string;
172
172
  } /**
173
- * Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
173
+ * Indicates that the provider's system to which this device belongs is not letting Seam act on it, so Seam cannot manage access codes or unlock the device. The error message says which of three causes applies. Seam's integration user may not have sufficient permissions on the provider's system, or may have been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. The provider account or site may not have a valid subscription with the provider: set up or renew that subscription with the provider. Or the provider may have rejected the credential Seam uses to operate the device's hub: contact Seam support to re-activate it.
174
174
  */ | {
175
175
  /**
176
176
  * Date and time at which Seam created the error.
@@ -69,7 +69,7 @@ export type ClientSessionsCreateParameters = {
69
69
  */
70
70
  expires_at?: string | Date | Temporal.Instant | undefined;
71
71
  /**
72
- * Your user ID for the user for whom you want to create a client session.
72
+ * Your user ID for the user for whom you want to create a client session. When you authenticate with a publishable key, the `user_identifier_key` must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the `user_identifier_key` can retrieve the client session.
73
73
  */
74
74
  user_identifier_key?: string | undefined;
75
75
  /**
@@ -137,7 +137,7 @@ export type ClientSessionsGetOrCreateParameters = {
137
137
  */
138
138
  expires_at?: string | Date | Temporal.Instant | undefined;
139
139
  /**
140
- * Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session).
140
+ * Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session). When you authenticate with a publishable key, the `user_identifier_key` must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the `user_identifier_key` can retrieve the client session.
141
141
  */
142
142
  user_identifier_key?: string | undefined;
143
143
  /**
@@ -50,7 +50,7 @@ export type ConnectWebviewsCreateParameters = {
50
50
  /**
51
51
  * Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://www.seam.co/docs/api/devices/list_device_providers) with no filters.
52
52
  */
53
- accepted_providers?: Array<'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'yale_access' | 'hid_cm' | 'google_nest' | 'slack'> | undefined;
53
+ accepted_providers?: Array<'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'yale_access' | 'hid_cm' | 'google_nest' | 'slack'> | undefined;
54
54
  /**
55
55
  * Indicates whether newly-added devices should appear as [managed devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).
56
56
  */
@@ -68,9 +68,9 @@ export type CustomersCreatePortalParameters = {
68
68
  */
69
69
  name?: string | undefined;
70
70
  /**
71
- * Preferred PIN code to use when creating access for this reservation.
71
+ * 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.
72
72
  */
73
- preferred_code?: string | undefined;
73
+ preferred_code?: string | null | undefined;
74
74
  /**
75
75
  * Property keys associated with the access grant.
76
76
  */
@@ -145,9 +145,9 @@ export type CustomersCreatePortalParameters = {
145
145
  */
146
146
  name?: string | undefined;
147
147
  /**
148
- * Preferred PIN code to use when creating access for this reservation.
148
+ * 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.
149
149
  */
150
- preferred_code?: string | undefined;
150
+ preferred_code?: string | null | undefined;
151
151
  /**
152
152
  * Property keys associated with the access grant.
153
153
  */
@@ -219,6 +219,10 @@ export type CustomersCreatePortalParameters = {
219
219
  * Your unique identifier for the customer.
220
220
  */
221
221
  customer_key?: string | undefined;
222
+ /**
223
+ * ID of the customization profile to use for this customer. Access grants that automations create for this customer use this profile. Pass `null` to remove the customer's customization profile.
224
+ */
225
+ customization_profile_id?: string | null | undefined;
222
226
  /**
223
227
  * List of gym or fitness facilities.
224
228
  */
@@ -333,9 +337,9 @@ export type CustomersCreatePortalParameters = {
333
337
  */
334
338
  name?: string | undefined;
335
339
  /**
336
- * Preferred PIN code to use when creating access for this reservation.
340
+ * 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.
337
341
  */
338
- preferred_code?: string | undefined;
342
+ preferred_code?: string | null | undefined;
339
343
  /**
340
344
  * Property keys associated with the access grant.
341
345
  */
@@ -943,9 +947,9 @@ export type CustomersPushDataParameters = {
943
947
  */
944
948
  name?: string | undefined;
945
949
  /**
946
- * Preferred PIN code to use when creating access for this reservation.
950
+ * 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.
947
951
  */
948
- preferred_code?: string | undefined;
952
+ preferred_code?: string | null | undefined;
949
953
  /**
950
954
  * Property keys associated with the access grant.
951
955
  */
@@ -1020,9 +1024,9 @@ export type CustomersPushDataParameters = {
1020
1024
  */
1021
1025
  name?: string | undefined;
1022
1026
  /**
1023
- * Preferred PIN code to use when creating access for this reservation.
1027
+ * 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.
1024
1028
  */
1025
- preferred_code?: string | undefined;
1029
+ preferred_code?: string | null | undefined;
1026
1030
  /**
1027
1031
  * Property keys associated with the access grant.
1028
1032
  */
@@ -1094,6 +1098,10 @@ export type CustomersPushDataParameters = {
1094
1098
  * Your unique identifier for the customer.
1095
1099
  */
1096
1100
  customer_key: string;
1101
+ /**
1102
+ * ID of the customization profile to use for this customer. Access grants that automations create for this customer use this profile. Pass `null` to remove the customer's customization profile.
1103
+ */
1104
+ customization_profile_id?: string | null | undefined;
1097
1105
  /**
1098
1106
  * List of gym or fitness facilities.
1099
1107
  */
@@ -1208,9 +1216,9 @@ export type CustomersPushDataParameters = {
1208
1216
  */
1209
1217
  name?: string | undefined;
1210
1218
  /**
1211
- * Preferred PIN code to use when creating access for this reservation.
1219
+ * 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.
1212
1220
  */
1213
- preferred_code?: string | undefined;
1221
+ preferred_code?: string | null | undefined;
1214
1222
  /**
1215
1223
  * Property keys associated with the access grant.
1216
1224
  */
@@ -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' | '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' | 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' | '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' | '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' | 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' | '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'> | 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' | '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' | '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'> | 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' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 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' | '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' | 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' | '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' | 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' | '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' | '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' | 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' | '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'> | 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' | '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' | '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'> | 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' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 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' | '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' | undefined;
100
100
  /**
101
101
  * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
102
102
  */
package/lib/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- declare const seamapiJavascriptHttpVersion = "2.35.0";
1
+ declare const seamapiJavascriptHttpVersion = "2.37.0";
2
2
  export default seamapiJavascriptHttpVersion;
package/lib/version.js CHANGED
@@ -1,3 +1,3 @@
1
- const seamapiJavascriptHttpVersion = '2.35.0';
1
+ const seamapiJavascriptHttpVersion = '2.37.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.35.0",
3
+ "version": "2.37.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.1086.0",
91
+ "@seamapi/types": "1.1098.0",
92
92
  "@types/jsonwebtoken": "^9.0.6",
93
93
  "@types/node": "^24.10.9",
94
94
  "ava": "^8.0.1",
@@ -424,7 +424,7 @@ export type AccessCode = {
424
424
  */
425
425
  message: string
426
426
  } /**
427
- * Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
427
+ * Indicates that the provider's system to which this device belongs is not letting Seam act on it, so Seam cannot manage access codes or unlock the device. The error message says which of three causes applies. Seam's integration user may not have sufficient permissions on the provider's system, or may have been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. The provider account or site may not have a valid subscription with the provider: set up or renew that subscription with the provider. Or the provider may have rejected the credential Seam uses to operate the device's hub: contact Seam support to re-activate it.
428
428
  */
429
429
  | {
430
430
  /**
@@ -130,7 +130,7 @@ export type AcsSystem = {
130
130
  */
131
131
  message: string
132
132
  } /**
133
- * Indicates that Seam's integration user does not have sufficient permissions on the provider's system backing this [access control system](https://www.seam.co/docs/low-level-apis/access-systems). Access cannot be managed until permissions are restored. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
133
+ * Indicates that the provider's system backing this [access control system](https://www.seam.co/docs/low-level-apis/access-systems) is not letting Seam act on it, so access cannot be managed until this is resolved. The error message says which of two causes applies. Either Seam's integration user does not have sufficient permissions on the provider's system, or has been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. Or the provider account or site does not have a valid subscription with the provider: set up or renew that subscription with the provider.
134
134
  */
135
135
  | {
136
136
  /**
@@ -155,6 +155,7 @@ export type DeviceProvider = {
155
155
  | 'ring'
156
156
  | 'tapo'
157
157
  | 'arlo'
158
+ | 'reolink'
158
159
  | 'ical'
159
160
  | 'lodgify'
160
161
  | 'hostaway'
@@ -221,6 +221,7 @@ export type Device = {
221
221
  | 'ring_camera'
222
222
  | 'tapo_camera'
223
223
  | 'arlo_camera'
224
+ | 'reolink_camera'
224
225
 
225
226
  /**
226
227
  * Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.
@@ -288,7 +289,7 @@ export type Device = {
288
289
  */
289
290
  message: string
290
291
  } /**
291
- * Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
292
+ * Indicates that the provider's system to which this device belongs is not letting Seam act on it, so Seam cannot manage access codes or unlock the device. The error message says which of three causes applies. Seam's integration user may not have sufficient permissions on the provider's system, or may have been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. The provider account or site may not have a valid subscription with the provider: set up or renew that subscription with the provider. Or the provider may have rejected the credential Seam uses to operate the device's hub: contact Seam support to re-activate it.
292
293
  */
293
294
  | {
294
295
  /**
@@ -1631,6 +1632,25 @@ export type Device = {
1631
1632
  timezone_raw_offset_ms?: number | undefined
1632
1633
  }
1633
1634
  | undefined
1635
+ /**
1636
+ * Metadata for a Reolink camera.
1637
+ */
1638
+ reolink_metadata?:
1639
+ | {
1640
+ /**
1641
+ * Firmware version reported by the camera.
1642
+ */
1643
+ firmware_version?: string | undefined
1644
+ /**
1645
+ * Hardware version reported by the camera.
1646
+ */
1647
+ hardware_version?: string | undefined
1648
+ /**
1649
+ * Model reported by the Reolink camera.
1650
+ */
1651
+ model?: string | undefined
1652
+ }
1653
+ | undefined
1634
1654
  /**
1635
1655
  * Metadata for a Ring device.
1636
1656
  */
@@ -47,6 +47,10 @@ export type Media = {
47
47
  * Short-lived URL from which you can download the media. Null unless `status` is `available`. The URL expires after about five minutes. Call `/media/get` again for a new URL.
48
48
  */
49
49
  url: string | null
50
+ /**
51
+ * Video codec used to encode the media. Only present for video media. `hevc` (H.265) playback support varies by browser and device, so check compatibility before assuming a clip plays inline.
52
+ */
53
+ video_codec?: 'h264' | 'hevc' | undefined
50
54
  /**
51
55
  * ID of the workspace that contains the media.
52
56
  */
@@ -85,6 +85,31 @@ export type Space = {
85
85
  * Unique key for the space within the workspace.
86
86
  */
87
87
  space_key?: string | undefined
88
+ /**
89
+ * Warnings associated with the space.
90
+ */
91
+ warnings: Array<
92
+ /**
93
+ * Indicates that the space is being deleted. Seam removes it, revokes its access grants, and detaches its devices and entrances shortly.
94
+ */
95
+ {
96
+ /**
97
+ * Date and time at which Seam created the warning.
98
+ */
99
+ created_at: string
100
+
101
+ /**
102
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
103
+ */
104
+ message: string
105
+
106
+ /**
107
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
108
+ */
109
+ warning_code: 'being_deleted'
110
+ }
111
+ >
112
+
88
113
  /**
89
114
  * ID of the workspace associated with the space.
90
115
  */
@@ -430,7 +430,7 @@ export type UnmanagedAccessCode = {
430
430
  */
431
431
  message: string
432
432
  } /**
433
- * Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
433
+ * Indicates that the provider's system to which this device belongs is not letting Seam act on it, so Seam cannot manage access codes or unlock the device. The error message says which of three causes applies. Seam's integration user may not have sufficient permissions on the provider's system, or may have been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. The provider account or site may not have a valid subscription with the provider: set up or renew that subscription with the provider. Or the provider may have rejected the credential Seam uses to operate the device's hub: contact Seam support to re-activate it.
434
434
  */
435
435
  | {
436
436
  /**
@@ -176,6 +176,7 @@ export type UnmanagedDevice = {
176
176
  | 'ring_camera'
177
177
  | 'tapo_camera'
178
178
  | 'arlo_camera'
179
+ | 'reolink_camera'
179
180
 
180
181
  /**
181
182
  * Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.
@@ -243,7 +244,7 @@ export type UnmanagedDevice = {
243
244
  */
244
245
  message: string
245
246
  } /**
246
- * Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
247
+ * Indicates that the provider's system to which this device belongs is not letting Seam act on it, so Seam cannot manage access codes or unlock the device. The error message says which of three causes applies. Seam's integration user may not have sufficient permissions on the provider's system, or may have been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. The provider account or site may not have a valid subscription with the provider: set up or renew that subscription with the provider. Or the provider may have rejected the credential Seam uses to operate the device's hub: contact Seam support to re-activate it.
247
248
  */
248
249
  | {
249
250
  /**
@@ -333,7 +333,7 @@ export type ClientSessionsCreateParameters = {
333
333
  */
334
334
  expires_at?: string | Date | Temporal.Instant | undefined
335
335
  /**
336
- * Your user ID for the user for whom you want to create a client session.
336
+ * Your user ID for the user for whom you want to create a client session. When you authenticate with a publishable key, the `user_identifier_key` must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the `user_identifier_key` can retrieve the client session.
337
337
  */
338
338
  user_identifier_key?: string | undefined
339
339
  /**
@@ -412,7 +412,7 @@ export type ClientSessionsGetOrCreateParameters = {
412
412
  */
413
413
  expires_at?: string | Date | Temporal.Instant | undefined
414
414
  /**
415
- * Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session).
415
+ * Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session). When you authenticate with a publishable key, the `user_identifier_key` must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the `user_identifier_key` can retrieve the client session.
416
416
  */
417
417
  user_identifier_key?: string | undefined
418
418
  /**
@@ -326,6 +326,7 @@ export type ConnectWebviewsCreateParameters = {
326
326
  | 'ring'
327
327
  | 'tapo'
328
328
  | 'arlo'
329
+ | 'reolink'
329
330
  | 'ical'
330
331
  | 'lodgify'
331
332
  | 'hostaway'
@@ -264,9 +264,9 @@ export type CustomersCreatePortalParameters = {
264
264
  */
265
265
  name?: string | undefined
266
266
  /**
267
- * Preferred PIN code to use when creating access for this reservation.
267
+ * 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.
268
268
  */
269
- preferred_code?: string | undefined
269
+ preferred_code?: string | null | undefined
270
270
  /**
271
271
  * Property keys associated with the access grant.
272
272
  */
@@ -343,9 +343,9 @@ export type CustomersCreatePortalParameters = {
343
343
  */
344
344
  name?: string | undefined
345
345
  /**
346
- * Preferred PIN code to use when creating access for this reservation.
346
+ * 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.
347
347
  */
348
- preferred_code?: string | undefined
348
+ preferred_code?: string | null | undefined
349
349
  /**
350
350
  * Property keys associated with the access grant.
351
351
  */
@@ -422,6 +422,10 @@ export type CustomersCreatePortalParameters = {
422
422
  * Your unique identifier for the customer.
423
423
  */
424
424
  customer_key?: string | undefined
425
+ /**
426
+ * ID of the customization profile to use for this customer. Access grants that automations create for this customer use this profile. Pass `null` to remove the customer's customization profile.
427
+ */
428
+ customization_profile_id?: string | null | undefined
425
429
  /**
426
430
  * List of gym or fitness facilities.
427
431
  */
@@ -547,9 +551,9 @@ export type CustomersCreatePortalParameters = {
547
551
  */
548
552
  name?: string | undefined
549
553
  /**
550
- * Preferred PIN code to use when creating access for this reservation.
554
+ * 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.
551
555
  */
552
- preferred_code?: string | undefined
556
+ preferred_code?: string | null | undefined
553
557
  /**
554
558
  * Property keys associated with the access grant.
555
559
  */
@@ -1240,9 +1244,9 @@ export type CustomersPushDataParameters = {
1240
1244
  */
1241
1245
  name?: string | undefined
1242
1246
  /**
1243
- * Preferred PIN code to use when creating access for this reservation.
1247
+ * 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.
1244
1248
  */
1245
- preferred_code?: string | undefined
1249
+ preferred_code?: string | null | undefined
1246
1250
  /**
1247
1251
  * Property keys associated with the access grant.
1248
1252
  */
@@ -1319,9 +1323,9 @@ export type CustomersPushDataParameters = {
1319
1323
  */
1320
1324
  name?: string | undefined
1321
1325
  /**
1322
- * Preferred PIN code to use when creating access for this reservation.
1326
+ * 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.
1323
1327
  */
1324
- preferred_code?: string | undefined
1328
+ preferred_code?: string | null | undefined
1325
1329
  /**
1326
1330
  * Property keys associated with the access grant.
1327
1331
  */
@@ -1399,6 +1403,10 @@ export type CustomersPushDataParameters = {
1399
1403
  */
1400
1404
  customer_key: string
1401
1405
 
1406
+ /**
1407
+ * ID of the customization profile to use for this customer. Access grants that automations create for this customer use this profile. Pass `null` to remove the customer's customization profile.
1408
+ */
1409
+ customization_profile_id?: string | null | undefined
1402
1410
  /**
1403
1411
  * List of gym or fitness facilities.
1404
1412
  */
@@ -1524,9 +1532,9 @@ export type CustomersPushDataParameters = {
1524
1532
  */
1525
1533
  name?: string | undefined
1526
1534
  /**
1527
- * Preferred PIN code to use when creating access for this reservation.
1535
+ * 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.
1528
1536
  */
1529
- preferred_code?: string | undefined
1537
+ preferred_code?: string | null | undefined
1530
1538
  /**
1531
1539
  * Property keys associated with the access grant.
1532
1540
  */
@@ -385,6 +385,7 @@ export type DevicesListParameters = {
385
385
  | 'ring_camera'
386
386
  | 'tapo_camera'
387
387
  | 'arlo_camera'
388
+ | 'reolink_camera'
388
389
  | undefined
389
390
  /**
390
391
  * Array of device types for which you want to list devices.
@@ -436,6 +437,7 @@ export type DevicesListParameters = {
436
437
  | 'ring_camera'
437
438
  | 'tapo_camera'
438
439
  | 'arlo_camera'
440
+ | 'reolink_camera'
439
441
  >
440
442
  | undefined
441
443
  /**
@@ -493,6 +495,7 @@ export type DevicesListParameters = {
493
495
  | 'ring'
494
496
  | 'tapo'
495
497
  | 'arlo'
498
+ | 'reolink'
496
499
  | 'ical'
497
500
  | 'lodgify'
498
501
  | 'hostaway'
@@ -332,6 +332,7 @@ export type DevicesUnmanagedListParameters = {
332
332
  | 'ring_camera'
333
333
  | 'tapo_camera'
334
334
  | 'arlo_camera'
335
+ | 'reolink_camera'
335
336
  | undefined
336
337
  /**
337
338
  * Array of device types for which you want to list devices.
@@ -383,6 +384,7 @@ export type DevicesUnmanagedListParameters = {
383
384
  | 'ring_camera'
384
385
  | 'tapo_camera'
385
386
  | 'arlo_camera'
387
+ | 'reolink_camera'
386
388
  >
387
389
  | undefined
388
390
  /**
@@ -440,6 +442,7 @@ export type DevicesUnmanagedListParameters = {
440
442
  | 'ring'
441
443
  | 'tapo'
442
444
  | 'arlo'
445
+ | 'reolink'
443
446
  | 'ical'
444
447
  | 'lodgify'
445
448
  | 'hostaway'
@@ -1,3 +1,3 @@
1
- const seamapiJavascriptHttpVersion = '2.35.0'
1
+ const seamapiJavascriptHttpVersion = '2.37.0'
2
2
 
3
3
  export default seamapiJavascriptHttpVersion