@seamapi/types 1.1210.0 → 1.1212.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 (33) hide show
  1. package/lib/seam/connect/models/events/access-codes.d.ts +156 -156
  2. package/lib/seam/connect/models/events/access-grants.d.ts +42 -42
  3. package/lib/seam/connect/models/events/access-methods.d.ts +48 -48
  4. package/lib/seam/connect/models/events/acs/access-groups.d.ts +6 -6
  5. package/lib/seam/connect/models/events/acs/common.d.ts +3 -3
  6. package/lib/seam/connect/models/events/acs/credentials.d.ts +24 -24
  7. package/lib/seam/connect/models/events/acs/encoders.d.ts +12 -12
  8. package/lib/seam/connect/models/events/acs/entrances.d.ts +12 -12
  9. package/lib/seam/connect/models/events/acs/index.d.ts +42 -42
  10. package/lib/seam/connect/models/events/acs/systems.d.ts +18 -18
  11. package/lib/seam/connect/models/events/acs/users.d.ts +12 -12
  12. package/lib/seam/connect/models/events/action-attempts.d.ts +48 -48
  13. package/lib/seam/connect/models/events/client-sessions.d.ts +6 -6
  14. package/lib/seam/connect/models/events/common.d.ts +3 -3
  15. package/lib/seam/connect/models/events/common.js +0 -1
  16. package/lib/seam/connect/models/events/common.js.map +1 -1
  17. package/lib/seam/connect/models/events/connect-webviews.d.ts +12 -12
  18. package/lib/seam/connect/models/events/connected-accounts.d.ts +48 -48
  19. package/lib/seam/connect/models/events/devices.d.ts +523 -228
  20. package/lib/seam/connect/models/events/devices.js +64 -0
  21. package/lib/seam/connect/models/events/devices.js.map +1 -1
  22. package/lib/seam/connect/models/events/enrollment-automations.d.ts +6 -6
  23. package/lib/seam/connect/models/events/phones.d.ts +6 -6
  24. package/lib/seam/connect/models/events/seam-event.d.ts +496 -352
  25. package/lib/seam/connect/models/events/spaces.d.ts +18 -18
  26. package/lib/seam/connect/openapi.js +411 -0
  27. package/lib/seam/connect/openapi.js.map +1 -1
  28. package/lib/seam/connect/route-types.d.ts +1081 -591
  29. package/package.json +1 -1
  30. package/src/lib/seam/connect/models/events/common.ts +0 -1
  31. package/src/lib/seam/connect/models/events/devices.ts +100 -0
  32. package/src/lib/seam/connect/openapi.ts +439 -0
  33. package/src/lib/seam/connect/route-types.ts +1168 -585
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/package.json",
3
3
  "name": "@seamapi/types",
4
- "version": "1.1210.0",
4
+ "version": "1.1212.0",
5
5
  "description": "TypeScript types for the Seam API.",
6
6
  "type": "module",
7
7
  "main": "index.js",
@@ -14,7 +14,6 @@ export const common_event = z.object({
14
14
  occurred_at: datetime.describe('Date and time at which the event occurred.'),
15
15
  event_description: z
16
16
  .string()
17
- .optional()
18
17
  .describe(
19
18
  'Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.',
20
19
  ),
@@ -1,6 +1,7 @@
1
1
  import * as z from 'zod/v3'
2
2
 
3
3
  import { custom_metadata } from '../custom-metadata.js'
4
+ import { temperature_controller_mode } from '../devices/temperature-controller.js'
4
5
  import { climate_setting } from '../thermostats/climate-preset.js'
5
6
  import {
6
7
  common_event,
@@ -860,6 +861,102 @@ export const temperature_changed_event = device_event.extend({
860
861
 
861
862
  export type TemperatureChangedEvent = z.infer<typeof temperature_changed_event>
862
863
 
864
+ export const pool_temperature_changed_event = device_event.extend({
865
+ event_type: z.literal('pool.temperature_changed'),
866
+ temperature_celsius: z
867
+ .number()
868
+ .describe(
869
+ 'Water temperature, in °C, reported by the affected pool or spa.',
870
+ ),
871
+ temperature_fahrenheit: z
872
+ .number()
873
+ .describe(
874
+ 'Water temperature, in °F, reported by the affected pool or spa.',
875
+ ),
876
+ }).describe(`
877
+ ---
878
+ route_path: /pools
879
+ undocumented: Unreleased.
880
+ ---
881
+ The water temperature of a pool or spa changed by at least 1 °C. Seam reports water temperature only while the water is circulating.
882
+ `)
883
+
884
+ export type PoolTemperatureChangedEvent = z.infer<
885
+ typeof pool_temperature_changed_event
886
+ >
887
+
888
+ export const pool_temperature_reached_set_point_event = device_event.extend({
889
+ event_type: z.literal('pool.temperature_reached_set_point'),
890
+ temperature_celsius: z
891
+ .number()
892
+ .describe(
893
+ 'Water temperature, in °C, reported by the affected pool or spa.',
894
+ ),
895
+ temperature_fahrenheit: z
896
+ .number()
897
+ .describe(
898
+ 'Water temperature, in °F, reported by the affected pool or spa.',
899
+ ),
900
+ desired_temperature_celsius: z
901
+ .number()
902
+ .describe(
903
+ 'Desired water temperature, in °C, defined by the heating set point of the affected pool or spa.',
904
+ ),
905
+ desired_temperature_fahrenheit: z
906
+ .number()
907
+ .describe(
908
+ 'Desired water temperature, in °F, defined by the heating set point of the affected pool or spa.',
909
+ ),
910
+ }).describe(`
911
+ ---
912
+ route_path: /pools
913
+ undocumented: Unreleased.
914
+ ---
915
+ A heated pool or spa reached its heating set point: heating is on and the water temperature is within 1 °C of the set point or above it. Fires again only after the water falls more than 1 °C below the set point or heating is turned off.
916
+ `)
917
+
918
+ export type PoolTemperatureReachedSetPointEvent = z.infer<
919
+ typeof pool_temperature_reached_set_point_event
920
+ >
921
+
922
+ export const pool_manually_adjusted_method = z
923
+ .enum(['seam', 'external'])
924
+ .describe(
925
+ "Method used to adjust the affected pool or spa. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used. `external` indicates a change made outside Seam, such as in the manufacturer's app or on the controller panel.",
926
+ )
927
+
928
+ export const pool_manually_adjusted_event = device_event.extend({
929
+ event_type: z.literal('pool.manually_adjusted'),
930
+ method: pool_manually_adjusted_method,
931
+ controller_mode: temperature_controller_mode
932
+ .optional()
933
+ .describe(
934
+ 'New heating mode of the affected pool or spa. Present only if the mode changed.',
935
+ ),
936
+ heating_set_point_celsius: z
937
+ .number()
938
+ .optional()
939
+ .describe(
940
+ 'New heating set point, in °C, of the affected pool or spa. Present only if the set point changed.',
941
+ ),
942
+ heating_set_point_fahrenheit: z
943
+ .number()
944
+ .optional()
945
+ .describe(
946
+ 'New heating set point, in °F, of the affected pool or spa. Present only if the set point changed.',
947
+ ),
948
+ }).describe(`
949
+ ---
950
+ route_path: /pools
951
+ undocumented: Unreleased.
952
+ ---
953
+ The heating mode or heating set point of a pool or spa changed.
954
+ `)
955
+
956
+ export type PoolManuallyAdjustedEvent = z.infer<
957
+ typeof pool_manually_adjusted_event
958
+ >
959
+
863
960
  export const device_name_changed_event = device_event.extend({
864
961
  event_type: z.literal('device.name_changed'),
865
962
  device_name: z.string().describe('The new name of the affected device.'),
@@ -974,6 +1071,9 @@ export const device_events = [
974
1071
  temperature_threshold_no_longer_exceeded_event,
975
1072
  temperature_reached_set_point_event,
976
1073
  temperature_changed_event,
1074
+ pool_temperature_changed_event,
1075
+ pool_temperature_reached_set_point_event,
1076
+ pool_manually_adjusted_event,
977
1077
  device_name_changed_event,
978
1078
  camera_activated_event,
979
1079
  device_doorbell_rang_event,