@seamapi/http 2.39.0 → 2.41.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.
@@ -667,6 +667,9 @@ export type CustomersCreatePortalParameters = {
667
667
  * Whether to exclude the option to select a locale within the portal UI.
668
668
  */
669
669
  exclude_locale_picker?: boolean | undefined;
670
+ /**
671
+ * Features to include in the portal. Settings you omit use the portal's customization profile, then the Seam default. Settings you pass take precedence over the customization profile's, so changing the profile doesn't change them.
672
+ */
670
673
  features?: {
671
674
  /**
672
675
  * Configuration for the configure feature.
@@ -688,6 +691,10 @@ export type CustomersCreatePortalParameters = {
688
691
  * Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.
689
692
  */
690
693
  allow_notification_customization?: boolean | undefined;
694
+ /**
695
+ * Indicates whether the customer can customize the sound automation rules for their properties.
696
+ */
697
+ allow_sound_automation_rule_customization?: boolean | undefined;
691
698
  /**
692
699
  * Whether to exclude this feature from the portal.
693
700
  */
@@ -752,6 +759,10 @@ export type CustomersCreatePortalParameters = {
752
759
  * Whether to exclude this feature from the portal.
753
760
  */
754
761
  exclude?: boolean | undefined;
762
+ /**
763
+ * Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed.
764
+ */
765
+ exclude_device_management?: boolean | undefined;
755
766
  /**
756
767
  * Indicates whether the customer can manage reservations for their properties.
757
768
  */
@@ -120,6 +120,10 @@ export type UserIdentitiesCreateParameters = {
120
120
  * List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity.
121
121
  */
122
122
  acs_system_ids?: Array<string> | undefined;
123
+ /**
124
+ * Customer key of the customer that owns the new user identity. Set it when the user identity will be used in access grants created through that customer's client session or Customer Portal.
125
+ */
126
+ customer_key?: string | undefined;
123
127
  /**
124
128
  * Unique email address for the new user identity.
125
129
  */
package/lib/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- declare const seamapiJavascriptHttpVersion = "2.39.0";
1
+ declare const seamapiJavascriptHttpVersion = "2.41.0";
2
2
  export default seamapiJavascriptHttpVersion;
package/lib/version.js CHANGED
@@ -1,3 +1,3 @@
1
- const seamapiJavascriptHttpVersion = '2.39.0';
1
+ const seamapiJavascriptHttpVersion = '2.41.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.39.0",
3
+ "version": "2.41.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.1112.0",
91
+ "@seamapi/types": "1.1129.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, so a different code was assigned.
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: string
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
  /**
@@ -2269,401 +2278,6 @@ export type ActionAttempt =
2269
2278
  */
2270
2279
  action_attempt_id: string
2271
2280
 
2272
- /**
2273
- * Action attempt to track the status of setting the volume on a speaker.
2274
- */
2275
- action_type: 'SET_SPEAKER_VOLUME'
2276
-
2277
- /**
2278
- * Error associated with the action.
2279
- */
2280
- error: null
2281
- /**
2282
- * Result of the action.
2283
- */
2284
- result: {}
2285
-
2286
- status: 'success'
2287
- }
2288
- | {
2289
- /**
2290
- * ID of the action attempt.
2291
- */
2292
- action_attempt_id: string
2293
-
2294
- /**
2295
- * Action attempt to track the status of setting the volume on a speaker.
2296
- */
2297
- action_type: 'SET_SPEAKER_VOLUME'
2298
-
2299
- /**
2300
- * Error associated with the action.
2301
- */
2302
- error: null
2303
- /**
2304
- * Result of the action.
2305
- */
2306
- result: null
2307
-
2308
- status: 'pending'
2309
- }
2310
- | {
2311
- /**
2312
- * ID of the action attempt.
2313
- */
2314
- action_attempt_id: string
2315
-
2316
- /**
2317
- * Action attempt to track the status of setting the volume on a speaker.
2318
- */
2319
- action_type: 'SET_SPEAKER_VOLUME'
2320
-
2321
- /**
2322
- * Error associated with the action.
2323
- */
2324
- error: {
2325
- /**
2326
- * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
2327
- */
2328
- message: string
2329
-
2330
- /**
2331
- * Type of the error.
2332
- */
2333
- type: string
2334
- }
2335
-
2336
- /**
2337
- * Result of the action.
2338
- */
2339
- result: null
2340
-
2341
- status: 'error'
2342
- }
2343
- | {
2344
- /**
2345
- * ID of the action attempt.
2346
- */
2347
- action_attempt_id: string
2348
-
2349
- /**
2350
- * Action attempt to track the status of muting or unmuting a speaker.
2351
- */
2352
- action_type: 'SET_SPEAKER_MUTE'
2353
-
2354
- /**
2355
- * Error associated with the action.
2356
- */
2357
- error: null
2358
- /**
2359
- * Result of the action.
2360
- */
2361
- result: {}
2362
-
2363
- status: 'success'
2364
- }
2365
- | {
2366
- /**
2367
- * ID of the action attempt.
2368
- */
2369
- action_attempt_id: string
2370
-
2371
- /**
2372
- * Action attempt to track the status of muting or unmuting a speaker.
2373
- */
2374
- action_type: 'SET_SPEAKER_MUTE'
2375
-
2376
- /**
2377
- * Error associated with the action.
2378
- */
2379
- error: null
2380
- /**
2381
- * Result of the action.
2382
- */
2383
- result: null
2384
-
2385
- status: 'pending'
2386
- }
2387
- | {
2388
- /**
2389
- * ID of the action attempt.
2390
- */
2391
- action_attempt_id: string
2392
-
2393
- /**
2394
- * Action attempt to track the status of muting or unmuting a speaker.
2395
- */
2396
- action_type: 'SET_SPEAKER_MUTE'
2397
-
2398
- /**
2399
- * Error associated with the action.
2400
- */
2401
- error: {
2402
- /**
2403
- * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
2404
- */
2405
- message: string
2406
-
2407
- /**
2408
- * Type of the error.
2409
- */
2410
- type: string
2411
- }
2412
-
2413
- /**
2414
- * Result of the action.
2415
- */
2416
- result: null
2417
-
2418
- status: 'error'
2419
- }
2420
- | {
2421
- /**
2422
- * ID of the action attempt.
2423
- */
2424
- action_attempt_id: string
2425
-
2426
- /**
2427
- * Action attempt to track the status of pausing playback on a speaker.
2428
- */
2429
- action_type: 'PAUSE_SPEAKER_PLAYBACK'
2430
-
2431
- /**
2432
- * Error associated with the action.
2433
- */
2434
- error: null
2435
- /**
2436
- * Result of the action.
2437
- */
2438
- result: {
2439
- /**
2440
- * IDs of the speakers whose playback was paused, including speakers grouped with the requested speaker.
2441
- */
2442
- affected_device_ids: Array<string>
2443
- }
2444
-
2445
- status: 'success'
2446
- }
2447
- | {
2448
- /**
2449
- * ID of the action attempt.
2450
- */
2451
- action_attempt_id: string
2452
-
2453
- /**
2454
- * Action attempt to track the status of pausing playback on a speaker.
2455
- */
2456
- action_type: 'PAUSE_SPEAKER_PLAYBACK'
2457
-
2458
- /**
2459
- * Error associated with the action.
2460
- */
2461
- error: null
2462
- /**
2463
- * Result of the action.
2464
- */
2465
- result: null
2466
-
2467
- status: 'pending'
2468
- }
2469
- | {
2470
- /**
2471
- * ID of the action attempt.
2472
- */
2473
- action_attempt_id: string
2474
-
2475
- /**
2476
- * Action attempt to track the status of pausing playback on a speaker.
2477
- */
2478
- action_type: 'PAUSE_SPEAKER_PLAYBACK'
2479
-
2480
- /**
2481
- * Error associated with the action.
2482
- */
2483
- error: {
2484
- /**
2485
- * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
2486
- */
2487
- message: string
2488
-
2489
- /**
2490
- * Type of the error.
2491
- */
2492
- type: string
2493
- }
2494
-
2495
- /**
2496
- * Result of the action.
2497
- */
2498
- result: null
2499
-
2500
- status: 'error'
2501
- }
2502
- | {
2503
- /**
2504
- * ID of the action attempt.
2505
- */
2506
- action_attempt_id: string
2507
-
2508
- /**
2509
- * Action attempt to track the status of resuming playback on a speaker.
2510
- */
2511
- action_type: 'RESUME_SPEAKER_PLAYBACK'
2512
-
2513
- /**
2514
- * Error associated with the action.
2515
- */
2516
- error: null
2517
- /**
2518
- * Result of the action.
2519
- */
2520
- result: {
2521
- /**
2522
- * IDs of the speakers whose playback was resumed, including speakers grouped with the requested speaker.
2523
- */
2524
- affected_device_ids: Array<string>
2525
- }
2526
-
2527
- status: 'success'
2528
- }
2529
- | {
2530
- /**
2531
- * ID of the action attempt.
2532
- */
2533
- action_attempt_id: string
2534
-
2535
- /**
2536
- * Action attempt to track the status of resuming playback on a speaker.
2537
- */
2538
- action_type: 'RESUME_SPEAKER_PLAYBACK'
2539
-
2540
- /**
2541
- * Error associated with the action.
2542
- */
2543
- error: null
2544
- /**
2545
- * Result of the action.
2546
- */
2547
- result: null
2548
-
2549
- status: 'pending'
2550
- }
2551
- | {
2552
- /**
2553
- * ID of the action attempt.
2554
- */
2555
- action_attempt_id: string
2556
-
2557
- /**
2558
- * Action attempt to track the status of resuming playback on a speaker.
2559
- */
2560
- action_type: 'RESUME_SPEAKER_PLAYBACK'
2561
-
2562
- /**
2563
- * Error associated with the action.
2564
- */
2565
- error: {
2566
- /**
2567
- * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
2568
- */
2569
- message: string
2570
-
2571
- /**
2572
- * Type of the error.
2573
- */
2574
- type: string
2575
- }
2576
-
2577
- /**
2578
- * Result of the action.
2579
- */
2580
- result: null
2581
-
2582
- status: 'error'
2583
- }
2584
- | {
2585
- /**
2586
- * ID of the action attempt.
2587
- */
2588
- action_attempt_id: string
2589
-
2590
- /**
2591
- * Action attempt to track the status of playing a chime on a speaker.
2592
- */
2593
- action_type: 'PLAY_SPEAKER_CHIME'
2594
-
2595
- /**
2596
- * Error associated with the action.
2597
- */
2598
- error: null
2599
- /**
2600
- * Result of the action.
2601
- */
2602
- result: {}
2603
-
2604
- status: 'success'
2605
- }
2606
- | {
2607
- /**
2608
- * ID of the action attempt.
2609
- */
2610
- action_attempt_id: string
2611
-
2612
- /**
2613
- * Action attempt to track the status of playing a chime on a speaker.
2614
- */
2615
- action_type: 'PLAY_SPEAKER_CHIME'
2616
-
2617
- /**
2618
- * Error associated with the action.
2619
- */
2620
- error: null
2621
- /**
2622
- * Result of the action.
2623
- */
2624
- result: null
2625
-
2626
- status: 'pending'
2627
- }
2628
- | {
2629
- /**
2630
- * ID of the action attempt.
2631
- */
2632
- action_attempt_id: string
2633
-
2634
- /**
2635
- * Action attempt to track the status of playing a chime on a speaker.
2636
- */
2637
- action_type: 'PLAY_SPEAKER_CHIME'
2638
-
2639
- /**
2640
- * Error associated with the action.
2641
- */
2642
- error: {
2643
- /**
2644
- * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
2645
- */
2646
- message: string
2647
-
2648
- /**
2649
- * Type of the error.
2650
- */
2651
- type: string
2652
- }
2653
-
2654
- /**
2655
- * Result of the action.
2656
- */
2657
- result: null
2658
-
2659
- status: 'error'
2660
- }
2661
- | {
2662
- /**
2663
- * ID of the action attempt.
2664
- */
2665
- action_attempt_id: string
2666
-
2667
2281
  /**
2668
2282
  * Syncing access codes is pending.
2669
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 and unmuting.
29
- */
30
- can_mute_speaker?: boolean | undefined
31
- /**
32
- * Indicates whether the speaker supports pausing and resuming 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
  */
@@ -68,10 +56,6 @@ export type DeviceProvider = {
68
56
  * Indicates whether the thermostat supports running climate programs.
69
57
  */
70
58
  can_run_thermostat_programs?: boolean | undefined
71
- /**
72
- * Indicates whether the speaker supports setting its volume.
73
- */
74
- can_set_speaker_volume?: boolean | undefined
75
59
  /**
76
60
  * Indicates whether the device supports simulating connection in a sandbox.
77
61
  */