@seamapi/types 1.241.0 → 1.242.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. package/dist/connect.cjs +281 -137
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +370 -182
  4. package/dist/devicedb.cjs +9 -6
  5. package/dist/devicedb.cjs.map +1 -1
  6. package/dist/devicedb.d.cts +123 -70
  7. package/lib/seam/connect/models/acs/acs-system.d.ts +86 -42
  8. package/lib/seam/connect/models/acs/acs-system.js +23 -20
  9. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-user.d.ts +169 -140
  11. package/lib/seam/connect/models/acs/acs-user.js +32 -30
  12. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  13. package/lib/seam/connect/models/devices/capability-properties/index.d.ts +5 -5
  14. package/lib/seam/connect/models/devices/capability-properties/thermostat.d.ts +5 -5
  15. package/lib/seam/connect/models/devices/device.d.ts +6 -6
  16. package/lib/seam/connect/models/devices/phone.d.ts +5 -5
  17. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +5 -5
  18. package/lib/seam/connect/models/thermostats/climate-preset.d.ts +3 -3
  19. package/lib/seam/connect/models/thermostats/climate-preset.js +1 -1
  20. package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
  21. package/lib/seam/connect/models/thermostats/index.d.ts +1 -1
  22. package/lib/seam/connect/models/thermostats/index.js +1 -1
  23. package/lib/seam/connect/models/thermostats/index.js.map +1 -1
  24. package/lib/seam/connect/models/thermostats/{climate-setting-schedule.js → thermostat-schedule.js} +1 -1
  25. package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -0
  26. package/lib/seam/connect/openapi.d.ts +45 -18
  27. package/lib/seam/connect/openapi.js +219 -90
  28. package/lib/seam/connect/openapi.js.map +1 -1
  29. package/lib/seam/connect/route-types.d.ts +176 -78
  30. package/lib/seam/devicedb/models/device-model.d.ts +59 -24
  31. package/lib/seam/devicedb/models/device-model.js +9 -6
  32. package/lib/seam/devicedb/models/device-model.js.map +1 -1
  33. package/lib/seam/devicedb/route-specs.d.ts +56 -38
  34. package/lib/seam/devicedb/route-types.d.ts +8 -8
  35. package/package.json +1 -1
  36. package/src/lib/seam/connect/models/acs/acs-system.ts +32 -24
  37. package/src/lib/seam/connect/models/acs/acs-user.ts +41 -35
  38. package/src/lib/seam/connect/models/thermostats/climate-preset.ts +1 -1
  39. package/src/lib/seam/connect/models/thermostats/index.ts +1 -1
  40. package/src/lib/seam/connect/openapi.ts +249 -90
  41. package/src/lib/seam/connect/route-types.ts +187 -78
  42. package/src/lib/seam/devicedb/models/device-model.ts +24 -19
  43. package/src/lib/seam/devicedb/route-types.ts +8 -8
  44. package/lib/seam/connect/models/thermostats/climate-setting-schedule.js.map +0 -1
  45. /package/lib/seam/connect/models/thermostats/{climate-setting-schedule.d.ts → thermostat-schedule.d.ts} +0 -0
  46. /package/src/lib/seam/connect/models/thermostats/{climate-setting-schedule.ts → thermostat-schedule.ts} +0 -0
@@ -2342,24 +2342,22 @@ export interface Routes {
2342
2342
  message: string;
2343
2343
  warning_code: 'being_deleted';
2344
2344
  } | {
2345
+ /** Date and time at which Seam created the error. */
2345
2346
  created_at: string;
2347
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2346
2348
  message: string;
2347
2349
  warning_code: 'failed_to_update_on_acs_system';
2348
2350
  } | {
2349
2351
  created_at: string;
2350
2352
  message: string;
2351
2353
  warning_code: 'salto_ks_user_not_subscribed';
2352
- } | {
2353
- created_at: string;
2354
- message: string;
2355
- warning_code: 'salto_site_user_suspended';
2356
2354
  }>;
2357
2355
  errors: Array<{
2358
2356
  /** Date and time at which Seam created the error. */
2359
2357
  created_at: string;
2360
2358
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2361
2359
  message: string;
2362
- error_code: 'user_deleted_externally';
2360
+ error_code: 'deleted_externally';
2363
2361
  } | {
2364
2362
  /** Date and time at which Seam created the error. */
2365
2363
  created_at: string;
@@ -2371,7 +2369,19 @@ export interface Routes {
2371
2369
  created_at: string;
2372
2370
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2373
2371
  message: string;
2374
- error_code: 'salto_site_user_limit_reached';
2372
+ warning_code: 'failed_to_create_on_acs_system';
2373
+ } | {
2374
+ /** Date and time at which Seam created the error. */
2375
+ created_at: string;
2376
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2377
+ message: string;
2378
+ warning_code: 'failed_to_update_on_acs_system';
2379
+ } | {
2380
+ /** Date and time at which Seam created the error. */
2381
+ created_at: string;
2382
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2383
+ message: string;
2384
+ warning_code: 'failed_to_delete_on_acs_system';
2375
2385
  }>;
2376
2386
  full_name?: string | undefined;
2377
2387
  /**
@@ -3174,14 +3184,21 @@ export interface Routes {
3174
3184
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3175
3185
  message: string;
3176
3186
  /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
3177
- error_code: 'salto_site_user_limit_reached';
3187
+ error_code: 'salto_ks_subscription_limit_exceeded';
3178
3188
  } | {
3179
3189
  /** Date and time at which Seam created the error. */
3180
3190
  created_at: string;
3181
3191
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3182
3192
  message: string;
3183
- /** Indicates that the Seam Integration user site is blocked. This means that Seam does not have permission to access Salto resources. Go to Salto Dashboard to remove 'Seam Integration' block */
3184
- error_code: 'salto_seam_integration_blocked';
3193
+ /** Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue. */
3194
+ error_code: 'acs_system_disconnected';
3195
+ } | {
3196
+ /** Date and time at which Seam created the error. */
3197
+ created_at: string;
3198
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3199
+ message: string;
3200
+ /** Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access. */
3201
+ error_code: 'account_disconnected';
3185
3202
  }>;
3186
3203
  /** Warnings associated with the `acs_system`. */
3187
3204
  warnings: Array<{
@@ -3189,8 +3206,8 @@ export interface Routes {
3189
3206
  created_at: string;
3190
3207
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3191
3208
  message: string;
3192
- /** You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
3193
- warning_code: 'salto_site_user_limit_almost_reached';
3209
+ /** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. */
3210
+ warning_code: 'salto_ks_subscription_limit_almost_reached';
3194
3211
  }>;
3195
3212
  /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
3196
3213
  can_automate_enrollment?: boolean | undefined;
@@ -3265,14 +3282,21 @@ export interface Routes {
3265
3282
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3266
3283
  message: string;
3267
3284
  /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
3268
- error_code: 'salto_site_user_limit_reached';
3285
+ error_code: 'salto_ks_subscription_limit_exceeded';
3269
3286
  } | {
3270
3287
  /** Date and time at which Seam created the error. */
3271
3288
  created_at: string;
3272
3289
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3273
3290
  message: string;
3274
- /** Indicates that the Seam Integration user site is blocked. This means that Seam does not have permission to access Salto resources. Go to Salto Dashboard to remove 'Seam Integration' block */
3275
- error_code: 'salto_seam_integration_blocked';
3291
+ /** Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue. */
3292
+ error_code: 'acs_system_disconnected';
3293
+ } | {
3294
+ /** Date and time at which Seam created the error. */
3295
+ created_at: string;
3296
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3297
+ message: string;
3298
+ /** Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access. */
3299
+ error_code: 'account_disconnected';
3276
3300
  }>;
3277
3301
  /** Warnings associated with the `acs_system`. */
3278
3302
  warnings: Array<{
@@ -3280,8 +3304,8 @@ export interface Routes {
3280
3304
  created_at: string;
3281
3305
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3282
3306
  message: string;
3283
- /** You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
3284
- warning_code: 'salto_site_user_limit_almost_reached';
3307
+ /** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. */
3308
+ warning_code: 'salto_ks_subscription_limit_almost_reached';
3285
3309
  }>;
3286
3310
  /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
3287
3311
  can_automate_enrollment?: boolean | undefined;
@@ -3356,14 +3380,21 @@ export interface Routes {
3356
3380
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3357
3381
  message: string;
3358
3382
  /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
3359
- error_code: 'salto_site_user_limit_reached';
3383
+ error_code: 'salto_ks_subscription_limit_exceeded';
3384
+ } | {
3385
+ /** Date and time at which Seam created the error. */
3386
+ created_at: string;
3387
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3388
+ message: string;
3389
+ /** Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue. */
3390
+ error_code: 'acs_system_disconnected';
3360
3391
  } | {
3361
3392
  /** Date and time at which Seam created the error. */
3362
3393
  created_at: string;
3363
3394
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3364
3395
  message: string;
3365
- /** Indicates that the Seam Integration user site is blocked. This means that Seam does not have permission to access Salto resources. Go to Salto Dashboard to remove 'Seam Integration' block */
3366
- error_code: 'salto_seam_integration_blocked';
3396
+ /** Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access. */
3397
+ error_code: 'account_disconnected';
3367
3398
  }>;
3368
3399
  /** Warnings associated with the `acs_system`. */
3369
3400
  warnings: Array<{
@@ -3371,8 +3402,8 @@ export interface Routes {
3371
3402
  created_at: string;
3372
3403
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3373
3404
  message: string;
3374
- /** You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
3375
- warning_code: 'salto_site_user_limit_almost_reached';
3405
+ /** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. */
3406
+ warning_code: 'salto_ks_subscription_limit_almost_reached';
3376
3407
  }>;
3377
3408
  /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
3378
3409
  can_automate_enrollment?: boolean | undefined;
@@ -3444,24 +3475,22 @@ export interface Routes {
3444
3475
  message: string;
3445
3476
  warning_code: 'being_deleted';
3446
3477
  } | {
3478
+ /** Date and time at which Seam created the error. */
3447
3479
  created_at: string;
3480
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3448
3481
  message: string;
3449
3482
  warning_code: 'failed_to_update_on_acs_system';
3450
3483
  } | {
3451
3484
  created_at: string;
3452
3485
  message: string;
3453
3486
  warning_code: 'salto_ks_user_not_subscribed';
3454
- } | {
3455
- created_at: string;
3456
- message: string;
3457
- warning_code: 'salto_site_user_suspended';
3458
3487
  }>;
3459
3488
  errors: Array<{
3460
3489
  /** Date and time at which Seam created the error. */
3461
3490
  created_at: string;
3462
3491
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3463
3492
  message: string;
3464
- error_code: 'user_deleted_externally';
3493
+ error_code: 'deleted_externally';
3465
3494
  } | {
3466
3495
  /** Date and time at which Seam created the error. */
3467
3496
  created_at: string;
@@ -3473,7 +3502,19 @@ export interface Routes {
3473
3502
  created_at: string;
3474
3503
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3475
3504
  message: string;
3476
- error_code: 'salto_site_user_limit_reached';
3505
+ warning_code: 'failed_to_create_on_acs_system';
3506
+ } | {
3507
+ /** Date and time at which Seam created the error. */
3508
+ created_at: string;
3509
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3510
+ message: string;
3511
+ warning_code: 'failed_to_update_on_acs_system';
3512
+ } | {
3513
+ /** Date and time at which Seam created the error. */
3514
+ created_at: string;
3515
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3516
+ message: string;
3517
+ warning_code: 'failed_to_delete_on_acs_system';
3477
3518
  }>;
3478
3519
  full_name?: string | undefined;
3479
3520
  /**
@@ -3531,24 +3572,22 @@ export interface Routes {
3531
3572
  message: string;
3532
3573
  warning_code: 'being_deleted';
3533
3574
  } | {
3575
+ /** Date and time at which Seam created the error. */
3534
3576
  created_at: string;
3577
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3535
3578
  message: string;
3536
3579
  warning_code: 'failed_to_update_on_acs_system';
3537
3580
  } | {
3538
3581
  created_at: string;
3539
3582
  message: string;
3540
3583
  warning_code: 'salto_ks_user_not_subscribed';
3541
- } | {
3542
- created_at: string;
3543
- message: string;
3544
- warning_code: 'salto_site_user_suspended';
3545
3584
  }>;
3546
3585
  errors: Array<{
3547
3586
  /** Date and time at which Seam created the error. */
3548
3587
  created_at: string;
3549
3588
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3550
3589
  message: string;
3551
- error_code: 'user_deleted_externally';
3590
+ error_code: 'deleted_externally';
3552
3591
  } | {
3553
3592
  /** Date and time at which Seam created the error. */
3554
3593
  created_at: string;
@@ -3560,7 +3599,19 @@ export interface Routes {
3560
3599
  created_at: string;
3561
3600
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3562
3601
  message: string;
3563
- error_code: 'salto_site_user_limit_reached';
3602
+ warning_code: 'failed_to_create_on_acs_system';
3603
+ } | {
3604
+ /** Date and time at which Seam created the error. */
3605
+ created_at: string;
3606
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3607
+ message: string;
3608
+ warning_code: 'failed_to_update_on_acs_system';
3609
+ } | {
3610
+ /** Date and time at which Seam created the error. */
3611
+ created_at: string;
3612
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3613
+ message: string;
3614
+ warning_code: 'failed_to_delete_on_acs_system';
3564
3615
  }>;
3565
3616
  full_name?: string | undefined;
3566
3617
  /**
@@ -3612,24 +3663,22 @@ export interface Routes {
3612
3663
  message: string;
3613
3664
  warning_code: 'being_deleted';
3614
3665
  } | {
3666
+ /** Date and time at which Seam created the error. */
3615
3667
  created_at: string;
3668
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3616
3669
  message: string;
3617
3670
  warning_code: 'failed_to_update_on_acs_system';
3618
3671
  } | {
3619
3672
  created_at: string;
3620
3673
  message: string;
3621
3674
  warning_code: 'salto_ks_user_not_subscribed';
3622
- } | {
3623
- created_at: string;
3624
- message: string;
3625
- warning_code: 'salto_site_user_suspended';
3626
3675
  }>;
3627
3676
  errors: Array<{
3628
3677
  /** Date and time at which Seam created the error. */
3629
3678
  created_at: string;
3630
3679
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3631
3680
  message: string;
3632
- error_code: 'user_deleted_externally';
3681
+ error_code: 'deleted_externally';
3633
3682
  } | {
3634
3683
  /** Date and time at which Seam created the error. */
3635
3684
  created_at: string;
@@ -3641,7 +3690,19 @@ export interface Routes {
3641
3690
  created_at: string;
3642
3691
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3643
3692
  message: string;
3644
- error_code: 'salto_site_user_limit_reached';
3693
+ warning_code: 'failed_to_create_on_acs_system';
3694
+ } | {
3695
+ /** Date and time at which Seam created the error. */
3696
+ created_at: string;
3697
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3698
+ message: string;
3699
+ warning_code: 'failed_to_update_on_acs_system';
3700
+ } | {
3701
+ /** Date and time at which Seam created the error. */
3702
+ created_at: string;
3703
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3704
+ message: string;
3705
+ warning_code: 'failed_to_delete_on_acs_system';
3645
3706
  }>;
3646
3707
  full_name?: string | undefined;
3647
3708
  /**
@@ -3758,24 +3819,22 @@ export interface Routes {
3758
3819
  message: string;
3759
3820
  warning_code: 'being_deleted';
3760
3821
  } | {
3822
+ /** Date and time at which Seam created the error. */
3761
3823
  created_at: string;
3824
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3762
3825
  message: string;
3763
3826
  warning_code: 'failed_to_update_on_acs_system';
3764
3827
  } | {
3765
3828
  created_at: string;
3766
3829
  message: string;
3767
3830
  warning_code: 'salto_ks_user_not_subscribed';
3768
- } | {
3769
- created_at: string;
3770
- message: string;
3771
- warning_code: 'salto_site_user_suspended';
3772
3831
  }>;
3773
3832
  errors: Array<{
3774
3833
  /** Date and time at which Seam created the error. */
3775
3834
  created_at: string;
3776
3835
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3777
3836
  message: string;
3778
- error_code: 'user_deleted_externally';
3837
+ error_code: 'deleted_externally';
3779
3838
  } | {
3780
3839
  /** Date and time at which Seam created the error. */
3781
3840
  created_at: string;
@@ -3787,7 +3846,19 @@ export interface Routes {
3787
3846
  created_at: string;
3788
3847
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3789
3848
  message: string;
3790
- error_code: 'salto_site_user_limit_reached';
3849
+ warning_code: 'failed_to_create_on_acs_system';
3850
+ } | {
3851
+ /** Date and time at which Seam created the error. */
3852
+ created_at: string;
3853
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3854
+ message: string;
3855
+ warning_code: 'failed_to_update_on_acs_system';
3856
+ } | {
3857
+ /** Date and time at which Seam created the error. */
3858
+ created_at: string;
3859
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3860
+ message: string;
3861
+ warning_code: 'failed_to_delete_on_acs_system';
3791
3862
  }>;
3792
3863
  full_name?: string | undefined;
3793
3864
  /**
@@ -3838,24 +3909,22 @@ export interface Routes {
3838
3909
  message: string;
3839
3910
  warning_code: 'being_deleted';
3840
3911
  } | {
3912
+ /** Date and time at which Seam created the error. */
3841
3913
  created_at: string;
3914
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3842
3915
  message: string;
3843
3916
  warning_code: 'failed_to_update_on_acs_system';
3844
3917
  } | {
3845
3918
  created_at: string;
3846
3919
  message: string;
3847
3920
  warning_code: 'salto_ks_user_not_subscribed';
3848
- } | {
3849
- created_at: string;
3850
- message: string;
3851
- warning_code: 'salto_site_user_suspended';
3852
3921
  }>;
3853
3922
  errors: Array<{
3854
3923
  /** Date and time at which Seam created the error. */
3855
3924
  created_at: string;
3856
3925
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3857
3926
  message: string;
3858
- error_code: 'user_deleted_externally';
3927
+ error_code: 'deleted_externally';
3859
3928
  } | {
3860
3929
  /** Date and time at which Seam created the error. */
3861
3930
  created_at: string;
@@ -3867,7 +3936,19 @@ export interface Routes {
3867
3936
  created_at: string;
3868
3937
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3869
3938
  message: string;
3870
- error_code: 'salto_site_user_limit_reached';
3939
+ warning_code: 'failed_to_create_on_acs_system';
3940
+ } | {
3941
+ /** Date and time at which Seam created the error. */
3942
+ created_at: string;
3943
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3944
+ message: string;
3945
+ warning_code: 'failed_to_update_on_acs_system';
3946
+ } | {
3947
+ /** Date and time at which Seam created the error. */
3948
+ created_at: string;
3949
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3950
+ message: string;
3951
+ warning_code: 'failed_to_delete_on_acs_system';
3871
3952
  }>;
3872
3953
  full_name?: string | undefined;
3873
3954
  /**
@@ -5484,7 +5565,7 @@ export interface Routes {
5484
5565
  climate_preset_key: string;
5485
5566
  can_edit: boolean;
5486
5567
  can_delete: boolean;
5487
- name: string | null;
5568
+ name?: string | null;
5488
5569
  display_name: string;
5489
5570
  fan_mode_setting?: ('auto' | 'on') | undefined;
5490
5571
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -5928,7 +6009,7 @@ export interface Routes {
5928
6009
  climate_preset_key: string;
5929
6010
  can_edit: boolean;
5930
6011
  can_delete: boolean;
5931
- name: string | null;
6012
+ name?: string | null;
5932
6013
  display_name: string;
5933
6014
  fan_mode_setting?: ('auto' | 'on') | undefined;
5934
6015
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -6752,7 +6833,7 @@ export interface Routes {
6752
6833
  climate_preset_key: string;
6753
6834
  can_edit: boolean;
6754
6835
  can_delete: boolean;
6755
- name: string | null;
6836
+ name?: string | null;
6756
6837
  display_name: string;
6757
6838
  fan_mode_setting?: ('auto' | 'on') | undefined;
6758
6839
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -7171,7 +7252,7 @@ export interface Routes {
7171
7252
  climate_preset_key: string;
7172
7253
  can_edit: boolean;
7173
7254
  can_delete: boolean;
7174
- name: string | null;
7255
+ name?: string | null;
7175
7256
  display_name: string;
7176
7257
  fan_mode_setting?: ('auto' | 'on') | undefined;
7177
7258
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -7615,7 +7696,7 @@ export interface Routes {
7615
7696
  climate_preset_key: string;
7616
7697
  can_edit: boolean;
7617
7698
  can_delete: boolean;
7618
- name: string | null;
7699
+ name?: string | null;
7619
7700
  display_name: string;
7620
7701
  fan_mode_setting?: ('auto' | 'on') | undefined;
7621
7702
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -8034,7 +8115,7 @@ export interface Routes {
8034
8115
  climate_preset_key: string;
8035
8116
  can_edit: boolean;
8036
8117
  can_delete: boolean;
8037
- name: string | null;
8118
+ name?: string | null;
8038
8119
  display_name: string;
8039
8120
  fan_mode_setting?: ('auto' | 'on') | undefined;
8040
8121
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -9308,7 +9389,7 @@ export interface Routes {
9308
9389
  climate_preset_key: string;
9309
9390
  can_edit: boolean;
9310
9391
  can_delete: boolean;
9311
- name: string | null;
9392
+ name?: string | null;
9312
9393
  display_name: string;
9313
9394
  fan_mode_setting?: ('auto' | 'on') | undefined;
9314
9395
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -9727,7 +9808,7 @@ export interface Routes {
9727
9808
  climate_preset_key: string;
9728
9809
  can_edit: boolean;
9729
9810
  can_delete: boolean;
9730
- name: string | null;
9811
+ name?: string | null;
9731
9812
  display_name: string;
9732
9813
  fan_mode_setting?: ('auto' | 'on') | undefined;
9733
9814
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -12051,7 +12132,7 @@ export interface Routes {
12051
12132
  jsonBody: {
12052
12133
  device_id: string;
12053
12134
  climate_preset_key: string;
12054
- name: string | null;
12135
+ name?: string | null;
12055
12136
  fan_mode_setting?: ('auto' | 'on') | undefined;
12056
12137
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12057
12138
  cooling_set_point_celsius?: number | undefined;
@@ -12067,7 +12148,7 @@ export interface Routes {
12067
12148
  climate_preset_key: string;
12068
12149
  can_edit: boolean;
12069
12150
  can_delete: boolean;
12070
- name: string | null;
12151
+ name?: string | null;
12071
12152
  display_name: string;
12072
12153
  fan_mode_setting?: ('auto' | 'on') | undefined;
12073
12154
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -12444,7 +12525,7 @@ export interface Routes {
12444
12525
  climate_preset_key: string;
12445
12526
  can_edit: boolean;
12446
12527
  can_delete: boolean;
12447
- name: string | null;
12528
+ name?: string | null;
12448
12529
  display_name: string;
12449
12530
  fan_mode_setting?: ('auto' | 'on') | undefined;
12450
12531
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -13690,7 +13771,7 @@ export interface Routes {
13690
13771
  climate_preset_key: string;
13691
13772
  can_edit: boolean;
13692
13773
  can_delete: boolean;
13693
- name: string | null;
13774
+ name?: string | null;
13694
13775
  display_name: string;
13695
13776
  fan_mode_setting?: ('auto' | 'on') | undefined;
13696
13777
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -14706,7 +14787,7 @@ export interface Routes {
14706
14787
  jsonBody: {
14707
14788
  device_id: string;
14708
14789
  climate_preset_key: string;
14709
- name: string | null;
14790
+ name?: string | null;
14710
14791
  fan_mode_setting?: ('auto' | 'on') | undefined;
14711
14792
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
14712
14793
  cooling_set_point_celsius?: number | undefined;
@@ -14722,7 +14803,7 @@ export interface Routes {
14722
14803
  climate_preset_key: string;
14723
14804
  can_edit: boolean;
14724
14805
  can_delete: boolean;
14725
- name: string | null;
14806
+ name?: string | null;
14726
14807
  display_name: string;
14727
14808
  fan_mode_setting?: ('auto' | 'on') | undefined;
14728
14809
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -15265,7 +15346,7 @@ export interface Routes {
15265
15346
  climate_preset_key: string;
15266
15347
  can_edit: boolean;
15267
15348
  can_delete: boolean;
15268
- name: string | null;
15349
+ name?: string | null;
15269
15350
  display_name: string;
15270
15351
  fan_mode_setting?: ('auto' | 'on') | undefined;
15271
15352
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -15686,7 +15767,7 @@ export interface Routes {
15686
15767
  climate_preset_key: string;
15687
15768
  can_edit: boolean;
15688
15769
  can_delete: boolean;
15689
- name: string | null;
15770
+ name?: string | null;
15690
15771
  display_name: string;
15691
15772
  fan_mode_setting?: ('auto' | 'on') | undefined;
15692
15773
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -15826,14 +15907,21 @@ export interface Routes {
15826
15907
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
15827
15908
  message: string;
15828
15909
  /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
15829
- error_code: 'salto_site_user_limit_reached';
15910
+ error_code: 'salto_ks_subscription_limit_exceeded';
15911
+ } | {
15912
+ /** Date and time at which Seam created the error. */
15913
+ created_at: string;
15914
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
15915
+ message: string;
15916
+ /** Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue. */
15917
+ error_code: 'acs_system_disconnected';
15830
15918
  } | {
15831
15919
  /** Date and time at which Seam created the error. */
15832
15920
  created_at: string;
15833
15921
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
15834
15922
  message: string;
15835
- /** Indicates that the Seam Integration user site is blocked. This means that Seam does not have permission to access Salto resources. Go to Salto Dashboard to remove 'Seam Integration' block */
15836
- error_code: 'salto_seam_integration_blocked';
15923
+ /** Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access. */
15924
+ error_code: 'account_disconnected';
15837
15925
  }>;
15838
15926
  /** Warnings associated with the `acs_system`. */
15839
15927
  warnings: Array<{
@@ -15841,8 +15929,8 @@ export interface Routes {
15841
15929
  created_at: string;
15842
15930
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15843
15931
  message: string;
15844
- /** You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
15845
- warning_code: 'salto_site_user_limit_almost_reached';
15932
+ /** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. */
15933
+ warning_code: 'salto_ks_subscription_limit_almost_reached';
15846
15934
  }>;
15847
15935
  /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
15848
15936
  can_automate_enrollment?: boolean | undefined;
@@ -15890,24 +15978,22 @@ export interface Routes {
15890
15978
  message: string;
15891
15979
  warning_code: 'being_deleted';
15892
15980
  } | {
15981
+ /** Date and time at which Seam created the error. */
15893
15982
  created_at: string;
15983
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
15894
15984
  message: string;
15895
15985
  warning_code: 'failed_to_update_on_acs_system';
15896
15986
  } | {
15897
15987
  created_at: string;
15898
15988
  message: string;
15899
15989
  warning_code: 'salto_ks_user_not_subscribed';
15900
- } | {
15901
- created_at: string;
15902
- message: string;
15903
- warning_code: 'salto_site_user_suspended';
15904
15990
  }>;
15905
15991
  errors: Array<{
15906
15992
  /** Date and time at which Seam created the error. */
15907
15993
  created_at: string;
15908
15994
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
15909
15995
  message: string;
15910
- error_code: 'user_deleted_externally';
15996
+ error_code: 'deleted_externally';
15911
15997
  } | {
15912
15998
  /** Date and time at which Seam created the error. */
15913
15999
  created_at: string;
@@ -15919,7 +16005,19 @@ export interface Routes {
15919
16005
  created_at: string;
15920
16006
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
15921
16007
  message: string;
15922
- error_code: 'salto_site_user_limit_reached';
16008
+ warning_code: 'failed_to_create_on_acs_system';
16009
+ } | {
16010
+ /** Date and time at which Seam created the error. */
16011
+ created_at: string;
16012
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
16013
+ message: string;
16014
+ warning_code: 'failed_to_update_on_acs_system';
16015
+ } | {
16016
+ /** Date and time at which Seam created the error. */
16017
+ created_at: string;
16018
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
16019
+ message: string;
16020
+ warning_code: 'failed_to_delete_on_acs_system';
15923
16021
  }>;
15924
16022
  full_name?: string | undefined;
15925
16023
  /**