@seamapi/types 1.1197.0 → 1.1199.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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1197.0",
3
+ "version": "1.1199.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -1443,6 +1443,42 @@ export const device_metadata = z
1443
1443
  .partial()
1444
1444
  .describe(`Metadata for an Aqara device.`),
1445
1445
 
1446
+ tuya_metadata: z
1447
+ .object({
1448
+ device_id: z
1449
+ .string()
1450
+ .optional()
1451
+ .describe(`Device ID for a Tuya device.`),
1452
+ device_name: z
1453
+ .string()
1454
+ .optional()
1455
+ .describe(`Device name for a Tuya device.`),
1456
+ category: z
1457
+ .string()
1458
+ .optional()
1459
+ .describe(`Tuya product category code for the device (e.g. ms).`),
1460
+ product_id: z
1461
+ .string()
1462
+ .optional()
1463
+ .describe(`Tuya product ID for the device.`),
1464
+ product_name: z
1465
+ .string()
1466
+ .optional()
1467
+ .describe(`Tuya product name for the device.`),
1468
+ model: z
1469
+ .string()
1470
+ .nullable()
1471
+ .optional()
1472
+ .describe(`Model reported for a Tuya device.`),
1473
+ time_zone: z
1474
+ .string()
1475
+ .nullable()
1476
+ .optional()
1477
+ .describe(`Time zone reported for a Tuya device (e.g. +08:00).`),
1478
+ })
1479
+ .partial()
1480
+ .describe(`Metadata for a Tuya device.`),
1481
+
1446
1482
  eufy_metadata: z
1447
1483
  .object({
1448
1484
  device_id: z.string().optional(),
@@ -80,6 +80,7 @@ export const DEVICE_PROVIDERS = {
80
80
  EUFY: 'eufy',
81
81
  SONOS: 'sonos',
82
82
  HAYWARD_OMNILOGIC: 'hayward_omnilogic',
83
+ TUYA: 'tuya',
83
84
  } as const
84
85
 
85
86
  export type DeviceProviderName =
@@ -173,6 +174,7 @@ export const PROVIDER_CATEGORY_MAP = {
173
174
  'unifi_protect',
174
175
  'yale_connect',
175
176
  'alertify',
177
+ 'tuya',
176
178
  ],
177
179
 
178
180
  thermostats: [
@@ -37,6 +37,7 @@ export const LOCK_DEVICE_TYPE = {
37
37
  OMNITEC_LOCK: 'omnitec_lock',
38
38
  KISI_LOCK: 'kisi_lock',
39
39
  AQARA_LOCK: 'aqara_lock',
40
+ TUYA_LOCK: 'tuya_lock',
40
41
  EUFY_LOCK: 'eufy_lock',
41
42
  } as const
42
43
 
@@ -738,16 +738,27 @@ const max_access_codes_reached = common_device_warning.extend({
738
738
  Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones.
739
739
  `)
740
740
 
741
- const cloud_recording_not_enabled = common_device_warning
741
+ const subscription_required_for_additional_capabilities = common_device_warning
742
742
  .extend({
743
743
  warning_code: z
744
- .literal('cloud_recording_not_enabled')
744
+ .literal('subscription_required_for_additional_capabilities')
745
745
  .describe(warning_code_description),
746
746
  })
747
747
  .describe(
748
- "Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable.",
748
+ 'Indicates that a third-party subscription is required to enable additional device capabilities.',
749
749
  )
750
750
 
751
+ const cloud_recording_not_enabled = common_device_warning.extend({
752
+ warning_code: z
753
+ .literal('cloud_recording_not_enabled')
754
+ .describe(warning_code_description),
755
+ }).describe(`
756
+ ---
757
+ deprecated: Use \`subscription_required_for_additional_capabilities\`.
758
+ ---
759
+ Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable.
760
+ `)
761
+
751
762
  const device_warning = z.discriminatedUnion('warning_code', [
752
763
  partial_backup_access_code_pool,
753
764
  many_active_backup_codes,
@@ -778,6 +789,7 @@ const device_warning = z.discriminatedUnion('warning_code', [
778
789
  accessory_keypad_low_battery,
779
790
  unreliable_online_status,
780
791
  max_access_codes_reached,
792
+ subscription_required_for_additional_capabilities,
781
793
  cloud_recording_not_enabled,
782
794
  ])
783
795
 
@@ -817,6 +829,8 @@ export const device_warning_map = z.object({
817
829
  accessory_keypad_low_battery: accessory_keypad_low_battery.optional(),
818
830
  unreliable_online_status: unreliable_online_status.optional(),
819
831
  max_access_codes_reached: max_access_codes_reached.optional(),
832
+ subscription_required_for_additional_capabilities:
833
+ subscription_required_for_additional_capabilities.optional(),
820
834
  cloud_recording_not_enabled: cloud_recording_not_enabled.optional(),
821
835
  })
822
836
 
@@ -975,25 +989,25 @@ const sensor_measurements = z.object({
975
989
  `,
976
990
  )
977
991
  .optional(),
978
- is_occupied: z
992
+ is_occupancy_detected: z
979
993
  .boolean()
980
994
  .describe(
981
995
  `
982
996
  ---
983
997
  property_group_key: sensors
984
998
  ---
985
- Indicates whether the device detects that the space is occupied, if the device measures occupancy.
999
+ Indicates whether the device detects occupancy.
986
1000
  `,
987
1001
  )
988
1002
  .optional(),
989
- occupant_count: z
1003
+ estimated_occupant_count: z
990
1004
  .number()
991
1005
  .describe(
992
1006
  `
993
1007
  ---
994
1008
  property_group_key: sensors
995
1009
  ---
996
- Number of occupants the device detects, if the device counts occupants.
1010
+ Estimated number of occupants detected by the device.
997
1011
  `,
998
1012
  )
999
1013
  .optional(),
@@ -16182,6 +16182,7 @@ const openapi: OpenAPISpec = {
16182
16182
  'omnitec_lock',
16183
16183
  'kisi_lock',
16184
16184
  'aqara_lock',
16185
+ 'tuya_lock',
16185
16186
  'eufy_lock',
16186
16187
  ],
16187
16188
  type: 'string',
@@ -16813,6 +16814,13 @@ const openapi: OpenAPISpec = {
16813
16814
  thermostats: { name: 'Thermostats' },
16814
16815
  },
16815
16816
  },
16817
+ estimated_occupant_count: {
16818
+ description:
16819
+ 'Estimated number of occupants detected by the device.',
16820
+ format: 'float',
16821
+ type: 'number',
16822
+ 'x-property-group-key': 'sensors',
16823
+ },
16816
16824
  is_door_locked: {
16817
16825
  description: 'Indicates whether the lock is locked.',
16818
16826
  type: 'boolean',
@@ -16825,9 +16833,8 @@ const openapi: OpenAPISpec = {
16825
16833
  enum: [true],
16826
16834
  type: 'boolean',
16827
16835
  },
16828
- is_occupied: {
16829
- description:
16830
- 'Indicates whether the device detects that the space is occupied, if the device measures occupancy.',
16836
+ is_occupancy_detected: {
16837
+ description: 'Indicates whether the device detects occupancy.',
16831
16838
  type: 'boolean',
16832
16839
  'x-property-group-key': 'sensors',
16833
16840
  },
@@ -16922,9 +16929,16 @@ const openapi: OpenAPISpec = {
16922
16929
  type: 'string',
16923
16930
  'x-property-group-key': 'sensors',
16924
16931
  },
16925
- is_occupied: {
16932
+ estimated_occupant_count: {
16926
16933
  description:
16927
- 'Indicates whether the device detects that the space is occupied, if the device measures occupancy.',
16934
+ 'Estimated number of occupants detected by the device.',
16935
+ format: 'float',
16936
+ type: 'number',
16937
+ 'x-property-group-key': 'sensors',
16938
+ },
16939
+ is_occupancy_detected: {
16940
+ description:
16941
+ 'Indicates whether the device detects occupancy.',
16928
16942
  type: 'boolean',
16929
16943
  'x-property-group-key': 'sensors',
16930
16944
  },
@@ -16954,13 +16968,6 @@ const openapi: OpenAPISpec = {
16954
16968
  type: 'number',
16955
16969
  'x-property-group-key': 'sensors',
16956
16970
  },
16957
- occupant_count: {
16958
- description:
16959
- 'Number of occupants the device detects, if the device counts occupants.',
16960
- format: 'float',
16961
- type: 'number',
16962
- 'x-property-group-key': 'sensors',
16963
- },
16964
16971
  relative_humidity: {
16965
16972
  description:
16966
16973
  'Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity.',
@@ -17017,13 +17024,6 @@ const openapi: OpenAPISpec = {
17017
17024
  type: 'number',
17018
17025
  'x-property-group-key': 'sensors',
17019
17026
  },
17020
- occupant_count: {
17021
- description:
17022
- 'Number of occupants the device detects, if the device counts occupants.',
17023
- format: 'float',
17024
- type: 'number',
17025
- 'x-property-group-key': 'sensors',
17026
- },
17027
17027
  parent_device_id: {
17028
17028
  description:
17029
17029
  'ID of the parent device that this device belongs to, such as the pool controller of a pool or spa body of water. Omitted if the device does not have a parent.',
@@ -18791,6 +18791,44 @@ const openapi: OpenAPISpec = {
18791
18791
  },
18792
18792
  type: 'object',
18793
18793
  },
18794
+ tuya_metadata: {
18795
+ description: 'Metadata for a Tuya device.',
18796
+ properties: {
18797
+ category: {
18798
+ description:
18799
+ 'Tuya product category code for the device (e.g. ms).',
18800
+ type: 'string',
18801
+ },
18802
+ device_id: {
18803
+ description: 'Device ID for a Tuya device.',
18804
+ type: 'string',
18805
+ },
18806
+ device_name: {
18807
+ description: 'Device name for a Tuya device.',
18808
+ type: 'string',
18809
+ },
18810
+ model: {
18811
+ description: 'Model reported for a Tuya device.',
18812
+ nullable: true,
18813
+ type: 'string',
18814
+ },
18815
+ product_id: {
18816
+ description: 'Tuya product ID for the device.',
18817
+ type: 'string',
18818
+ },
18819
+ product_name: {
18820
+ description: 'Tuya product name for the device.',
18821
+ type: 'string',
18822
+ },
18823
+ time_zone: {
18824
+ description:
18825
+ 'Time zone reported for a Tuya device (e.g. +08:00).',
18826
+ nullable: true,
18827
+ type: 'string',
18828
+ },
18829
+ },
18830
+ type: 'object',
18831
+ },
18794
18832
  two_n_metadata: {
18795
18833
  description: 'Metadata for a 2N device.',
18796
18834
  properties: {
@@ -21124,6 +21162,34 @@ const openapi: OpenAPISpec = {
21124
21162
  'x-variant-group-key': 'access_codes',
21125
21163
  },
21126
21164
  {
21165
+ description:
21166
+ 'Indicates that a third-party subscription is required to enable additional device capabilities.',
21167
+ properties: {
21168
+ created_at: {
21169
+ description:
21170
+ 'Date and time at which Seam created the warning.',
21171
+ format: 'date-time',
21172
+ type: 'string',
21173
+ },
21174
+ message: {
21175
+ description:
21176
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
21177
+ type: 'string',
21178
+ },
21179
+ warning_code: {
21180
+ description:
21181
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
21182
+ enum: [
21183
+ 'subscription_required_for_additional_capabilities',
21184
+ ],
21185
+ type: 'string',
21186
+ },
21187
+ },
21188
+ required: ['message', 'created_at', 'warning_code'],
21189
+ type: 'object',
21190
+ },
21191
+ {
21192
+ deprecated: true,
21127
21193
  description:
21128
21194
  "Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable.",
21129
21195
  properties: {
@@ -21147,6 +21213,8 @@ const openapi: OpenAPISpec = {
21147
21213
  },
21148
21214
  required: ['message', 'created_at', 'warning_code'],
21149
21215
  type: 'object',
21216
+ 'x-deprecated':
21217
+ 'Use `subscription_required_for_additional_capabilities`.',
21150
21218
  },
21151
21219
  ],
21152
21220
  },
@@ -21440,6 +21508,7 @@ const openapi: OpenAPISpec = {
21440
21508
  'eufy',
21441
21509
  'sonos',
21442
21510
  'hayward_omnilogic',
21511
+ 'tuya',
21443
21512
  ],
21444
21513
  type: 'string',
21445
21514
  },
@@ -34882,6 +34951,34 @@ const openapi: OpenAPISpec = {
34882
34951
  'x-variant-group-key': 'access_codes',
34883
34952
  },
34884
34953
  {
34954
+ description:
34955
+ 'Indicates that a third-party subscription is required to enable additional device capabilities.',
34956
+ properties: {
34957
+ created_at: {
34958
+ description:
34959
+ 'Date and time at which Seam created the warning.',
34960
+ format: 'date-time',
34961
+ type: 'string',
34962
+ },
34963
+ message: {
34964
+ description:
34965
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
34966
+ type: 'string',
34967
+ },
34968
+ warning_code: {
34969
+ description:
34970
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
34971
+ enum: [
34972
+ 'subscription_required_for_additional_capabilities',
34973
+ ],
34974
+ type: 'string',
34975
+ },
34976
+ },
34977
+ required: ['message', 'created_at', 'warning_code'],
34978
+ type: 'object',
34979
+ },
34980
+ {
34981
+ deprecated: true,
34885
34982
  description:
34886
34983
  "Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable.",
34887
34984
  properties: {
@@ -34905,6 +35002,8 @@ const openapi: OpenAPISpec = {
34905
35002
  },
34906
35003
  required: ['message', 'created_at', 'warning_code'],
34907
35004
  type: 'object',
35005
+ 'x-deprecated':
35006
+ 'Use `subscription_required_for_additional_capabilities`.',
34908
35007
  },
34909
35008
  ],
34910
35009
  },
@@ -41893,6 +41992,7 @@ const openapi: OpenAPISpec = {
41893
41992
  'omnitec_lock',
41894
41993
  'kisi_lock',
41895
41994
  'aqara_lock',
41995
+ 'tuya_lock',
41896
41996
  'eufy_lock',
41897
41997
  ],
41898
41998
  type: 'string',
@@ -43498,6 +43598,34 @@ const openapi: OpenAPISpec = {
43498
43598
  'x-variant-group-key': 'access_codes',
43499
43599
  },
43500
43600
  {
43601
+ description:
43602
+ 'Indicates that a third-party subscription is required to enable additional device capabilities.',
43603
+ properties: {
43604
+ created_at: {
43605
+ description:
43606
+ 'Date and time at which Seam created the warning.',
43607
+ format: 'date-time',
43608
+ type: 'string',
43609
+ },
43610
+ message: {
43611
+ description:
43612
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
43613
+ type: 'string',
43614
+ },
43615
+ warning_code: {
43616
+ description:
43617
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
43618
+ enum: [
43619
+ 'subscription_required_for_additional_capabilities',
43620
+ ],
43621
+ type: 'string',
43622
+ },
43623
+ },
43624
+ required: ['message', 'created_at', 'warning_code'],
43625
+ type: 'object',
43626
+ },
43627
+ {
43628
+ deprecated: true,
43501
43629
  description:
43502
43630
  "Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable.",
43503
43631
  properties: {
@@ -43521,6 +43649,8 @@ const openapi: OpenAPISpec = {
43521
43649
  },
43522
43650
  required: ['message', 'created_at', 'warning_code'],
43523
43651
  type: 'object',
43652
+ 'x-deprecated':
43653
+ 'Use `subscription_required_for_additional_capabilities`.',
43524
43654
  },
43525
43655
  ],
43526
43656
  },
@@ -52886,6 +53016,7 @@ const openapi: OpenAPISpec = {
52886
53016
  'eufy',
52887
53017
  'sonos',
52888
53018
  'hayward_omnilogic',
53019
+ 'tuya',
52889
53020
  'hid_cm',
52890
53021
  'google_nest',
52891
53022
  'slack',
@@ -56812,6 +56943,7 @@ const openapi: OpenAPISpec = {
56812
56943
  'omnitec_lock',
56813
56944
  'kisi_lock',
56814
56945
  'aqara_lock',
56946
+ 'tuya_lock',
56815
56947
  'eufy_lock',
56816
56948
  ],
56817
56949
  type: 'string',
@@ -56919,6 +57051,7 @@ const openapi: OpenAPISpec = {
56919
57051
  'omnitec_lock',
56920
57052
  'kisi_lock',
56921
57053
  'aqara_lock',
57054
+ 'tuya_lock',
56922
57055
  'eufy_lock',
56923
57056
  ],
56924
57057
  type: 'string',
@@ -57052,6 +57185,7 @@ const openapi: OpenAPISpec = {
57052
57185
  'yacan',
57053
57186
  'sonos',
57054
57187
  'hayward_omnilogic',
57188
+ 'tuya',
57055
57189
  ],
57056
57190
  type: 'string',
57057
57191
  },
@@ -59209,6 +59343,7 @@ const openapi: OpenAPISpec = {
59209
59343
  'omnitec_lock',
59210
59344
  'kisi_lock',
59211
59345
  'aqara_lock',
59346
+ 'tuya_lock',
59212
59347
  'eufy_lock',
59213
59348
  ],
59214
59349
  type: 'string',
@@ -59316,6 +59451,7 @@ const openapi: OpenAPISpec = {
59316
59451
  'omnitec_lock',
59317
59452
  'kisi_lock',
59318
59453
  'aqara_lock',
59454
+ 'tuya_lock',
59319
59455
  'eufy_lock',
59320
59456
  ],
59321
59457
  type: 'string',
@@ -59449,6 +59585,7 @@ const openapi: OpenAPISpec = {
59449
59585
  'yacan',
59450
59586
  'sonos',
59451
59587
  'hayward_omnilogic',
59588
+ 'tuya',
59452
59589
  ],
59453
59590
  type: 'string',
59454
59591
  },
@@ -60817,6 +60954,7 @@ const openapi: OpenAPISpec = {
60817
60954
  'omnitec_lock',
60818
60955
  'kisi_lock',
60819
60956
  'aqara_lock',
60957
+ 'tuya_lock',
60820
60958
  'eufy_lock',
60821
60959
  ],
60822
60960
  type: 'string',
@@ -60864,6 +61002,7 @@ const openapi: OpenAPISpec = {
60864
61002
  'omnitec_lock',
60865
61003
  'kisi_lock',
60866
61004
  'aqara_lock',
61005
+ 'tuya_lock',
60867
61006
  'eufy_lock',
60868
61007
  ],
60869
61008
  type: 'string',
@@ -60913,6 +61052,7 @@ const openapi: OpenAPISpec = {
60913
61052
  'omnitec',
60914
61053
  'kisi',
60915
61054
  'yacan',
61055
+ 'tuya',
60916
61056
  ],
60917
61057
  type: 'string',
60918
61058
  },