@seamapi/http 2.39.0 → 2.40.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.
- package/lib/resources/access-grant.d.ts +7 -3
- package/lib/resources/access-method.d.ts +23 -0
- package/lib/resources/action-attempt.d.ts +9 -1
- package/lib/resources/device-provider.d.ts +10 -2
- package/lib/resources/device.d.ts +11 -3
- package/lib/resources/event.d.ts +1 -1
- package/lib/resources/unmanaged-access-grant.d.ts +7 -3
- package/lib/resources/unmanaged-access-method.d.ts +23 -0
- package/lib/resources/unmanaged-device.d.ts +10 -2
- package/lib/routes/customers/customers.d.ts +8 -0
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +2 -2
- package/src/lib/resources/access-grant.ts +7 -4
- package/src/lib/resources/access-method.ts +28 -0
- package/src/lib/resources/action-attempt.ts +9 -0
- package/src/lib/resources/device-provider.ts +10 -2
- package/src/lib/resources/device.ts +11 -3
- package/src/lib/resources/event.ts +1 -0
- package/src/lib/resources/unmanaged-access-grant.ts +7 -4
- package/src/lib/resources/unmanaged-access-method.ts +28 -0
- package/src/lib/resources/unmanaged-device.ts +10 -2
- package/src/lib/routes/customers/customers.ts +8 -0
- package/src/lib/version.ts +1 -1
|
@@ -310,16 +310,20 @@ export type AccessGrant = {
|
|
|
310
310
|
*/
|
|
311
311
|
warning_code: 'updating_access_times';
|
|
312
312
|
} /**
|
|
313
|
-
* Indicates that the requested PIN code was already in use on a device,
|
|
313
|
+
* Indicates that the requested PIN code could not be used, so a different code was assigned. For example, the code was already in use on a device, or the access system rejected it because it did not meet its PIN rules.
|
|
314
314
|
*/ | {
|
|
315
|
+
/**
|
|
316
|
+
* ID of the access method whose requested code was unavailable. Present when an access system, such as Salto KS, assigned a different code.
|
|
317
|
+
*/
|
|
318
|
+
access_method_id?: string | undefined;
|
|
315
319
|
/**
|
|
316
320
|
* Date and time at which Seam created the warning.
|
|
317
321
|
*/
|
|
318
322
|
created_at: string;
|
|
319
323
|
/**
|
|
320
|
-
* ID of the device where the requested code was unavailable.
|
|
324
|
+
* ID of the device where the requested code was unavailable. Present when the code was set directly on a device.
|
|
321
325
|
*/
|
|
322
|
-
device_id
|
|
326
|
+
device_id?: string | undefined;
|
|
323
327
|
/**
|
|
324
328
|
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
325
329
|
*/
|
|
@@ -325,6 +325,29 @@ export type AccessMethod = {
|
|
|
325
325
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
326
326
|
*/
|
|
327
327
|
warning_code: 'user_identity_missing_phone_number';
|
|
328
|
+
} /**
|
|
329
|
+
* Indicates that the access system could not use the PIN code requested for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant), for example because it did not meet the access system's PIN rules, so the access system assigned a different code. Give the recipient the assigned code.
|
|
330
|
+
*/ | {
|
|
331
|
+
/**
|
|
332
|
+
* Date and time at which Seam created the warning.
|
|
333
|
+
*/
|
|
334
|
+
created_at: string;
|
|
335
|
+
/**
|
|
336
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
337
|
+
*/
|
|
338
|
+
message: string;
|
|
339
|
+
/**
|
|
340
|
+
* The PIN code that was assigned instead.
|
|
341
|
+
*/
|
|
342
|
+
new_code: string;
|
|
343
|
+
/**
|
|
344
|
+
* The originally requested PIN code that could not be used.
|
|
345
|
+
*/
|
|
346
|
+
original_code: string;
|
|
347
|
+
/**
|
|
348
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
349
|
+
*/
|
|
350
|
+
warning_code: 'requested_code_unavailable';
|
|
328
351
|
}>;
|
|
329
352
|
/**
|
|
330
353
|
* ID of the Seam workspace associated with the access method.
|
|
@@ -1162,11 +1162,19 @@ export type ActionAttempt = {
|
|
|
1162
1162
|
/**
|
|
1163
1163
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
1164
1164
|
*/
|
|
1165
|
-
warning_code: 'being_deleted' | 'updating_access_times' | 'pulled_backup_access_code' | 'delay_in_issuing' | 'user_identity_missing_email_address' | 'user_identity_missing_phone_number';
|
|
1165
|
+
warning_code: 'being_deleted' | 'updating_access_times' | 'pulled_backup_access_code' | 'delay_in_issuing' | 'user_identity_missing_email_address' | 'user_identity_missing_phone_number' | 'requested_code_unavailable';
|
|
1166
1166
|
/**
|
|
1167
1167
|
* ID of the original access method from which this backup access method was split, if applicable.
|
|
1168
1168
|
*/
|
|
1169
1169
|
original_access_method_id?: string | undefined;
|
|
1170
|
+
/**
|
|
1171
|
+
* The PIN code that was assigned instead.
|
|
1172
|
+
*/
|
|
1173
|
+
new_code?: string | undefined;
|
|
1174
|
+
/**
|
|
1175
|
+
* The originally requested PIN code that could not be used.
|
|
1176
|
+
*/
|
|
1177
|
+
original_code?: string | undefined;
|
|
1170
1178
|
}>;
|
|
1171
1179
|
/**
|
|
1172
1180
|
* ID of the Seam workspace associated with the access method.
|
|
@@ -20,11 +20,11 @@ export type DeviceProvider = {
|
|
|
20
20
|
*/
|
|
21
21
|
can_hvac_heat_cool?: boolean | undefined;
|
|
22
22
|
/**
|
|
23
|
-
* Indicates whether the speaker supports muting
|
|
23
|
+
* Indicates whether the speaker supports muting.
|
|
24
24
|
*/
|
|
25
25
|
can_mute_speaker?: boolean | undefined;
|
|
26
26
|
/**
|
|
27
|
-
* Indicates whether the speaker supports pausing
|
|
27
|
+
* Indicates whether the speaker supports pausing playback.
|
|
28
28
|
*/
|
|
29
29
|
can_pause_speaker_playback?: boolean | undefined;
|
|
30
30
|
/**
|
|
@@ -59,6 +59,10 @@ export type DeviceProvider = {
|
|
|
59
59
|
* Indicates whether the device supports remote unlocking.
|
|
60
60
|
*/
|
|
61
61
|
can_remotely_unlock?: boolean | undefined;
|
|
62
|
+
/**
|
|
63
|
+
* Indicates whether the speaker supports resuming playback.
|
|
64
|
+
*/
|
|
65
|
+
can_resume_speaker_playback?: boolean | undefined;
|
|
62
66
|
/**
|
|
63
67
|
* Indicates whether the thermostat supports running climate programs.
|
|
64
68
|
*/
|
|
@@ -103,6 +107,10 @@ export type DeviceProvider = {
|
|
|
103
107
|
* Indicates whether the lock supports unlocking with an access code.
|
|
104
108
|
*/
|
|
105
109
|
can_unlock_with_code?: boolean | undefined;
|
|
110
|
+
/**
|
|
111
|
+
* Indicates whether the speaker supports unmuting.
|
|
112
|
+
*/
|
|
113
|
+
can_unmute_speaker?: boolean | undefined;
|
|
106
114
|
/**
|
|
107
115
|
* Name of the device provider.
|
|
108
116
|
*/
|
|
@@ -23,11 +23,11 @@ export type Device = {
|
|
|
23
23
|
*/
|
|
24
24
|
can_hvac_heat_cool?: boolean | undefined;
|
|
25
25
|
/**
|
|
26
|
-
* Indicates whether the speaker supports muting
|
|
26
|
+
* Indicates whether the speaker supports muting.
|
|
27
27
|
*/
|
|
28
28
|
can_mute_speaker?: boolean | undefined;
|
|
29
29
|
/**
|
|
30
|
-
* Indicates whether the speaker supports pausing
|
|
30
|
+
* Indicates whether the speaker supports pausing playback.
|
|
31
31
|
*/
|
|
32
32
|
can_pause_speaker_playback?: boolean | undefined;
|
|
33
33
|
/**
|
|
@@ -62,6 +62,10 @@ export type Device = {
|
|
|
62
62
|
* Indicates whether the device supports remote unlocking.
|
|
63
63
|
*/
|
|
64
64
|
can_remotely_unlock?: boolean | undefined;
|
|
65
|
+
/**
|
|
66
|
+
* Indicates whether the speaker supports resuming playback.
|
|
67
|
+
*/
|
|
68
|
+
can_resume_speaker_playback?: boolean | undefined;
|
|
65
69
|
/**
|
|
66
70
|
* Indicates whether the thermostat supports running climate programs.
|
|
67
71
|
*/
|
|
@@ -106,6 +110,10 @@ export type Device = {
|
|
|
106
110
|
* Indicates whether the lock supports unlocking with an access code.
|
|
107
111
|
*/
|
|
108
112
|
can_unlock_with_code?: boolean | undefined;
|
|
113
|
+
/**
|
|
114
|
+
* Indicates whether the speaker supports unmuting.
|
|
115
|
+
*/
|
|
116
|
+
can_unmute_speaker?: boolean | undefined;
|
|
109
117
|
/**
|
|
110
118
|
* Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
|
|
111
119
|
*/
|
|
@@ -1578,7 +1586,7 @@ export type Device = {
|
|
|
1578
1586
|
*/
|
|
1579
1587
|
device_name?: string | undefined;
|
|
1580
1588
|
/**
|
|
1581
|
-
*
|
|
1589
|
+
* Deprecated. Seam no longer sets this field.
|
|
1582
1590
|
*/
|
|
1583
1591
|
dual_setpoints_not_supported?: boolean | undefined;
|
|
1584
1592
|
/**
|
package/lib/resources/event.d.ts
CHANGED
|
@@ -4861,7 +4861,7 @@ export type SeamEvent = {
|
|
|
4861
4861
|
/**
|
|
4862
4862
|
* Normalized reason a lock denied access. Provider-agnostic; not all providers report every value.
|
|
4863
4863
|
*/
|
|
4864
|
-
reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
|
|
4864
|
+
reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error' | 'connection_error';
|
|
4865
4865
|
} | undefined;
|
|
4866
4866
|
/**
|
|
4867
4867
|
* ID of the workspace associated with the event.
|
|
@@ -290,16 +290,20 @@ export type UnmanagedAccessGrant = {
|
|
|
290
290
|
*/
|
|
291
291
|
warning_code: 'updating_access_times';
|
|
292
292
|
} /**
|
|
293
|
-
* Indicates that the requested PIN code was already in use on a device,
|
|
293
|
+
* Indicates that the requested PIN code could not be used, so a different code was assigned. For example, the code was already in use on a device, or the access system rejected it because it did not meet its PIN rules.
|
|
294
294
|
*/ | {
|
|
295
|
+
/**
|
|
296
|
+
* ID of the access method whose requested code was unavailable. Present when an access system, such as Salto KS, assigned a different code.
|
|
297
|
+
*/
|
|
298
|
+
access_method_id?: string | undefined;
|
|
295
299
|
/**
|
|
296
300
|
* Date and time at which Seam created the warning.
|
|
297
301
|
*/
|
|
298
302
|
created_at: string;
|
|
299
303
|
/**
|
|
300
|
-
* ID of the device where the requested code was unavailable.
|
|
304
|
+
* ID of the device where the requested code was unavailable. Present when the code was set directly on a device.
|
|
301
305
|
*/
|
|
302
|
-
device_id
|
|
306
|
+
device_id?: string | undefined;
|
|
303
307
|
/**
|
|
304
308
|
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
305
309
|
*/
|
|
@@ -313,6 +313,29 @@ export type UnmanagedAccessMethod = {
|
|
|
313
313
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
314
314
|
*/
|
|
315
315
|
warning_code: 'user_identity_missing_phone_number';
|
|
316
|
+
} /**
|
|
317
|
+
* Indicates that the access system could not use the PIN code requested for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant), for example because it did not meet the access system's PIN rules, so the access system assigned a different code. Give the recipient the assigned code.
|
|
318
|
+
*/ | {
|
|
319
|
+
/**
|
|
320
|
+
* Date and time at which Seam created the warning.
|
|
321
|
+
*/
|
|
322
|
+
created_at: string;
|
|
323
|
+
/**
|
|
324
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
325
|
+
*/
|
|
326
|
+
message: string;
|
|
327
|
+
/**
|
|
328
|
+
* The PIN code that was assigned instead.
|
|
329
|
+
*/
|
|
330
|
+
new_code: string;
|
|
331
|
+
/**
|
|
332
|
+
* The originally requested PIN code that could not be used.
|
|
333
|
+
*/
|
|
334
|
+
original_code: string;
|
|
335
|
+
/**
|
|
336
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
337
|
+
*/
|
|
338
|
+
warning_code: 'requested_code_unavailable';
|
|
316
339
|
}>;
|
|
317
340
|
/**
|
|
318
341
|
* ID of the Seam workspace associated with the access method.
|
|
@@ -23,11 +23,11 @@ export type UnmanagedDevice = {
|
|
|
23
23
|
*/
|
|
24
24
|
can_hvac_heat_cool?: boolean | undefined;
|
|
25
25
|
/**
|
|
26
|
-
* Indicates whether the speaker supports muting
|
|
26
|
+
* Indicates whether the speaker supports muting.
|
|
27
27
|
*/
|
|
28
28
|
can_mute_speaker?: boolean | undefined;
|
|
29
29
|
/**
|
|
30
|
-
* Indicates whether the speaker supports pausing
|
|
30
|
+
* Indicates whether the speaker supports pausing playback.
|
|
31
31
|
*/
|
|
32
32
|
can_pause_speaker_playback?: boolean | undefined;
|
|
33
33
|
/**
|
|
@@ -62,6 +62,10 @@ export type UnmanagedDevice = {
|
|
|
62
62
|
* Indicates whether the device supports remote unlocking.
|
|
63
63
|
*/
|
|
64
64
|
can_remotely_unlock?: boolean | undefined;
|
|
65
|
+
/**
|
|
66
|
+
* Indicates whether the speaker supports resuming playback.
|
|
67
|
+
*/
|
|
68
|
+
can_resume_speaker_playback?: boolean | undefined;
|
|
65
69
|
/**
|
|
66
70
|
* Indicates whether the thermostat supports running climate programs.
|
|
67
71
|
*/
|
|
@@ -106,6 +110,10 @@ export type UnmanagedDevice = {
|
|
|
106
110
|
* Indicates whether the lock supports unlocking with an access code.
|
|
107
111
|
*/
|
|
108
112
|
can_unlock_with_code?: boolean | undefined;
|
|
113
|
+
/**
|
|
114
|
+
* Indicates whether the speaker supports unmuting.
|
|
115
|
+
*/
|
|
116
|
+
can_unmute_speaker?: boolean | undefined;
|
|
109
117
|
/**
|
|
110
118
|
* Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
|
|
111
119
|
*/
|
|
@@ -688,6 +688,10 @@ export type CustomersCreatePortalParameters = {
|
|
|
688
688
|
* Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.
|
|
689
689
|
*/
|
|
690
690
|
allow_notification_customization?: boolean | undefined;
|
|
691
|
+
/**
|
|
692
|
+
* Indicates whether the customer can customize the sound automation rules for their properties.
|
|
693
|
+
*/
|
|
694
|
+
allow_sound_automation_rule_customization?: boolean | undefined;
|
|
691
695
|
/**
|
|
692
696
|
* Whether to exclude this feature from the portal.
|
|
693
697
|
*/
|
|
@@ -752,6 +756,10 @@ export type CustomersCreatePortalParameters = {
|
|
|
752
756
|
* Whether to exclude this feature from the portal.
|
|
753
757
|
*/
|
|
754
758
|
exclude?: boolean | undefined;
|
|
759
|
+
/**
|
|
760
|
+
* Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed.
|
|
761
|
+
*/
|
|
762
|
+
exclude_device_management?: boolean | undefined;
|
|
755
763
|
/**
|
|
756
764
|
* Indicates whether the customer can manage reservations for their properties.
|
|
757
765
|
*/
|
package/lib/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
declare const seamapiJavascriptHttpVersion = "2.
|
|
1
|
+
declare const seamapiJavascriptHttpVersion = "2.40.0";
|
|
2
2
|
export default seamapiJavascriptHttpVersion;
|
package/lib/version.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@seamapi/http",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.40.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.
|
|
91
|
+
"@seamapi/types": "1.1125.0",
|
|
92
92
|
"@types/jsonwebtoken": "^9.0.6",
|
|
93
93
|
"@types/node": "^24.10.9",
|
|
94
94
|
"ava": "^8.0.1",
|
|
@@ -364,19 +364,22 @@ export type AccessGrant = {
|
|
|
364
364
|
*/
|
|
365
365
|
warning_code: 'updating_access_times'
|
|
366
366
|
} /**
|
|
367
|
-
* Indicates that the requested PIN code was already in use on a device,
|
|
367
|
+
* Indicates that the requested PIN code could not be used, so a different code was assigned. For example, the code was already in use on a device, or the access system rejected it because it did not meet its PIN rules.
|
|
368
368
|
*/
|
|
369
369
|
| {
|
|
370
|
+
/**
|
|
371
|
+
* ID of the access method whose requested code was unavailable. Present when an access system, such as Salto KS, assigned a different code.
|
|
372
|
+
*/
|
|
373
|
+
access_method_id?: string | undefined
|
|
370
374
|
/**
|
|
371
375
|
* Date and time at which Seam created the warning.
|
|
372
376
|
*/
|
|
373
377
|
created_at: string
|
|
374
378
|
|
|
375
379
|
/**
|
|
376
|
-
* ID of the device where the requested code was unavailable.
|
|
380
|
+
* ID of the device where the requested code was unavailable. Present when the code was set directly on a device.
|
|
377
381
|
*/
|
|
378
|
-
device_id
|
|
379
|
-
|
|
382
|
+
device_id?: string | undefined
|
|
380
383
|
/**
|
|
381
384
|
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
382
385
|
*/
|
|
@@ -379,6 +379,34 @@ export type AccessMethod = {
|
|
|
379
379
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
380
380
|
*/
|
|
381
381
|
warning_code: 'user_identity_missing_phone_number'
|
|
382
|
+
} /**
|
|
383
|
+
* Indicates that the access system could not use the PIN code requested for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant), for example because it did not meet the access system's PIN rules, so the access system assigned a different code. Give the recipient the assigned code.
|
|
384
|
+
*/
|
|
385
|
+
| {
|
|
386
|
+
/**
|
|
387
|
+
* Date and time at which Seam created the warning.
|
|
388
|
+
*/
|
|
389
|
+
created_at: string
|
|
390
|
+
|
|
391
|
+
/**
|
|
392
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
393
|
+
*/
|
|
394
|
+
message: string
|
|
395
|
+
|
|
396
|
+
/**
|
|
397
|
+
* The PIN code that was assigned instead.
|
|
398
|
+
*/
|
|
399
|
+
new_code: string
|
|
400
|
+
|
|
401
|
+
/**
|
|
402
|
+
* The originally requested PIN code that could not be used.
|
|
403
|
+
*/
|
|
404
|
+
original_code: string
|
|
405
|
+
|
|
406
|
+
/**
|
|
407
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
408
|
+
*/
|
|
409
|
+
warning_code: 'requested_code_unavailable'
|
|
382
410
|
}
|
|
383
411
|
>
|
|
384
412
|
|
|
@@ -1426,11 +1426,20 @@ export type ActionAttempt =
|
|
|
1426
1426
|
| 'delay_in_issuing'
|
|
1427
1427
|
| 'user_identity_missing_email_address'
|
|
1428
1428
|
| 'user_identity_missing_phone_number'
|
|
1429
|
+
| 'requested_code_unavailable'
|
|
1429
1430
|
|
|
1430
1431
|
/**
|
|
1431
1432
|
* ID of the original access method from which this backup access method was split, if applicable.
|
|
1432
1433
|
*/
|
|
1433
1434
|
original_access_method_id?: string | undefined
|
|
1435
|
+
/**
|
|
1436
|
+
* The PIN code that was assigned instead.
|
|
1437
|
+
*/
|
|
1438
|
+
new_code?: string | undefined
|
|
1439
|
+
/**
|
|
1440
|
+
* The originally requested PIN code that could not be used.
|
|
1441
|
+
*/
|
|
1442
|
+
original_code?: string | undefined
|
|
1434
1443
|
}>
|
|
1435
1444
|
|
|
1436
1445
|
/**
|
|
@@ -25,11 +25,11 @@ export type DeviceProvider = {
|
|
|
25
25
|
*/
|
|
26
26
|
can_hvac_heat_cool?: boolean | undefined
|
|
27
27
|
/**
|
|
28
|
-
* Indicates whether the speaker supports muting
|
|
28
|
+
* Indicates whether the speaker supports muting.
|
|
29
29
|
*/
|
|
30
30
|
can_mute_speaker?: boolean | undefined
|
|
31
31
|
/**
|
|
32
|
-
* Indicates whether the speaker supports pausing
|
|
32
|
+
* Indicates whether the speaker supports pausing playback.
|
|
33
33
|
*/
|
|
34
34
|
can_pause_speaker_playback?: boolean | undefined
|
|
35
35
|
/**
|
|
@@ -64,6 +64,10 @@ export type DeviceProvider = {
|
|
|
64
64
|
* Indicates whether the device supports remote unlocking.
|
|
65
65
|
*/
|
|
66
66
|
can_remotely_unlock?: boolean | undefined
|
|
67
|
+
/**
|
|
68
|
+
* Indicates whether the speaker supports resuming playback.
|
|
69
|
+
*/
|
|
70
|
+
can_resume_speaker_playback?: boolean | undefined
|
|
67
71
|
/**
|
|
68
72
|
* Indicates whether the thermostat supports running climate programs.
|
|
69
73
|
*/
|
|
@@ -108,6 +112,10 @@ export type DeviceProvider = {
|
|
|
108
112
|
* Indicates whether the lock supports unlocking with an access code.
|
|
109
113
|
*/
|
|
110
114
|
can_unlock_with_code?: boolean | undefined
|
|
115
|
+
/**
|
|
116
|
+
* Indicates whether the speaker supports unmuting.
|
|
117
|
+
*/
|
|
118
|
+
can_unmute_speaker?: boolean | undefined
|
|
111
119
|
/**
|
|
112
120
|
* Name of the device provider.
|
|
113
121
|
*/
|
|
@@ -28,11 +28,11 @@ export type Device = {
|
|
|
28
28
|
*/
|
|
29
29
|
can_hvac_heat_cool?: boolean | undefined
|
|
30
30
|
/**
|
|
31
|
-
* Indicates whether the speaker supports muting
|
|
31
|
+
* Indicates whether the speaker supports muting.
|
|
32
32
|
*/
|
|
33
33
|
can_mute_speaker?: boolean | undefined
|
|
34
34
|
/**
|
|
35
|
-
* Indicates whether the speaker supports pausing
|
|
35
|
+
* Indicates whether the speaker supports pausing playback.
|
|
36
36
|
*/
|
|
37
37
|
can_pause_speaker_playback?: boolean | undefined
|
|
38
38
|
/**
|
|
@@ -67,6 +67,10 @@ export type Device = {
|
|
|
67
67
|
* Indicates whether the device supports remote unlocking.
|
|
68
68
|
*/
|
|
69
69
|
can_remotely_unlock?: boolean | undefined
|
|
70
|
+
/**
|
|
71
|
+
* Indicates whether the speaker supports resuming playback.
|
|
72
|
+
*/
|
|
73
|
+
can_resume_speaker_playback?: boolean | undefined
|
|
70
74
|
/**
|
|
71
75
|
* Indicates whether the thermostat supports running climate programs.
|
|
72
76
|
*/
|
|
@@ -111,6 +115,10 @@ export type Device = {
|
|
|
111
115
|
* Indicates whether the lock supports unlocking with an access code.
|
|
112
116
|
*/
|
|
113
117
|
can_unlock_with_code?: boolean | undefined
|
|
118
|
+
/**
|
|
119
|
+
* Indicates whether the speaker supports unmuting.
|
|
120
|
+
*/
|
|
121
|
+
can_unmute_speaker?: boolean | undefined
|
|
114
122
|
/**
|
|
115
123
|
* Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
|
|
116
124
|
*/
|
|
@@ -1818,7 +1826,7 @@ export type Device = {
|
|
|
1818
1826
|
*/
|
|
1819
1827
|
device_name?: string | undefined
|
|
1820
1828
|
/**
|
|
1821
|
-
*
|
|
1829
|
+
* Deprecated. Seam no longer sets this field.
|
|
1822
1830
|
*/
|
|
1823
1831
|
dual_setpoints_not_supported?: boolean | undefined
|
|
1824
1832
|
/**
|
|
@@ -342,19 +342,22 @@ export type UnmanagedAccessGrant = {
|
|
|
342
342
|
*/
|
|
343
343
|
warning_code: 'updating_access_times'
|
|
344
344
|
} /**
|
|
345
|
-
* Indicates that the requested PIN code was already in use on a device,
|
|
345
|
+
* Indicates that the requested PIN code could not be used, so a different code was assigned. For example, the code was already in use on a device, or the access system rejected it because it did not meet its PIN rules.
|
|
346
346
|
*/
|
|
347
347
|
| {
|
|
348
|
+
/**
|
|
349
|
+
* ID of the access method whose requested code was unavailable. Present when an access system, such as Salto KS, assigned a different code.
|
|
350
|
+
*/
|
|
351
|
+
access_method_id?: string | undefined
|
|
348
352
|
/**
|
|
349
353
|
* Date and time at which Seam created the warning.
|
|
350
354
|
*/
|
|
351
355
|
created_at: string
|
|
352
356
|
|
|
353
357
|
/**
|
|
354
|
-
* ID of the device where the requested code was unavailable.
|
|
358
|
+
* ID of the device where the requested code was unavailable. Present when the code was set directly on a device.
|
|
355
359
|
*/
|
|
356
|
-
device_id
|
|
357
|
-
|
|
360
|
+
device_id?: string | undefined
|
|
358
361
|
/**
|
|
359
362
|
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
360
363
|
*/
|
|
@@ -367,6 +367,34 @@ export type UnmanagedAccessMethod = {
|
|
|
367
367
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
368
368
|
*/
|
|
369
369
|
warning_code: 'user_identity_missing_phone_number'
|
|
370
|
+
} /**
|
|
371
|
+
* Indicates that the access system could not use the PIN code requested for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant), for example because it did not meet the access system's PIN rules, so the access system assigned a different code. Give the recipient the assigned code.
|
|
372
|
+
*/
|
|
373
|
+
| {
|
|
374
|
+
/**
|
|
375
|
+
* Date and time at which Seam created the warning.
|
|
376
|
+
*/
|
|
377
|
+
created_at: string
|
|
378
|
+
|
|
379
|
+
/**
|
|
380
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
381
|
+
*/
|
|
382
|
+
message: string
|
|
383
|
+
|
|
384
|
+
/**
|
|
385
|
+
* The PIN code that was assigned instead.
|
|
386
|
+
*/
|
|
387
|
+
new_code: string
|
|
388
|
+
|
|
389
|
+
/**
|
|
390
|
+
* The originally requested PIN code that could not be used.
|
|
391
|
+
*/
|
|
392
|
+
original_code: string
|
|
393
|
+
|
|
394
|
+
/**
|
|
395
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
396
|
+
*/
|
|
397
|
+
warning_code: 'requested_code_unavailable'
|
|
370
398
|
}
|
|
371
399
|
>
|
|
372
400
|
|
|
@@ -28,11 +28,11 @@ export type UnmanagedDevice = {
|
|
|
28
28
|
*/
|
|
29
29
|
can_hvac_heat_cool?: boolean | undefined
|
|
30
30
|
/**
|
|
31
|
-
* Indicates whether the speaker supports muting
|
|
31
|
+
* Indicates whether the speaker supports muting.
|
|
32
32
|
*/
|
|
33
33
|
can_mute_speaker?: boolean | undefined
|
|
34
34
|
/**
|
|
35
|
-
* Indicates whether the speaker supports pausing
|
|
35
|
+
* Indicates whether the speaker supports pausing playback.
|
|
36
36
|
*/
|
|
37
37
|
can_pause_speaker_playback?: boolean | undefined
|
|
38
38
|
/**
|
|
@@ -67,6 +67,10 @@ export type UnmanagedDevice = {
|
|
|
67
67
|
* Indicates whether the device supports remote unlocking.
|
|
68
68
|
*/
|
|
69
69
|
can_remotely_unlock?: boolean | undefined
|
|
70
|
+
/**
|
|
71
|
+
* Indicates whether the speaker supports resuming playback.
|
|
72
|
+
*/
|
|
73
|
+
can_resume_speaker_playback?: boolean | undefined
|
|
70
74
|
/**
|
|
71
75
|
* Indicates whether the thermostat supports running climate programs.
|
|
72
76
|
*/
|
|
@@ -111,6 +115,10 @@ export type UnmanagedDevice = {
|
|
|
111
115
|
* Indicates whether the lock supports unlocking with an access code.
|
|
112
116
|
*/
|
|
113
117
|
can_unlock_with_code?: boolean | undefined
|
|
118
|
+
/**
|
|
119
|
+
* Indicates whether the speaker supports unmuting.
|
|
120
|
+
*/
|
|
121
|
+
can_unmute_speaker?: boolean | undefined
|
|
114
122
|
/**
|
|
115
123
|
* Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
|
|
116
124
|
*/
|
|
@@ -936,6 +936,10 @@ export type CustomersCreatePortalParameters = {
|
|
|
936
936
|
* Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.
|
|
937
937
|
*/
|
|
938
938
|
allow_notification_customization?: boolean | undefined
|
|
939
|
+
/**
|
|
940
|
+
* Indicates whether the customer can customize the sound automation rules for their properties.
|
|
941
|
+
*/
|
|
942
|
+
allow_sound_automation_rule_customization?: boolean | undefined
|
|
939
943
|
/**
|
|
940
944
|
* Whether to exclude this feature from the portal.
|
|
941
945
|
*/
|
|
@@ -1008,6 +1012,10 @@ export type CustomersCreatePortalParameters = {
|
|
|
1008
1012
|
* Whether to exclude this feature from the portal.
|
|
1009
1013
|
*/
|
|
1010
1014
|
exclude?: boolean | undefined
|
|
1015
|
+
/**
|
|
1016
|
+
* Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed.
|
|
1017
|
+
*/
|
|
1018
|
+
exclude_device_management?: boolean | undefined
|
|
1011
1019
|
/**
|
|
1012
1020
|
* Indicates whether the customer can manage reservations for their properties.
|
|
1013
1021
|
*/
|
package/src/lib/version.ts
CHANGED