@seamapi/types 1.240.0 → 1.241.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.
Files changed (62) hide show
  1. package/dist/connect.cjs +1347 -768
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +3569 -1426
  4. package/dist/devicedb.d.cts +30 -30
  5. package/lib/seam/connect/internal/schemas.d.ts +1 -1
  6. package/lib/seam/connect/internal/schemas.js +1 -1
  7. package/lib/seam/connect/internal/schemas.js.map +1 -1
  8. package/lib/seam/connect/model-types.d.ts +1 -1
  9. package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +4 -4
  10. package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +1 -1
  11. package/lib/seam/connect/models/acs/acs-user.d.ts +231 -28
  12. package/lib/seam/connect/models/acs/acs-user.js +61 -13
  13. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  14. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +78 -0
  15. package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -0
  16. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  17. package/lib/seam/connect/models/action-attempts/activate-climate-preset.d.ts +80 -0
  18. package/lib/seam/connect/models/action-attempts/activate-climate-preset.js +25 -0
  19. package/lib/seam/connect/models/action-attempts/activate-climate-preset.js.map +1 -0
  20. package/lib/seam/connect/models/devices/capability-properties/index.d.ts +185 -83
  21. package/lib/seam/connect/models/devices/capability-properties/thermostat.d.ts +185 -83
  22. package/lib/seam/connect/models/devices/capability-properties/thermostat.js +15 -6
  23. package/lib/seam/connect/models/devices/capability-properties/thermostat.js.map +1 -1
  24. package/lib/seam/connect/models/devices/device.d.ts +263 -119
  25. package/lib/seam/connect/models/devices/phone.d.ts +187 -85
  26. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +185 -83
  27. package/lib/seam/connect/models/thermostats/climate-preset.d.ts +83 -0
  28. package/lib/seam/connect/models/thermostats/climate-preset.js +18 -0
  29. package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -0
  30. package/lib/seam/connect/models/thermostats/climate-setting-schedule.d.ts +18 -34
  31. package/lib/seam/connect/models/thermostats/climate-setting-schedule.js +8 -10
  32. package/lib/seam/connect/models/thermostats/climate-setting-schedule.js.map +1 -1
  33. package/lib/seam/connect/models/thermostats/index.d.ts +1 -1
  34. package/lib/seam/connect/models/thermostats/index.js +1 -1
  35. package/lib/seam/connect/models/thermostats/index.js.map +1 -1
  36. package/lib/seam/connect/openapi.d.ts +1000 -569
  37. package/lib/seam/connect/openapi.js +1188 -681
  38. package/lib/seam/connect/openapi.js.map +1 -1
  39. package/lib/seam/connect/route-types.d.ts +1738 -460
  40. package/lib/seam/connect/schemas.d.ts +1 -1
  41. package/lib/seam/connect/schemas.js +1 -1
  42. package/lib/seam/connect/schemas.js.map +1 -1
  43. package/lib/seam/devicedb/models/device-model.d.ts +8 -8
  44. package/lib/seam/devicedb/models/manufacturer.d.ts +2 -2
  45. package/lib/seam/devicedb/route-specs.d.ts +20 -20
  46. package/package.json +2 -2
  47. package/src/lib/seam/connect/internal/schemas.ts +2 -2
  48. package/src/lib/seam/connect/model-types.ts +1 -1
  49. package/src/lib/seam/connect/models/acs/acs-user.ts +86 -19
  50. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
  51. package/src/lib/seam/connect/models/action-attempts/activate-climate-preset.ts +36 -0
  52. package/src/lib/seam/connect/models/devices/capability-properties/thermostat.ts +16 -6
  53. package/src/lib/seam/connect/models/thermostats/climate-preset.ts +24 -0
  54. package/src/lib/seam/connect/models/thermostats/climate-setting-schedule.ts +16 -19
  55. package/src/lib/seam/connect/models/thermostats/index.ts +1 -1
  56. package/src/lib/seam/connect/openapi.ts +1216 -670
  57. package/src/lib/seam/connect/route-types.ts +2030 -505
  58. package/src/lib/seam/connect/schemas.ts +1 -1
  59. package/lib/seam/connect/models/thermostats/climate-setting.d.ts +0 -24
  60. package/lib/seam/connect/models/thermostats/climate-setting.js +0 -11
  61. package/lib/seam/connect/models/thermostats/climate-setting.js.map +0 -1
  62. package/src/lib/seam/connect/models/thermostats/climate-setting.ts +0 -14
@@ -1 +1 @@
1
- export { access_code, acs_access_group, acs_credential, acs_entrance, acs_system, acs_user, action_attempt, client_session, climate_setting_schedule, connect_webview, connected_account, custom_metadata, device, device_provider, noise_threshold, seam_event, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
1
+ export { access_code, acs_access_group, acs_credential, acs_entrance, acs_system, acs_user, action_attempt, client_session, connect_webview, connected_account, custom_metadata, device, device_provider, noise_threshold, seam_event, thermostat_schedule, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
@@ -1,2 +1,2 @@
1
- export { access_code, acs_access_group, acs_credential, acs_entrance, acs_system, acs_user, action_attempt, client_session, climate_setting_schedule, connect_webview, connected_account, custom_metadata, device, device_provider, noise_threshold, seam_event, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
1
+ export { access_code, acs_access_group, acs_credential, acs_entrance, acs_system, acs_user, action_attempt, client_session, connect_webview, connected_account, custom_metadata, device, device_provider, noise_threshold, seam_event, thermostat_schedule, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
2
2
  //# sourceMappingURL=schemas.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,cAAc,EACd,wBAAwB,EACxB,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,MAAM,EACN,eAAe,EACf,eAAe,EACf,UAAU,EACV,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}
1
+ {"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,cAAc,EACd,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,MAAM,EACN,eAAe,EACf,eAAe,EACf,UAAU,EACV,mBAAmB,EACnB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}
@@ -365,8 +365,8 @@ export declare const base_device_model_v1: z.ZodObject<{
365
365
  seam_api_guide: z.ZodOptional<z.ZodString>;
366
366
  description: z.ZodOptional<z.ZodString>;
367
367
  }, "device_model_count">, "strip", z.ZodTypeAny, {
368
- manufacturer_id: string;
369
368
  display_name: string;
369
+ manufacturer_id: string;
370
370
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
371
371
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
372
372
  is_connect_webview_supported: boolean;
@@ -392,8 +392,8 @@ export declare const base_device_model_v1: z.ZodObject<{
392
392
  us_customer_support_contact_url?: string | undefined;
393
393
  seam_api_guide?: string | undefined;
394
394
  }, {
395
- manufacturer_id: string;
396
395
  display_name: string;
396
+ manufacturer_id: string;
397
397
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
398
398
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
399
399
  is_connect_webview_supported: boolean;
@@ -522,8 +522,8 @@ export declare const base_device_model_v1: z.ZodObject<{
522
522
  display_name: string;
523
523
  device_model_id: string;
524
524
  manufacturer: {
525
- manufacturer_id: string;
526
525
  display_name: string;
526
+ manufacturer_id: string;
527
527
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
528
528
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
529
529
  is_connect_webview_supported: boolean;
@@ -582,8 +582,8 @@ export declare const base_device_model_v1: z.ZodObject<{
582
582
  display_name: string;
583
583
  device_model_id: string;
584
584
  manufacturer: {
585
- manufacturer_id: string;
586
585
  display_name: string;
586
+ manufacturer_id: string;
587
587
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
588
588
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
589
589
  is_connect_webview_supported: boolean;
@@ -684,8 +684,8 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
684
684
  seam_api_guide: z.ZodOptional<z.ZodString>;
685
685
  description: z.ZodOptional<z.ZodString>;
686
686
  }, "device_model_count">, "strip", z.ZodTypeAny, {
687
- manufacturer_id: string;
688
687
  display_name: string;
688
+ manufacturer_id: string;
689
689
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
690
690
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
691
691
  is_connect_webview_supported: boolean;
@@ -711,8 +711,8 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
711
711
  us_customer_support_contact_url?: string | undefined;
712
712
  seam_api_guide?: string | undefined;
713
713
  }, {
714
- manufacturer_id: string;
715
714
  display_name: string;
715
+ manufacturer_id: string;
716
716
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
717
717
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
718
718
  is_connect_webview_supported: boolean;
@@ -841,8 +841,8 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
841
841
  display_name: string;
842
842
  device_model_id: string;
843
843
  manufacturer: {
844
- manufacturer_id: string;
845
844
  display_name: string;
845
+ manufacturer_id: string;
846
846
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
847
847
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
848
848
  is_connect_webview_supported: boolean;
@@ -901,8 +901,8 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
901
901
  display_name: string;
902
902
  device_model_id: string;
903
903
  manufacturer: {
904
- manufacturer_id: string;
905
904
  display_name: string;
905
+ manufacturer_id: string;
906
906
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
907
907
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
908
908
  is_connect_webview_supported: boolean;
@@ -58,8 +58,8 @@ export declare const manufacturer: z.ZodObject<{
58
58
  seam_api_guide: z.ZodOptional<z.ZodString>;
59
59
  description: z.ZodOptional<z.ZodString>;
60
60
  }, "strip", z.ZodTypeAny, {
61
- manufacturer_id: string;
62
61
  display_name: string;
62
+ manufacturer_id: string;
63
63
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
64
64
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
65
65
  is_connect_webview_supported: boolean;
@@ -86,8 +86,8 @@ export declare const manufacturer: z.ZodObject<{
86
86
  us_customer_support_contact_url?: string | undefined;
87
87
  seam_api_guide?: string | undefined;
88
88
  }, {
89
- manufacturer_id: string;
90
89
  display_name: string;
90
+ manufacturer_id: string;
91
91
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
92
92
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
93
93
  is_connect_webview_supported: boolean;
@@ -57,8 +57,8 @@ export declare const routes: {
57
57
  seam_api_guide: z.ZodOptional<z.ZodString>;
58
58
  description: z.ZodOptional<z.ZodString>;
59
59
  }, "device_model_count">, "strip", z.ZodTypeAny, {
60
- manufacturer_id: string;
61
60
  display_name: string;
61
+ manufacturer_id: string;
62
62
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
63
63
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
64
64
  is_connect_webview_supported: boolean;
@@ -84,8 +84,8 @@ export declare const routes: {
84
84
  us_customer_support_contact_url?: string | undefined;
85
85
  seam_api_guide?: string | undefined;
86
86
  }, {
87
- manufacturer_id: string;
88
87
  display_name: string;
88
+ manufacturer_id: string;
89
89
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
90
90
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
91
91
  is_connect_webview_supported: boolean;
@@ -214,8 +214,8 @@ export declare const routes: {
214
214
  display_name: string;
215
215
  device_model_id: string;
216
216
  manufacturer: {
217
- manufacturer_id: string;
218
217
  display_name: string;
218
+ manufacturer_id: string;
219
219
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
220
220
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
221
221
  is_connect_webview_supported: boolean;
@@ -274,8 +274,8 @@ export declare const routes: {
274
274
  display_name: string;
275
275
  device_model_id: string;
276
276
  manufacturer: {
277
- manufacturer_id: string;
278
277
  display_name: string;
278
+ manufacturer_id: string;
279
279
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
280
280
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
281
281
  is_connect_webview_supported: boolean;
@@ -588,8 +588,8 @@ export declare const routes: {
588
588
  display_name: string;
589
589
  device_model_id: string;
590
590
  manufacturer: {
591
- manufacturer_id: string;
592
591
  display_name: string;
592
+ manufacturer_id: string;
593
593
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
594
594
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
595
595
  is_connect_webview_supported: boolean;
@@ -711,8 +711,8 @@ export declare const routes: {
711
711
  display_name: string;
712
712
  device_model_id: string;
713
713
  manufacturer: {
714
- manufacturer_id: string;
715
714
  display_name: string;
715
+ manufacturer_id: string;
716
716
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
717
717
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
718
718
  is_connect_webview_supported: boolean;
@@ -909,8 +909,8 @@ export declare const routes: {
909
909
  seam_api_guide: z.ZodOptional<z.ZodString>;
910
910
  description: z.ZodOptional<z.ZodString>;
911
911
  }, "device_model_count">, "strip", z.ZodTypeAny, {
912
- manufacturer_id: string;
913
912
  display_name: string;
913
+ manufacturer_id: string;
914
914
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
915
915
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
916
916
  is_connect_webview_supported: boolean;
@@ -936,8 +936,8 @@ export declare const routes: {
936
936
  us_customer_support_contact_url?: string | undefined;
937
937
  seam_api_guide?: string | undefined;
938
938
  }, {
939
- manufacturer_id: string;
940
939
  display_name: string;
940
+ manufacturer_id: string;
941
941
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
942
942
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
943
943
  is_connect_webview_supported: boolean;
@@ -1066,8 +1066,8 @@ export declare const routes: {
1066
1066
  display_name: string;
1067
1067
  device_model_id: string;
1068
1068
  manufacturer: {
1069
- manufacturer_id: string;
1070
1069
  display_name: string;
1070
+ manufacturer_id: string;
1071
1071
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1072
1072
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1073
1073
  is_connect_webview_supported: boolean;
@@ -1126,8 +1126,8 @@ export declare const routes: {
1126
1126
  display_name: string;
1127
1127
  device_model_id: string;
1128
1128
  manufacturer: {
1129
- manufacturer_id: string;
1130
1129
  display_name: string;
1130
+ manufacturer_id: string;
1131
1131
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1132
1132
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1133
1133
  is_connect_webview_supported: boolean;
@@ -1440,8 +1440,8 @@ export declare const routes: {
1440
1440
  display_name: string;
1441
1441
  device_model_id: string;
1442
1442
  manufacturer: {
1443
- manufacturer_id: string;
1444
1443
  display_name: string;
1444
+ manufacturer_id: string;
1445
1445
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1446
1446
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1447
1447
  is_connect_webview_supported: boolean;
@@ -1563,8 +1563,8 @@ export declare const routes: {
1563
1563
  display_name: string;
1564
1564
  device_model_id: string;
1565
1565
  manufacturer: {
1566
- manufacturer_id: string;
1567
1566
  display_name: string;
1567
+ manufacturer_id: string;
1568
1568
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1569
1569
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1570
1570
  is_connect_webview_supported: boolean;
@@ -1737,8 +1737,8 @@ export declare const routes: {
1737
1737
  seam_api_guide: z.ZodOptional<z.ZodString>;
1738
1738
  description: z.ZodOptional<z.ZodString>;
1739
1739
  }, "strip", z.ZodTypeAny, {
1740
- manufacturer_id: string;
1741
1740
  display_name: string;
1741
+ manufacturer_id: string;
1742
1742
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1743
1743
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1744
1744
  is_connect_webview_supported: boolean;
@@ -1765,8 +1765,8 @@ export declare const routes: {
1765
1765
  us_customer_support_contact_url?: string | undefined;
1766
1766
  seam_api_guide?: string | undefined;
1767
1767
  }, {
1768
- manufacturer_id: string;
1769
1768
  display_name: string;
1769
+ manufacturer_id: string;
1770
1770
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1771
1771
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1772
1772
  is_connect_webview_supported: boolean;
@@ -1795,8 +1795,8 @@ export declare const routes: {
1795
1795
  }>;
1796
1796
  }, "strip", z.ZodTypeAny, {
1797
1797
  manufacturer: {
1798
- manufacturer_id: string;
1799
1798
  display_name: string;
1799
+ manufacturer_id: string;
1800
1800
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1801
1801
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1802
1802
  is_connect_webview_supported: boolean;
@@ -1825,8 +1825,8 @@ export declare const routes: {
1825
1825
  };
1826
1826
  }, {
1827
1827
  manufacturer: {
1828
- manufacturer_id: string;
1829
1828
  display_name: string;
1829
+ manufacturer_id: string;
1830
1830
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1831
1831
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1832
1832
  is_connect_webview_supported: boolean;
@@ -1917,8 +1917,8 @@ export declare const routes: {
1917
1917
  seam_api_guide: z.ZodOptional<z.ZodString>;
1918
1918
  description: z.ZodOptional<z.ZodString>;
1919
1919
  }, "strip", z.ZodTypeAny, {
1920
- manufacturer_id: string;
1921
1920
  display_name: string;
1921
+ manufacturer_id: string;
1922
1922
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1923
1923
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1924
1924
  is_connect_webview_supported: boolean;
@@ -1945,8 +1945,8 @@ export declare const routes: {
1945
1945
  us_customer_support_contact_url?: string | undefined;
1946
1946
  seam_api_guide?: string | undefined;
1947
1947
  }, {
1948
- manufacturer_id: string;
1949
1948
  display_name: string;
1949
+ manufacturer_id: string;
1950
1950
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1951
1951
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1952
1952
  is_connect_webview_supported: boolean;
@@ -1975,8 +1975,8 @@ export declare const routes: {
1975
1975
  }>, "many">;
1976
1976
  }, "strip", z.ZodTypeAny, {
1977
1977
  manufacturers: {
1978
- manufacturer_id: string;
1979
1978
  display_name: string;
1979
+ manufacturer_id: string;
1980
1980
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1981
1981
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
1982
1982
  is_connect_webview_supported: boolean;
@@ -2005,8 +2005,8 @@ export declare const routes: {
2005
2005
  }[];
2006
2006
  }, {
2007
2007
  manufacturers: {
2008
- manufacturer_id: string;
2009
2008
  display_name: string;
2009
+ manufacturer_id: string;
2010
2010
  integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
2011
2011
  integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
2012
2012
  is_connect_webview_supported: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.240.0",
3
+ "version": "1.241.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -92,7 +92,7 @@
92
92
  "zod": "^3.21.4"
93
93
  },
94
94
  "devDependencies": {
95
- "@seamapi/blueprint": "^0.16.0",
95
+ "@seamapi/blueprint": "^0.19.0",
96
96
  "@types/node": "^20.8.10",
97
97
  "concurrently": "^8.2.0",
98
98
  "del-cli": "^5.0.0",
@@ -17,8 +17,7 @@ export {
17
17
  any_device_type,
18
18
  battery_status,
19
19
  capabilities,
20
- climate_setting,
21
- climate_setting_schedule,
20
+ climate_preset,
22
21
  common_device_properties,
23
22
  connect_webview_device_selection_mode,
24
23
  connected_account,
@@ -38,6 +37,7 @@ export {
38
37
  phone_number,
39
38
  thermostat_capability_properties,
40
39
  thermostat_device_type,
40
+ thermostat_schedule,
41
41
  unmanaged_access_code,
42
42
  unmanaged_device,
43
43
  user_identity,
@@ -9,7 +9,6 @@ export type {
9
9
  AcsUser,
10
10
  ActionAttempt,
11
11
  ClientSession,
12
- ClimateSettingSchedule,
13
12
  ConnectedAccount,
14
13
  ConnectedAccountError,
15
14
  ConnectedAccountWarning,
@@ -22,6 +21,7 @@ export type {
22
21
  NoiseThreshold,
23
22
  SeamEvent,
24
23
  SeamEventType,
24
+ ThermostatSchedule,
25
25
  UnmanagedAccessCode,
26
26
  UnmanagedDevice,
27
27
  UserIdentity,
@@ -13,23 +13,87 @@ export const acs_user_external_type = z.enum([
13
13
 
14
14
  export type AcsUserExternalType = z.infer<typeof acs_user_external_type>
15
15
 
16
+ const common_acs_user_error = z.object({
17
+ created_at: z
18
+ .string()
19
+ .datetime()
20
+ .describe('Date and time at which Seam created the error.'),
21
+ message: z
22
+ .string()
23
+ .describe(
24
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
25
+ ),
26
+ })
27
+
28
+ const acs_users_user_deleted_externally = common_acs_user_error
29
+ .extend({
30
+ error_code: z.literal('user_deleted_externally'),
31
+ })
32
+ .describe(
33
+ `Indicates that the user was deleted from the ACS system outside of Seam.`,
34
+ )
35
+
36
+ const acs_users_salto_ks_subscription_limit_exceeded = common_acs_user_error
37
+ .extend({
38
+ error_code: z.literal('salto_ks_subscription_limit_exceeded'),
39
+ })
40
+ .describe(
41
+ `Indicates that the user could not be subscribed on Salto KS because the subscription limit has been exceeded.`,
42
+ )
43
+
44
+ const acs_users_salto_site_user_limit_reached = common_acs_user_error.extend({
45
+ error_code: z.literal('salto_site_user_limit_reached'),
46
+ })
47
+
48
+ const acs_user_errors = z
49
+ .union([
50
+ acs_users_user_deleted_externally,
51
+ acs_users_salto_ks_subscription_limit_exceeded,
52
+ acs_users_salto_site_user_limit_reached,
53
+ ])
54
+ .describe('Error associated with the `acs_user`.')
55
+
56
+ export const acs_users_error_map = z.object({
57
+ user_deleted_externally: acs_users_user_deleted_externally
58
+ .optional()
59
+ .nullable(),
60
+ salto_ks_subscription_limit_exceeded:
61
+ acs_users_salto_ks_subscription_limit_exceeded.optional().nullable(),
62
+ salto_site_user_limit_reached: acs_users_salto_site_user_limit_reached
63
+ .optional()
64
+ .nullable(),
65
+ })
66
+
67
+ export type AcsUsersErrorMap = z.infer<typeof acs_users_error_map>
68
+
16
69
  const common_acs_users_warning = z.object({
17
70
  created_at: z.string().datetime(),
18
71
  message: z.string(),
19
72
  })
20
73
 
21
- const acs_users_being_deleted = common_acs_users_warning.extend({
22
- warning_code: z.literal('being_deleted'),
23
- })
74
+ const acs_users_being_deleted = common_acs_users_warning
75
+ .extend({
76
+ warning_code: z.literal('being_deleted'),
77
+ })
78
+ .describe(
79
+ `Indicates that the user is being deleted from the ACS system. This is a temporary state, and the user will be deleted shortly.`,
80
+ )
24
81
 
25
- const acs_users_salto_ks_user_not_subscribed = common_acs_users_warning.extend({
26
- warning_code: z.literal('salto_ks_user_not_subscribed'),
27
- })
82
+ const acs_users_salto_ks_user_not_subscribed = common_acs_users_warning
83
+ .extend({
84
+ warning_code: z.literal('salto_ks_user_not_subscribed'),
85
+ })
86
+ .describe(
87
+ `Indicates that the user is not subscribed on the Salto KS, so they cannot unlock doors or perform any actions. This occur when the their access schedule hasn’t started yet, or if their access schedule has ended, or if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.`,
88
+ )
28
89
 
29
- const acs_users_failed_to_update_acs_user_on_acs_system =
30
- common_acs_users_warning.extend({
31
- warning_code: z.literal('failed_to_update_acs_user_on_acs_system'),
90
+ const acs_users_failed_to_update_on_acs_system = common_acs_users_warning
91
+ .extend({
92
+ warning_code: z.literal('failed_to_update_on_acs_system'),
32
93
  })
94
+ .describe(
95
+ `Indicates that the user was not updated on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.`,
96
+ )
33
97
 
34
98
  // TODO: Some acs_users already have this warning, so we need to keep it here until we migrate
35
99
  const acs_users_salto_site_user_suspended = common_acs_users_warning.extend({
@@ -38,8 +102,9 @@ const acs_users_salto_site_user_suspended = common_acs_users_warning.extend({
38
102
 
39
103
  export const acs_users_warning_map = z.object({
40
104
  being_deleted: acs_users_being_deleted.optional().nullable(),
41
- failed_to_update_acs_user_on_acs_system:
42
- acs_users_failed_to_update_acs_user_on_acs_system.optional().nullable(),
105
+ failed_to_update_on_acs_system: acs_users_failed_to_update_on_acs_system
106
+ .optional()
107
+ .nullable(),
43
108
  salto_ks_user_not_subscribed: acs_users_salto_ks_user_not_subscribed
44
109
  .optional()
45
110
  .nullable(),
@@ -48,12 +113,14 @@ export const acs_users_warning_map = z.object({
48
113
  .nullable(),
49
114
  })
50
115
 
51
- export const acs_users_warning = z.union([
52
- acs_users_being_deleted,
53
- acs_users_failed_to_update_acs_user_on_acs_system,
54
- acs_users_salto_ks_user_not_subscribed,
55
- acs_users_salto_site_user_suspended,
56
- ])
116
+ export const acs_users_warnings = z
117
+ .union([
118
+ acs_users_being_deleted,
119
+ acs_users_failed_to_update_on_acs_system,
120
+ acs_users_salto_ks_user_not_subscribed,
121
+ acs_users_salto_site_user_suspended,
122
+ ])
123
+ .describe('Warning associated with the `acs_user`.')
57
124
 
58
125
  export type AcsUsersWarningMap = z.infer<typeof acs_users_warning_map>
59
126
 
@@ -89,8 +156,8 @@ const common_acs_user = z
89
156
  .datetime()
90
157
  .optional(),
91
158
  is_latest_desired_state_synced_with_provider: z.boolean().optional(),
92
- warnings: z.array(acs_users_warning),
93
- errors: z.any(),
159
+ warnings: z.array(acs_users_warnings),
160
+ errors: z.array(acs_user_errors),
94
161
  })
95
162
  .merge(user_fields)
96
163
 
@@ -1,5 +1,6 @@
1
1
  import { z } from 'zod'
2
2
 
3
+ import { activate_climate_preset_action_attempt } from './activate-climate-preset.js'
3
4
  import { deprecated_action_attempts } from './deprecated.js'
4
5
  import { lock_door_action_attempt } from './lock-door.js'
5
6
  import { reset_sandbox_workspace_action_attempt } from './reset-sandbox-workspace.js'
@@ -19,6 +20,7 @@ export const action_attempt = z.union([
19
20
  ...set_heat_cool_action_attempt.options,
20
21
  ...set_fan_mode_action_attempt.options,
21
22
  ...set_thermostat_off_action_attempt.options,
23
+ ...activate_climate_preset_action_attempt.options,
22
24
  ...deprecated_action_attempts,
23
25
  ])
24
26
 
@@ -0,0 +1,36 @@
1
+ import { z } from 'zod'
2
+
3
+ import {
4
+ common_failed_action_attempt,
5
+ common_pending_action_attempt,
6
+ common_succeeded_action_attempt,
7
+ } from './common.js'
8
+
9
+ const action_type = z.literal('ACTIVATE_CLIMATE_PRESET')
10
+
11
+ const error = z.object({
12
+ type: z.string(),
13
+ message: z.string(),
14
+ })
15
+
16
+ const result = z.object({})
17
+
18
+ export const activate_climate_preset_action_attempt = z.discriminatedUnion(
19
+ 'status',
20
+ [
21
+ common_pending_action_attempt
22
+ .extend({
23
+ action_type,
24
+ })
25
+ .describe('Activating climate preset.'),
26
+ common_succeeded_action_attempt
27
+ .extend({
28
+ action_type,
29
+ result,
30
+ })
31
+ .describe('Activating climate preset succeeded.'),
32
+ common_failed_action_attempt
33
+ .extend({ action_type, error })
34
+ .describe('Activating climate preset failed.'),
35
+ ],
36
+ )
@@ -1,10 +1,11 @@
1
1
  import { z } from 'zod'
2
2
 
3
3
  import {
4
+ climate_preset,
4
5
  climate_setting,
5
- climate_setting_schedule,
6
6
  fan_mode_setting,
7
7
  hvac_mode_setting,
8
+ thermostat_schedule,
8
9
  } from '../../thermostats/index.js'
9
10
 
10
11
  export const thermostat_capability_properties = z
@@ -16,7 +17,11 @@ export const thermostat_capability_properties = z
16
17
  is_heating: z.boolean(),
17
18
  is_cooling: z.boolean(),
18
19
  is_fan_running: z.boolean(),
19
- fan_mode_setting,
20
+ fan_mode_setting: fan_mode_setting.describe(`
21
+ ---
22
+ deprecated: use current_climate_setting.fan_mode_setting instead.
23
+ ---
24
+ `),
20
25
 
21
26
  /**
22
27
  * this is true if the current thermostat settings differ that what is on seam, and `current_climate_setting.manual_override_allowed: true`
@@ -24,12 +29,17 @@ export const thermostat_capability_properties = z
24
29
  is_temporary_manual_override_active: z.boolean(),
25
30
 
26
31
  /**
27
- * can be derived from `default_climate_setting`, or `active_climate_setting_schedule` if one is active
32
+ * can be derived from `fallback_climate_preset_key`, or `active_thermostat_schedule` if one is active
28
33
  */
29
34
  current_climate_setting: climate_setting,
30
- default_climate_setting: climate_setting,
31
- is_climate_setting_schedule_active: z.boolean(),
32
- active_climate_setting_schedule: climate_setting_schedule,
35
+ default_climate_setting: climate_setting.describe(`
36
+ ---
37
+ deprecated: use fallback_climate_preset_key to specify a fallback climate preset instead.
38
+ ---
39
+ `),
40
+ available_climate_presets: z.array(climate_preset),
41
+ fallback_climate_preset_key: z.string().min(1).nullable().default(null),
42
+ active_thermostat_schedule: thermostat_schedule.nullable().default(null),
33
43
  min_cooling_set_point_celsius: z.number(),
34
44
  min_cooling_set_point_fahrenheit: z.number(),
35
45
  max_cooling_set_point_celsius: z.number(),
@@ -0,0 +1,24 @@
1
+ import { z } from 'zod'
2
+
3
+ import { fan_mode_setting, hvac_mode_setting } from './modes.js'
4
+
5
+ export const climate_preset = z.object({
6
+ climate_preset_key: z.string(),
7
+ can_edit: z.boolean(),
8
+ can_delete: z.boolean(),
9
+ name: z.string().nullable(),
10
+ display_name: z.string(),
11
+ fan_mode_setting: fan_mode_setting.optional(),
12
+ hvac_mode_setting: hvac_mode_setting.optional(),
13
+ cooling_set_point_celsius: z.number().optional(),
14
+ heating_set_point_celsius: z.number().optional(),
15
+ cooling_set_point_fahrenheit: z.number().optional(),
16
+ heating_set_point_fahrenheit: z.number().optional(),
17
+ manual_override_allowed: z.boolean(),
18
+ })
19
+
20
+ export type ClimatePreset = z.infer<typeof climate_preset>
21
+
22
+ export const climate_setting = climate_preset.partial()
23
+
24
+ export type ClimateSetting = z.infer<typeof climate_setting>