@seamapi/http 2.40.0 → 2.42.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-code.d.ts +1 -1
- package/lib/resources/access-grant.d.ts +19 -0
- package/lib/resources/action-attempt.d.ts +0 -325
- package/lib/resources/device-provider.d.ts +0 -24
- package/lib/resources/device.d.ts +0 -119
- package/lib/resources/unmanaged-access-code.d.ts +1 -1
- package/lib/resources/unmanaged-access-grant.d.ts +19 -0
- package/lib/resources/unmanaged-device.d.ts +0 -24
- package/lib/routes/customers/customers.d.ts +3 -0
- package/lib/routes/user-identities/user-identities.d.ts +4 -0
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +2 -2
- package/src/lib/resources/access-code.ts +1 -1
- package/src/lib/resources/access-grant.ts +23 -0
- package/src/lib/resources/action-attempt.ts +0 -395
- package/src/lib/resources/device-provider.ts +0 -24
- package/src/lib/resources/device.ts +0 -134
- package/src/lib/resources/unmanaged-access-code.ts +1 -1
- package/src/lib/resources/unmanaged-access-grant.ts +23 -0
- package/src/lib/resources/unmanaged-device.ts +0 -24
- package/src/lib/routes/customers/customers.ts +3 -1
- package/src/lib/routes/user-identities/user-identities.ts +4 -0
- package/src/lib/version.ts +1 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@seamapi/http",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.42.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.1132.0",
|
|
92
92
|
"@types/jsonwebtoken": "^9.0.6",
|
|
93
93
|
"@types/node": "^24.10.9",
|
|
94
94
|
"ava": "^8.0.1",
|
|
@@ -302,7 +302,7 @@ export type AccessCode = {
|
|
|
302
302
|
*/
|
|
303
303
|
message: string
|
|
304
304
|
} /**
|
|
305
|
-
* Seam was unable to issue this access code before its start time, so the recipient may be unable to unlock the device. This usually points to a problem that needs attention, such as an offline or disconnected device.
|
|
305
|
+
* Seam was unable to issue this access code before its start time, so the recipient may be unable to unlock the device. This usually points to a problem that needs attention, such as an offline or disconnected device. This error clears automatically if the access code is eventually issued.
|
|
306
306
|
*/
|
|
307
307
|
| {
|
|
308
308
|
/**
|
|
@@ -453,6 +453,29 @@ export type AccessGrant = {
|
|
|
453
453
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
454
454
|
*/
|
|
455
455
|
warning_code: 'device_time_constraints_violated'
|
|
456
|
+
} /**
|
|
457
|
+
* Indicates that one of this access grant's access methods no longer grants access because of a change outside Seam, for example its card was encoded again for another credential. Seam does not replace the access method; issue a new one if the user still needs it.
|
|
458
|
+
*/
|
|
459
|
+
| {
|
|
460
|
+
/**
|
|
461
|
+
* ID of the access method whose access was revoked.
|
|
462
|
+
*/
|
|
463
|
+
access_method_id: string
|
|
464
|
+
|
|
465
|
+
/**
|
|
466
|
+
* Date and time at which Seam created the warning.
|
|
467
|
+
*/
|
|
468
|
+
created_at: string
|
|
469
|
+
|
|
470
|
+
/**
|
|
471
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
472
|
+
*/
|
|
473
|
+
message: string
|
|
474
|
+
|
|
475
|
+
/**
|
|
476
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
477
|
+
*/
|
|
478
|
+
warning_code: 'access_revoked'
|
|
456
479
|
}
|
|
457
480
|
>
|
|
458
481
|
|
|
@@ -2278,401 +2278,6 @@ export type ActionAttempt =
|
|
|
2278
2278
|
*/
|
|
2279
2279
|
action_attempt_id: string
|
|
2280
2280
|
|
|
2281
|
-
/**
|
|
2282
|
-
* Action attempt to track the status of setting the volume on a speaker.
|
|
2283
|
-
*/
|
|
2284
|
-
action_type: 'SET_SPEAKER_VOLUME'
|
|
2285
|
-
|
|
2286
|
-
/**
|
|
2287
|
-
* Error associated with the action.
|
|
2288
|
-
*/
|
|
2289
|
-
error: null
|
|
2290
|
-
/**
|
|
2291
|
-
* Result of the action.
|
|
2292
|
-
*/
|
|
2293
|
-
result: {}
|
|
2294
|
-
|
|
2295
|
-
status: 'success'
|
|
2296
|
-
}
|
|
2297
|
-
| {
|
|
2298
|
-
/**
|
|
2299
|
-
* ID of the action attempt.
|
|
2300
|
-
*/
|
|
2301
|
-
action_attempt_id: string
|
|
2302
|
-
|
|
2303
|
-
/**
|
|
2304
|
-
* Action attempt to track the status of setting the volume on a speaker.
|
|
2305
|
-
*/
|
|
2306
|
-
action_type: 'SET_SPEAKER_VOLUME'
|
|
2307
|
-
|
|
2308
|
-
/**
|
|
2309
|
-
* Error associated with the action.
|
|
2310
|
-
*/
|
|
2311
|
-
error: null
|
|
2312
|
-
/**
|
|
2313
|
-
* Result of the action.
|
|
2314
|
-
*/
|
|
2315
|
-
result: null
|
|
2316
|
-
|
|
2317
|
-
status: 'pending'
|
|
2318
|
-
}
|
|
2319
|
-
| {
|
|
2320
|
-
/**
|
|
2321
|
-
* ID of the action attempt.
|
|
2322
|
-
*/
|
|
2323
|
-
action_attempt_id: string
|
|
2324
|
-
|
|
2325
|
-
/**
|
|
2326
|
-
* Action attempt to track the status of setting the volume on a speaker.
|
|
2327
|
-
*/
|
|
2328
|
-
action_type: 'SET_SPEAKER_VOLUME'
|
|
2329
|
-
|
|
2330
|
-
/**
|
|
2331
|
-
* Error associated with the action.
|
|
2332
|
-
*/
|
|
2333
|
-
error: {
|
|
2334
|
-
/**
|
|
2335
|
-
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
2336
|
-
*/
|
|
2337
|
-
message: string
|
|
2338
|
-
|
|
2339
|
-
/**
|
|
2340
|
-
* Type of the error.
|
|
2341
|
-
*/
|
|
2342
|
-
type: string
|
|
2343
|
-
}
|
|
2344
|
-
|
|
2345
|
-
/**
|
|
2346
|
-
* Result of the action.
|
|
2347
|
-
*/
|
|
2348
|
-
result: null
|
|
2349
|
-
|
|
2350
|
-
status: 'error'
|
|
2351
|
-
}
|
|
2352
|
-
| {
|
|
2353
|
-
/**
|
|
2354
|
-
* ID of the action attempt.
|
|
2355
|
-
*/
|
|
2356
|
-
action_attempt_id: string
|
|
2357
|
-
|
|
2358
|
-
/**
|
|
2359
|
-
* Action attempt to track the status of muting or unmuting a speaker.
|
|
2360
|
-
*/
|
|
2361
|
-
action_type: 'SET_SPEAKER_MUTE'
|
|
2362
|
-
|
|
2363
|
-
/**
|
|
2364
|
-
* Error associated with the action.
|
|
2365
|
-
*/
|
|
2366
|
-
error: null
|
|
2367
|
-
/**
|
|
2368
|
-
* Result of the action.
|
|
2369
|
-
*/
|
|
2370
|
-
result: {}
|
|
2371
|
-
|
|
2372
|
-
status: 'success'
|
|
2373
|
-
}
|
|
2374
|
-
| {
|
|
2375
|
-
/**
|
|
2376
|
-
* ID of the action attempt.
|
|
2377
|
-
*/
|
|
2378
|
-
action_attempt_id: string
|
|
2379
|
-
|
|
2380
|
-
/**
|
|
2381
|
-
* Action attempt to track the status of muting or unmuting a speaker.
|
|
2382
|
-
*/
|
|
2383
|
-
action_type: 'SET_SPEAKER_MUTE'
|
|
2384
|
-
|
|
2385
|
-
/**
|
|
2386
|
-
* Error associated with the action.
|
|
2387
|
-
*/
|
|
2388
|
-
error: null
|
|
2389
|
-
/**
|
|
2390
|
-
* Result of the action.
|
|
2391
|
-
*/
|
|
2392
|
-
result: null
|
|
2393
|
-
|
|
2394
|
-
status: 'pending'
|
|
2395
|
-
}
|
|
2396
|
-
| {
|
|
2397
|
-
/**
|
|
2398
|
-
* ID of the action attempt.
|
|
2399
|
-
*/
|
|
2400
|
-
action_attempt_id: string
|
|
2401
|
-
|
|
2402
|
-
/**
|
|
2403
|
-
* Action attempt to track the status of muting or unmuting a speaker.
|
|
2404
|
-
*/
|
|
2405
|
-
action_type: 'SET_SPEAKER_MUTE'
|
|
2406
|
-
|
|
2407
|
-
/**
|
|
2408
|
-
* Error associated with the action.
|
|
2409
|
-
*/
|
|
2410
|
-
error: {
|
|
2411
|
-
/**
|
|
2412
|
-
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
2413
|
-
*/
|
|
2414
|
-
message: string
|
|
2415
|
-
|
|
2416
|
-
/**
|
|
2417
|
-
* Type of the error.
|
|
2418
|
-
*/
|
|
2419
|
-
type: string
|
|
2420
|
-
}
|
|
2421
|
-
|
|
2422
|
-
/**
|
|
2423
|
-
* Result of the action.
|
|
2424
|
-
*/
|
|
2425
|
-
result: null
|
|
2426
|
-
|
|
2427
|
-
status: 'error'
|
|
2428
|
-
}
|
|
2429
|
-
| {
|
|
2430
|
-
/**
|
|
2431
|
-
* ID of the action attempt.
|
|
2432
|
-
*/
|
|
2433
|
-
action_attempt_id: string
|
|
2434
|
-
|
|
2435
|
-
/**
|
|
2436
|
-
* Action attempt to track the status of pausing playback on a speaker.
|
|
2437
|
-
*/
|
|
2438
|
-
action_type: 'PAUSE_SPEAKER_PLAYBACK'
|
|
2439
|
-
|
|
2440
|
-
/**
|
|
2441
|
-
* Error associated with the action.
|
|
2442
|
-
*/
|
|
2443
|
-
error: null
|
|
2444
|
-
/**
|
|
2445
|
-
* Result of the action.
|
|
2446
|
-
*/
|
|
2447
|
-
result: {
|
|
2448
|
-
/**
|
|
2449
|
-
* IDs of the speakers whose playback was paused, including speakers grouped with the requested speaker.
|
|
2450
|
-
*/
|
|
2451
|
-
affected_device_ids: Array<string>
|
|
2452
|
-
}
|
|
2453
|
-
|
|
2454
|
-
status: 'success'
|
|
2455
|
-
}
|
|
2456
|
-
| {
|
|
2457
|
-
/**
|
|
2458
|
-
* ID of the action attempt.
|
|
2459
|
-
*/
|
|
2460
|
-
action_attempt_id: string
|
|
2461
|
-
|
|
2462
|
-
/**
|
|
2463
|
-
* Action attempt to track the status of pausing playback on a speaker.
|
|
2464
|
-
*/
|
|
2465
|
-
action_type: 'PAUSE_SPEAKER_PLAYBACK'
|
|
2466
|
-
|
|
2467
|
-
/**
|
|
2468
|
-
* Error associated with the action.
|
|
2469
|
-
*/
|
|
2470
|
-
error: null
|
|
2471
|
-
/**
|
|
2472
|
-
* Result of the action.
|
|
2473
|
-
*/
|
|
2474
|
-
result: null
|
|
2475
|
-
|
|
2476
|
-
status: 'pending'
|
|
2477
|
-
}
|
|
2478
|
-
| {
|
|
2479
|
-
/**
|
|
2480
|
-
* ID of the action attempt.
|
|
2481
|
-
*/
|
|
2482
|
-
action_attempt_id: string
|
|
2483
|
-
|
|
2484
|
-
/**
|
|
2485
|
-
* Action attempt to track the status of pausing playback on a speaker.
|
|
2486
|
-
*/
|
|
2487
|
-
action_type: 'PAUSE_SPEAKER_PLAYBACK'
|
|
2488
|
-
|
|
2489
|
-
/**
|
|
2490
|
-
* Error associated with the action.
|
|
2491
|
-
*/
|
|
2492
|
-
error: {
|
|
2493
|
-
/**
|
|
2494
|
-
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
2495
|
-
*/
|
|
2496
|
-
message: string
|
|
2497
|
-
|
|
2498
|
-
/**
|
|
2499
|
-
* Type of the error.
|
|
2500
|
-
*/
|
|
2501
|
-
type: string
|
|
2502
|
-
}
|
|
2503
|
-
|
|
2504
|
-
/**
|
|
2505
|
-
* Result of the action.
|
|
2506
|
-
*/
|
|
2507
|
-
result: null
|
|
2508
|
-
|
|
2509
|
-
status: 'error'
|
|
2510
|
-
}
|
|
2511
|
-
| {
|
|
2512
|
-
/**
|
|
2513
|
-
* ID of the action attempt.
|
|
2514
|
-
*/
|
|
2515
|
-
action_attempt_id: string
|
|
2516
|
-
|
|
2517
|
-
/**
|
|
2518
|
-
* Action attempt to track the status of resuming playback on a speaker.
|
|
2519
|
-
*/
|
|
2520
|
-
action_type: 'RESUME_SPEAKER_PLAYBACK'
|
|
2521
|
-
|
|
2522
|
-
/**
|
|
2523
|
-
* Error associated with the action.
|
|
2524
|
-
*/
|
|
2525
|
-
error: null
|
|
2526
|
-
/**
|
|
2527
|
-
* Result of the action.
|
|
2528
|
-
*/
|
|
2529
|
-
result: {
|
|
2530
|
-
/**
|
|
2531
|
-
* IDs of the speakers whose playback was resumed, including speakers grouped with the requested speaker.
|
|
2532
|
-
*/
|
|
2533
|
-
affected_device_ids: Array<string>
|
|
2534
|
-
}
|
|
2535
|
-
|
|
2536
|
-
status: 'success'
|
|
2537
|
-
}
|
|
2538
|
-
| {
|
|
2539
|
-
/**
|
|
2540
|
-
* ID of the action attempt.
|
|
2541
|
-
*/
|
|
2542
|
-
action_attempt_id: string
|
|
2543
|
-
|
|
2544
|
-
/**
|
|
2545
|
-
* Action attempt to track the status of resuming playback on a speaker.
|
|
2546
|
-
*/
|
|
2547
|
-
action_type: 'RESUME_SPEAKER_PLAYBACK'
|
|
2548
|
-
|
|
2549
|
-
/**
|
|
2550
|
-
* Error associated with the action.
|
|
2551
|
-
*/
|
|
2552
|
-
error: null
|
|
2553
|
-
/**
|
|
2554
|
-
* Result of the action.
|
|
2555
|
-
*/
|
|
2556
|
-
result: null
|
|
2557
|
-
|
|
2558
|
-
status: 'pending'
|
|
2559
|
-
}
|
|
2560
|
-
| {
|
|
2561
|
-
/**
|
|
2562
|
-
* ID of the action attempt.
|
|
2563
|
-
*/
|
|
2564
|
-
action_attempt_id: string
|
|
2565
|
-
|
|
2566
|
-
/**
|
|
2567
|
-
* Action attempt to track the status of resuming playback on a speaker.
|
|
2568
|
-
*/
|
|
2569
|
-
action_type: 'RESUME_SPEAKER_PLAYBACK'
|
|
2570
|
-
|
|
2571
|
-
/**
|
|
2572
|
-
* Error associated with the action.
|
|
2573
|
-
*/
|
|
2574
|
-
error: {
|
|
2575
|
-
/**
|
|
2576
|
-
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
2577
|
-
*/
|
|
2578
|
-
message: string
|
|
2579
|
-
|
|
2580
|
-
/**
|
|
2581
|
-
* Type of the error.
|
|
2582
|
-
*/
|
|
2583
|
-
type: string
|
|
2584
|
-
}
|
|
2585
|
-
|
|
2586
|
-
/**
|
|
2587
|
-
* Result of the action.
|
|
2588
|
-
*/
|
|
2589
|
-
result: null
|
|
2590
|
-
|
|
2591
|
-
status: 'error'
|
|
2592
|
-
}
|
|
2593
|
-
| {
|
|
2594
|
-
/**
|
|
2595
|
-
* ID of the action attempt.
|
|
2596
|
-
*/
|
|
2597
|
-
action_attempt_id: string
|
|
2598
|
-
|
|
2599
|
-
/**
|
|
2600
|
-
* Action attempt to track the status of playing a chime on a speaker.
|
|
2601
|
-
*/
|
|
2602
|
-
action_type: 'PLAY_SPEAKER_CHIME'
|
|
2603
|
-
|
|
2604
|
-
/**
|
|
2605
|
-
* Error associated with the action.
|
|
2606
|
-
*/
|
|
2607
|
-
error: null
|
|
2608
|
-
/**
|
|
2609
|
-
* Result of the action.
|
|
2610
|
-
*/
|
|
2611
|
-
result: {}
|
|
2612
|
-
|
|
2613
|
-
status: 'success'
|
|
2614
|
-
}
|
|
2615
|
-
| {
|
|
2616
|
-
/**
|
|
2617
|
-
* ID of the action attempt.
|
|
2618
|
-
*/
|
|
2619
|
-
action_attempt_id: string
|
|
2620
|
-
|
|
2621
|
-
/**
|
|
2622
|
-
* Action attempt to track the status of playing a chime on a speaker.
|
|
2623
|
-
*/
|
|
2624
|
-
action_type: 'PLAY_SPEAKER_CHIME'
|
|
2625
|
-
|
|
2626
|
-
/**
|
|
2627
|
-
* Error associated with the action.
|
|
2628
|
-
*/
|
|
2629
|
-
error: null
|
|
2630
|
-
/**
|
|
2631
|
-
* Result of the action.
|
|
2632
|
-
*/
|
|
2633
|
-
result: null
|
|
2634
|
-
|
|
2635
|
-
status: 'pending'
|
|
2636
|
-
}
|
|
2637
|
-
| {
|
|
2638
|
-
/**
|
|
2639
|
-
* ID of the action attempt.
|
|
2640
|
-
*/
|
|
2641
|
-
action_attempt_id: string
|
|
2642
|
-
|
|
2643
|
-
/**
|
|
2644
|
-
* Action attempt to track the status of playing a chime on a speaker.
|
|
2645
|
-
*/
|
|
2646
|
-
action_type: 'PLAY_SPEAKER_CHIME'
|
|
2647
|
-
|
|
2648
|
-
/**
|
|
2649
|
-
* Error associated with the action.
|
|
2650
|
-
*/
|
|
2651
|
-
error: {
|
|
2652
|
-
/**
|
|
2653
|
-
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
2654
|
-
*/
|
|
2655
|
-
message: string
|
|
2656
|
-
|
|
2657
|
-
/**
|
|
2658
|
-
* Type of the error.
|
|
2659
|
-
*/
|
|
2660
|
-
type: string
|
|
2661
|
-
}
|
|
2662
|
-
|
|
2663
|
-
/**
|
|
2664
|
-
* Result of the action.
|
|
2665
|
-
*/
|
|
2666
|
-
result: null
|
|
2667
|
-
|
|
2668
|
-
status: 'error'
|
|
2669
|
-
}
|
|
2670
|
-
| {
|
|
2671
|
-
/**
|
|
2672
|
-
* ID of the action attempt.
|
|
2673
|
-
*/
|
|
2674
|
-
action_attempt_id: string
|
|
2675
|
-
|
|
2676
2281
|
/**
|
|
2677
2282
|
* Syncing access codes is pending.
|
|
2678
2283
|
*/
|
|
@@ -24,18 +24,6 @@ export type DeviceProvider = {
|
|
|
24
24
|
* Indicates whether the thermostat supports simultaneous heating and cooling.
|
|
25
25
|
*/
|
|
26
26
|
can_hvac_heat_cool?: boolean | undefined
|
|
27
|
-
/**
|
|
28
|
-
* Indicates whether the speaker supports muting.
|
|
29
|
-
*/
|
|
30
|
-
can_mute_speaker?: boolean | undefined
|
|
31
|
-
/**
|
|
32
|
-
* Indicates whether the speaker supports pausing playback.
|
|
33
|
-
*/
|
|
34
|
-
can_pause_speaker_playback?: boolean | undefined
|
|
35
|
-
/**
|
|
36
|
-
* Indicates whether the speaker supports playing a chime.
|
|
37
|
-
*/
|
|
38
|
-
can_play_speaker_chime?: boolean | undefined
|
|
39
27
|
/**
|
|
40
28
|
* Indicates whether the device supports programming offline access codes.
|
|
41
29
|
*/
|
|
@@ -64,18 +52,10 @@ export type DeviceProvider = {
|
|
|
64
52
|
* Indicates whether the device supports remote unlocking.
|
|
65
53
|
*/
|
|
66
54
|
can_remotely_unlock?: boolean | undefined
|
|
67
|
-
/**
|
|
68
|
-
* Indicates whether the speaker supports resuming playback.
|
|
69
|
-
*/
|
|
70
|
-
can_resume_speaker_playback?: boolean | undefined
|
|
71
55
|
/**
|
|
72
56
|
* Indicates whether the thermostat supports running climate programs.
|
|
73
57
|
*/
|
|
74
58
|
can_run_thermostat_programs?: boolean | undefined
|
|
75
|
-
/**
|
|
76
|
-
* Indicates whether the speaker supports setting its volume.
|
|
77
|
-
*/
|
|
78
|
-
can_set_speaker_volume?: boolean | undefined
|
|
79
59
|
/**
|
|
80
60
|
* Indicates whether the device supports simulating connection in a sandbox.
|
|
81
61
|
*/
|
|
@@ -112,10 +92,6 @@ export type DeviceProvider = {
|
|
|
112
92
|
* Indicates whether the lock supports unlocking with an access code.
|
|
113
93
|
*/
|
|
114
94
|
can_unlock_with_code?: boolean | undefined
|
|
115
|
-
/**
|
|
116
|
-
* Indicates whether the speaker supports unmuting.
|
|
117
|
-
*/
|
|
118
|
-
can_unmute_speaker?: boolean | undefined
|
|
119
95
|
/**
|
|
120
96
|
* Name of the device provider.
|
|
121
97
|
*/
|
|
@@ -27,18 +27,6 @@ export type Device = {
|
|
|
27
27
|
* Indicates whether the thermostat supports simultaneous heating and cooling.
|
|
28
28
|
*/
|
|
29
29
|
can_hvac_heat_cool?: boolean | undefined
|
|
30
|
-
/**
|
|
31
|
-
* Indicates whether the speaker supports muting.
|
|
32
|
-
*/
|
|
33
|
-
can_mute_speaker?: boolean | undefined
|
|
34
|
-
/**
|
|
35
|
-
* Indicates whether the speaker supports pausing playback.
|
|
36
|
-
*/
|
|
37
|
-
can_pause_speaker_playback?: boolean | undefined
|
|
38
|
-
/**
|
|
39
|
-
* Indicates whether the speaker supports playing a chime.
|
|
40
|
-
*/
|
|
41
|
-
can_play_speaker_chime?: boolean | undefined
|
|
42
30
|
/**
|
|
43
31
|
* Indicates whether the device supports programming offline access codes.
|
|
44
32
|
*/
|
|
@@ -67,18 +55,10 @@ export type Device = {
|
|
|
67
55
|
* Indicates whether the device supports remote unlocking.
|
|
68
56
|
*/
|
|
69
57
|
can_remotely_unlock?: boolean | undefined
|
|
70
|
-
/**
|
|
71
|
-
* Indicates whether the speaker supports resuming playback.
|
|
72
|
-
*/
|
|
73
|
-
can_resume_speaker_playback?: boolean | undefined
|
|
74
58
|
/**
|
|
75
59
|
* Indicates whether the thermostat supports running climate programs.
|
|
76
60
|
*/
|
|
77
61
|
can_run_thermostat_programs?: boolean | undefined
|
|
78
|
-
/**
|
|
79
|
-
* Indicates whether the speaker supports setting its volume.
|
|
80
|
-
*/
|
|
81
|
-
can_set_speaker_volume?: boolean | undefined
|
|
82
62
|
/**
|
|
83
63
|
* Indicates whether the device supports simulating connection in a sandbox.
|
|
84
64
|
*/
|
|
@@ -115,10 +95,6 @@ export type Device = {
|
|
|
115
95
|
* Indicates whether the lock supports unlocking with an access code.
|
|
116
96
|
*/
|
|
117
97
|
can_unlock_with_code?: boolean | undefined
|
|
118
|
-
/**
|
|
119
|
-
* Indicates whether the speaker supports unmuting.
|
|
120
|
-
*/
|
|
121
|
-
can_unmute_speaker?: boolean | undefined
|
|
122
98
|
/**
|
|
123
99
|
* 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).
|
|
124
100
|
*/
|
|
@@ -1858,41 +1834,6 @@ export type Device = {
|
|
|
1858
1834
|
model?: string | undefined
|
|
1859
1835
|
}
|
|
1860
1836
|
| undefined
|
|
1861
|
-
/**
|
|
1862
|
-
* Metadata for a Sonos speaker.
|
|
1863
|
-
*/
|
|
1864
|
-
sonos_metadata?:
|
|
1865
|
-
| {
|
|
1866
|
-
/**
|
|
1867
|
-
* Models of the speakers bonded to this speaker, such as surrounds or a subwoofer.
|
|
1868
|
-
*/
|
|
1869
|
-
bonded_member_models?: Array<string> | undefined
|
|
1870
|
-
/**
|
|
1871
|
-
* Color of the speaker, as reported by Sonos.
|
|
1872
|
-
*/
|
|
1873
|
-
color?: string | undefined
|
|
1874
|
-
/**
|
|
1875
|
-
* ID of the Sonos household that the speaker belongs to.
|
|
1876
|
-
*/
|
|
1877
|
-
household_id?: string | undefined
|
|
1878
|
-
/**
|
|
1879
|
-
* Model name of the speaker, as reported by Sonos.
|
|
1880
|
-
*/
|
|
1881
|
-
model_display_name?: string | undefined
|
|
1882
|
-
/**
|
|
1883
|
-
* ID of the Sonos player for the speaker.
|
|
1884
|
-
*/
|
|
1885
|
-
player_id?: string | undefined
|
|
1886
|
-
/**
|
|
1887
|
-
* Name of the speaker, as set in the Sonos app.
|
|
1888
|
-
*/
|
|
1889
|
-
player_name?: string | undefined
|
|
1890
|
-
/**
|
|
1891
|
-
* Software version running on the speaker.
|
|
1892
|
-
*/
|
|
1893
|
-
software_version?: string | undefined
|
|
1894
|
-
}
|
|
1895
|
-
| undefined
|
|
1896
1837
|
/**
|
|
1897
1838
|
* Metadata for a tado° device.
|
|
1898
1839
|
*/
|
|
@@ -2334,81 +2275,6 @@ export type Device = {
|
|
|
2334
2275
|
time_zone?: string | undefined
|
|
2335
2276
|
}>
|
|
2336
2277
|
| undefined
|
|
2337
|
-
/**
|
|
2338
|
-
* Audio state and capabilities of the speaker.
|
|
2339
|
-
*/
|
|
2340
|
-
speaker?:
|
|
2341
|
-
| {
|
|
2342
|
-
/**
|
|
2343
|
-
* IDs of the other speakers that are currently grouped with this speaker. Pausing or resuming playback on a speaker also affects the speakers in its group.
|
|
2344
|
-
*/
|
|
2345
|
-
grouped_with_device_ids: Array<string>
|
|
2346
|
-
|
|
2347
|
-
/**
|
|
2348
|
-
* Indicates whether the speaker's volume is fixed, for example, because the speaker's line-out level is controlled by an external amplifier. A speaker with a fixed volume cannot have its volume set through Seam.
|
|
2349
|
-
*/
|
|
2350
|
-
has_fixed_volume: boolean
|
|
2351
|
-
|
|
2352
|
-
/**
|
|
2353
|
-
* Indicates whether the speaker is muted.
|
|
2354
|
-
*/
|
|
2355
|
-
is_muted: boolean
|
|
2356
|
-
|
|
2357
|
-
/**
|
|
2358
|
-
* Maximum volume that you can set on the speaker. This is the ceiling of the speaker's native volume scale, not a limit configured for guests.
|
|
2359
|
-
*/
|
|
2360
|
-
max_volume: number
|
|
2361
|
-
|
|
2362
|
-
/**
|
|
2363
|
-
* Minimum volume that you can set on the speaker.
|
|
2364
|
-
*/
|
|
2365
|
-
min_volume: number
|
|
2366
|
-
|
|
2367
|
-
/**
|
|
2368
|
-
* Content that is currently playing on the speaker.
|
|
2369
|
-
*/
|
|
2370
|
-
now_playing?:
|
|
2371
|
-
| {
|
|
2372
|
-
/**
|
|
2373
|
-
* Album of the content that is currently playing.
|
|
2374
|
-
*/
|
|
2375
|
-
album?: string | undefined
|
|
2376
|
-
/**
|
|
2377
|
-
* Artist of the content that is currently playing.
|
|
2378
|
-
*/
|
|
2379
|
-
artist?: string | undefined
|
|
2380
|
-
/**
|
|
2381
|
-
* Title of the content that is currently playing.
|
|
2382
|
-
*/
|
|
2383
|
-
title?: string | undefined
|
|
2384
|
-
}
|
|
2385
|
-
| undefined
|
|
2386
|
-
/**
|
|
2387
|
-
* Playback state of the speaker.
|
|
2388
|
-
*/
|
|
2389
|
-
playback_state:
|
|
2390
|
-
'playing' | 'paused' | 'idle' | 'buffering' | 'unknown'
|
|
2391
|
-
|
|
2392
|
-
/**
|
|
2393
|
-
* Indicates whether the speaker can play a chime.
|
|
2394
|
-
*/
|
|
2395
|
-
supports_chime: boolean
|
|
2396
|
-
|
|
2397
|
-
/**
|
|
2398
|
-
* Current volume of the speaker, on the speaker's native volume scale from `min_volume` to `max_volume`. This is the native volume setting, not a decibel level.
|
|
2399
|
-
*/
|
|
2400
|
-
volume: number
|
|
2401
|
-
|
|
2402
|
-
/**
|
|
2403
|
-
* Date and time at which the speaker first reported its current volume.
|
|
2404
|
-
*/
|
|
2405
|
-
volume_reported_at?: string | undefined
|
|
2406
|
-
/**
|
|
2407
|
-
* Increment between the volume values that you can set on the speaker.
|
|
2408
|
-
*/
|
|
2409
|
-
volume_step: number
|
|
2410
|
-
}
|
|
2411
|
-
| undefined
|
|
2412
2278
|
/**
|
|
2413
2279
|
* Supported code lengths for access codes.
|
|
2414
2280
|
*/
|
|
@@ -308,7 +308,7 @@ export type UnmanagedAccessCode = {
|
|
|
308
308
|
*/
|
|
309
309
|
message: string
|
|
310
310
|
} /**
|
|
311
|
-
* Seam was unable to issue this access code before its start time, so the recipient may be unable to unlock the device. This usually points to a problem that needs attention, such as an offline or disconnected device.
|
|
311
|
+
* Seam was unable to issue this access code before its start time, so the recipient may be unable to unlock the device. This usually points to a problem that needs attention, such as an offline or disconnected device. This error clears automatically if the access code is eventually issued.
|
|
312
312
|
*/
|
|
313
313
|
| {
|
|
314
314
|
/**
|