@seamapi/types 1.360.0 → 1.360.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 (31) hide show
  1. package/dist/connect.cjs +899 -569
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +3626 -2951
  4. package/lib/seam/connect/models/acs/acs-credential.js +94 -51
  5. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-encoder.js +12 -7
  7. package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
  8. package/lib/seam/connect/models/acs/acs-entrance.js +37 -14
  9. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-system.js +48 -41
  11. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  12. package/lib/seam/connect/models/acs/acs-user.js +45 -32
  13. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  14. package/lib/seam/connect/models/thermostats/climate-preset.js +12 -10
  15. package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
  16. package/lib/seam/connect/models/thermostats/thermostat-schedule.js +19 -12
  17. package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
  18. package/lib/seam/connect/openapi.d.ts +45 -23
  19. package/lib/seam/connect/openapi.js +557 -401
  20. package/lib/seam/connect/openapi.js.map +1 -1
  21. package/lib/seam/connect/route-types.d.ts +3581 -2928
  22. package/package.json +1 -1
  23. package/src/lib/seam/connect/models/acs/acs-credential.ts +162 -51
  24. package/src/lib/seam/connect/models/acs/acs-encoder.ts +22 -7
  25. package/src/lib/seam/connect/models/acs/acs-entrance.ts +65 -18
  26. package/src/lib/seam/connect/models/acs/acs-system.ts +81 -52
  27. package/src/lib/seam/connect/models/acs/acs-user.ts +69 -32
  28. package/src/lib/seam/connect/models/thermostats/climate-preset.ts +28 -10
  29. package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +31 -12
  30. package/src/lib/seam/connect/openapi.ts +698 -401
  31. package/src/lib/seam/connect/route-types.ts +3581 -2928
package/lib/seam/connect/models/thermostats/thermostat-schedule.js CHANGED
@@ -3,24 +3,27 @@ export const thermostat_schedule = z.object({
3
3
  thermostat_schedule_id: z
4
4
  .string()
5
5
  .uuid()
6
- .describe('ID of the thermostat schedule.'),
7
- device_id: z.string().uuid().describe('ID of the desired thermostat device.'),
6
+ .describe('ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).'),
7
+ device_id: z
8
+ .string()
9
+ .uuid()
10
+ .describe('ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.'),
8
11
  name: z
9
12
  .string()
10
13
  .optional()
11
- .describe('User-friendly name to identify the thermostat schedule.'),
14
+ .describe('User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).'),
12
15
  climate_preset_key: z
13
16
  .string()
14
- .describe('Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.'),
17
+ .describe('Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).'),
15
18
  max_override_period_minutes: z
16
19
  .number()
17
20
  .int()
18
21
  .nonnegative()
19
- .describe("Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions)."),
22
+ .describe("Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions)."),
20
23
  starts_at: z
21
24
  .string()
22
25
  .datetime()
23
- .describe('Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.'),
26
+ .describe('Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.'),
24
27
  unstable_is_override_allowed: z
25
28
  .boolean()
26
29
  .optional()
@@ -28,21 +31,25 @@ export const thermostat_schedule = z.object({
28
31
  ---
29
32
  undocumented: Unstable
30
33
  ---
31
- Indicates whether a person at the thermostat can change the thermostat's settings.`),
34
+ Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.`),
32
35
  ends_at: z
33
36
  .string()
34
37
  .datetime()
35
- .describe('Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.'),
38
+ .describe('Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.'),
36
39
  created_at: z
37
40
  .string()
38
41
  .datetime()
39
- .describe('Date and time at which the thermostat schedule was created.'),
42
+ .describe('Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.'),
40
43
  errors: z
41
44
  .array(z.object({
42
- error_code: z.string(),
43
- message: z.string(),
45
+ error_code: z
46
+ .string()
47
+ .describe('Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'),
48
+ message: z
49
+ .string()
50
+ .describe('Detailed description of the error. Provides insights into the issue and potentially how to rectify it.'),
44
51
  }))
45
- .describe('Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.'),
52
+ .describe('Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).'),
46
53
  }).describe(`
47
54
  ---
48
55
  route_path: /thermostats/schedules
package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"thermostat-schedule.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/thermostats/thermostat-schedule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,sBAAsB,EAAE,CAAC;SACtB,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CAAC,gCAAgC,CAAC;IAC7C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,sCAAsC,CAAC;IAC7E,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,yDAAyD,CAAC;IACtE,kBAAkB,EAAE,CAAC;SAClB,MAAM,EAAE;SACR,QAAQ,CACP,kKAAkK,CACnK;IACH,2BAA2B,EAAE,CAAC;SAC3B,MAAM,EAAE;SACR,GAAG,EAAE;SACL,WAAW,EAAE;SACb,QAAQ,CACP,mVAAmV,CACpV;IACH,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,sIAAsI,CACvI;IACH,4BAA4B,EAAE,CAAC;SAC5B,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP;;;;2FAIqF,CACtF;IACH,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,oIAAoI,CACrI;IACH,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,6DAA6D,CAAC;IAC1E,MAAM,EAAE,CAAC;SACN,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;QACtB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;KACpB,CAAC,CACH;SACA,QAAQ,CACP,gZAAgZ,CACjZ;CACJ,CAAC,CAAC,QAAQ,CAAC;;;;;CAKX,CAAC,CAAA"}
1
+ {"version":3,"file":"thermostat-schedule.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/thermostats/thermostat-schedule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,sBAAsB,EAAE,CAAC;SACtB,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CACP,wIAAwI,CACzI;IACH,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CACP,mGAAmG,CACpG;IACH,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,iKAAiK,CAClK;IACH,kBAAkB,EAAE,CAAC;SAClB,MAAM,EAAE;SACR,QAAQ,CACP,0QAA0Q,CAC3Q;IACH,2BAA2B,EAAE,CAAC;SAC3B,MAAM,EAAE;SACR,GAAG,EAAE;SACL,WAAW,EAAE;SACb,QAAQ,CACP,sbAAsb,CACvb;IACH,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,8OAA8O,CAC/O;IACH,4BAA4B,EAAE,CAAC;SAC5B,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP;;;;wOAIkO,CACnO;IACH,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,4OAA4O,CAC7O;IACH,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,qKAAqK,CACtK;IACH,MAAM,EAAE,CAAC;SACN,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,CAAC;aACV,MAAM,EAAE;aACR,QAAQ,CACP,oGAAoG,CACrG;QACH,OAAO,EAAE,CAAC;aACP,MAAM,EAAE;aACR,QAAQ,CACP,wGAAwG,CACzG;KACJ,CAAC,CACH;SACA,QAAQ,CACP,yJAAyJ,CAC1J;CACJ,CAAC,CAAC,QAAQ,CAAC;;;;;CAKX,CAAC,CAAA"}
package/lib/seam/connect/openapi.d.ts CHANGED
@@ -396,6 +396,7 @@ declare const _default: {
396
396
  type: string;
397
397
  };
398
398
  card_number: {
399
+ description: string;
399
400
  nullable: boolean;
400
401
  type: string;
401
402
  };
@@ -444,6 +445,7 @@ declare const _default: {
444
445
  type: string;
445
446
  };
446
447
  is_issued: {
448
+ description: string;
447
449
  type: string;
448
450
  };
449
451
  is_latest_desired_state_synced_with_provider: {
@@ -464,6 +466,7 @@ declare const _default: {
464
466
  type: string;
465
467
  };
466
468
  issued_at: {
469
+ description: string;
467
470
  format: string;
468
471
  nullable: boolean;
469
472
  type: string;
@@ -700,6 +703,7 @@ declare const _default: {
700
703
  type: string;
701
704
  };
702
705
  assa_abloy_vostio_metadata: {
706
+ description: string;
703
707
  properties: {
704
708
  door_name: {
705
709
  type: string;
@@ -732,6 +736,7 @@ declare const _default: {
732
736
  type: string;
733
737
  };
734
738
  dormakaba_community_metadata: {
739
+ description: string;
735
740
  properties: {
736
741
  access_point_name: {
737
742
  type: string;
@@ -741,12 +746,15 @@ declare const _default: {
741
746
  type: string;
742
747
  };
743
748
  errors: {
749
+ description: string;
744
750
  items: {
745
751
  properties: {
746
752
  error_code: {
753
+ description: string;
747
754
  type: string;
748
755
  };
749
756
  message: {
757
+ description: string;
750
758
  type: string;
751
759
  };
752
760
  };
@@ -756,6 +764,7 @@ declare const _default: {
756
764
  type: string;
757
765
  };
758
766
  latch_metadata: {
767
+ description: string;
759
768
  properties: {
760
769
  accessibility_type: {
761
770
  type: string;
@@ -774,6 +783,7 @@ declare const _default: {
774
783
  type: string;
775
784
  };
776
785
  salto_ks_metadata: {
786
+ description: string;
777
787
  properties: {
778
788
  battery_level: {
779
789
  type: string;
@@ -804,6 +814,7 @@ declare const _default: {
804
814
  type: string;
805
815
  };
806
816
  salto_space_metadata: {
817
+ description: string;
807
818
  properties: {
808
819
  door_description: {
809
820
  type: string;
@@ -819,6 +830,7 @@ declare const _default: {
819
830
  type: string;
820
831
  };
821
832
  visionline_metadata: {
833
+ description: string;
822
834
  properties: {
823
835
  door_category: {
824
836
  enum: string[];
@@ -901,7 +913,6 @@ declare const _default: {
901
913
  format: string;
902
914
  nullable: boolean;
903
915
  type: string;
904
- 'x-draft': string;
905
916
  };
906
917
  errors: {
907
918
  description: string;
@@ -910,7 +921,7 @@ declare const _default: {
910
921
  discriminator: {
911
922
  propertyName: string;
912
923
  };
913
- oneOf: ({
924
+ oneOf: {
914
925
  description: string;
915
926
  properties: {
916
927
  created_at: {
@@ -930,27 +941,7 @@ declare const _default: {
930
941
  };
931
942
  required: string[];
932
943
  type: string;
933
- } | {
934
- properties: {
935
- created_at: {
936
- description: string;
937
- format: string;
938
- type: string;
939
- };
940
- error_code: {
941
- description: string;
942
- enum: string[];
943
- type: string;
944
- };
945
- message: {
946
- description: string;
947
- type: string;
948
- };
949
- };
950
- required: string[];
951
- type: string;
952
- description?: never;
953
- })[];
944
+ }[];
954
945
  };
955
946
  type: string;
956
947
  };
@@ -1027,6 +1018,7 @@ declare const _default: {
1027
1018
  propertyName: string;
1028
1019
  };
1029
1020
  oneOf: ({
1021
+ description: string;
1030
1022
  properties: {
1031
1023
  created_at: {
1032
1024
  description: string;
@@ -1047,6 +1039,7 @@ declare const _default: {
1047
1039
  required: string[];
1048
1040
  type: string;
1049
1041
  } | {
1042
+ description: string;
1050
1043
  properties: {
1051
1044
  created_at: {
1052
1045
  description: string;
@@ -1237,10 +1230,12 @@ declare const _default: {
1237
1230
  description: string;
1238
1231
  properties: {
1239
1232
  created_at: {
1233
+ description: string;
1240
1234
  format: string;
1241
1235
  type: string;
1242
1236
  };
1243
1237
  message: {
1238
+ description: string;
1244
1239
  type: string;
1245
1240
  };
1246
1241
  warning_code: {
@@ -1443,19 +1438,24 @@ declare const _default: {
1443
1438
  description: string;
1444
1439
  properties: {
1445
1440
  cancelled: {
1441
+ description: string;
1446
1442
  type: string;
1447
1443
  };
1448
1444
  card_format: {
1445
+ description: string;
1449
1446
  enum: string[];
1450
1447
  type: string;
1451
1448
  };
1452
1449
  card_holder: {
1450
+ description: string;
1453
1451
  type: string;
1454
1452
  };
1455
1453
  card_id: {
1454
+ description: string;
1456
1455
  type: string;
1457
1456
  };
1458
1457
  common_acs_entrance_ids: {
1458
+ description: string;
1459
1459
  items: {
1460
1460
  format: string;
1461
1461
  type: string;
@@ -1463,12 +1463,15 @@ declare const _default: {
1463
1463
  type: string;
1464
1464
  };
1465
1465
  discarded: {
1466
+ description: string;
1466
1467
  type: string;
1467
1468
  };
1468
1469
  expired: {
1470
+ description: string;
1469
1471
  type: string;
1470
1472
  };
1471
1473
  guest_acs_entrance_ids: {
1474
+ description: string;
1472
1475
  items: {
1473
1476
  format: string;
1474
1477
  type: string;
@@ -1476,16 +1479,20 @@ declare const _default: {
1476
1479
  type: string;
1477
1480
  };
1478
1481
  number_of_issued_cards: {
1482
+ description: string;
1479
1483
  format: string;
1480
1484
  type: string;
1481
1485
  };
1482
1486
  overridden: {
1487
+ description: string;
1483
1488
  type: string;
1484
1489
  };
1485
1490
  overwritten: {
1491
+ description: string;
1486
1492
  type: string;
1487
1493
  };
1488
1494
  pending_auto_update: {
1495
+ description: string;
1489
1496
  type: string;
1490
1497
  };
1491
1498
  };
@@ -1554,6 +1561,7 @@ declare const _default: {
1554
1561
  type: string;
1555
1562
  };
1556
1563
  card_number: {
1564
+ description: string;
1557
1565
  nullable: boolean;
1558
1566
  type: string;
1559
1567
  };
@@ -1602,6 +1610,7 @@ declare const _default: {
1602
1610
  type: string;
1603
1611
  };
1604
1612
  is_issued: {
1613
+ description: string;
1605
1614
  type: string;
1606
1615
  };
1607
1616
  is_latest_desired_state_synced_with_provider: {
@@ -1622,6 +1631,7 @@ declare const _default: {
1622
1631
  type: string;
1623
1632
  };
1624
1633
  issued_at: {
1634
+ description: string;
1625
1635
  format: string;
1626
1636
  nullable: boolean;
1627
1637
  type: string;
@@ -1886,6 +1896,7 @@ declare const _default: {
1886
1896
  type: string;
1887
1897
  };
1888
1898
  card_number: {
1899
+ description: string;
1889
1900
  nullable: boolean;
1890
1901
  type: string;
1891
1902
  };
@@ -1934,6 +1945,7 @@ declare const _default: {
1934
1945
  type: string;
1935
1946
  };
1936
1947
  is_issued: {
1948
+ description: string;
1937
1949
  type: string;
1938
1950
  };
1939
1951
  is_latest_desired_state_synced_with_provider: {
@@ -1954,6 +1966,7 @@ declare const _default: {
1954
1966
  type: string;
1955
1967
  };
1956
1968
  issued_at: {
1969
+ description: string;
1957
1970
  format: string;
1958
1971
  nullable: boolean;
1959
1972
  type: string;
@@ -3955,9 +3968,11 @@ declare const _default: {
3955
3968
  items: {
3956
3969
  properties: {
3957
3970
  error_code: {
3971
+ description: string;
3958
3972
  type: string;
3959
3973
  };
3960
3974
  message: {
3975
+ description: string;
3961
3976
  type: string;
3962
3977
  };
3963
3978
  };
@@ -7315,9 +7330,11 @@ declare const _default: {
7315
7330
  items: {
7316
7331
  properties: {
7317
7332
  error_code: {
7333
+ description: string;
7318
7334
  type: string;
7319
7335
  };
7320
7336
  message: {
7337
+ description: string;
7321
7338
  type: string;
7322
7339
  };
7323
7340
  };
@@ -7708,6 +7725,7 @@ declare const _default: {
7708
7725
  type: string;
7709
7726
  };
7710
7727
  card_number: {
7728
+ description: string;
7711
7729
  nullable: boolean;
7712
7730
  type: string;
7713
7731
  };
@@ -7756,6 +7774,7 @@ declare const _default: {
7756
7774
  type: string;
7757
7775
  };
7758
7776
  is_issued: {
7777
+ description: string;
7759
7778
  type: string;
7760
7779
  };
7761
7780
  is_latest_desired_state_synced_with_provider: {
@@ -7776,6 +7795,7 @@ declare const _default: {
7776
7795
  type: string;
7777
7796
  };
7778
7797
  issued_at: {
7798
+ description: string;
7779
7799
  format: string;
7780
7800
  nullable: boolean;
7781
7801
  type: string;
@@ -8031,10 +8051,12 @@ declare const _default: {
8031
8051
  description: string;
8032
8052
  properties: {
8033
8053
  created_at: {
8054
+ description: string;
8034
8055
  format: string;
8035
8056
  type: string;
8036
8057
  };
8037
8058
  message: {
8059
+ description: string;
8038
8060
  type: string;
8039
8061
  };
8040
8062
  warning_code: {