@seamapi/types 1.1196.0 → 1.1198.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/lib/seam/connect/models/devices/device.d.ts +80 -22
- package/lib/seam/connect/models/devices/device.js +19 -7
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.d.ts +21 -0
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +29 -8
- package/lib/seam/connect/models/events/devices.d.ts +6 -6
- package/lib/seam/connect/models/events/devices.js +4 -3
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +3 -3
- package/lib/seam/connect/openapi.js +95 -22
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +322 -154
- package/package.json +1 -1
- package/src/lib/seam/connect/models/devices/device.ts +21 -7
- package/src/lib/seam/connect/models/events/devices.ts +4 -3
- package/src/lib/seam/connect/openapi.ts +113 -25
- package/src/lib/seam/connect/route-types.ts +346 -154
package/package.json
CHANGED
|
@@ -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
|
|
741
|
+
const subscription_required_for_additional_capabilities = common_device_warning
|
|
742
742
|
.extend({
|
|
743
743
|
warning_code: z
|
|
744
|
-
.literal('
|
|
744
|
+
.literal('subscription_required_for_additional_capabilities')
|
|
745
745
|
.describe(warning_code_description),
|
|
746
746
|
})
|
|
747
747
|
.describe(
|
|
748
|
-
|
|
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
|
-
|
|
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
|
|
999
|
+
Indicates whether the device detects occupancy.
|
|
986
1000
|
`,
|
|
987
1001
|
)
|
|
988
1002
|
.optional(),
|
|
989
|
-
|
|
1003
|
+
estimated_occupant_count: z
|
|
990
1004
|
.number()
|
|
991
1005
|
.describe(
|
|
992
1006
|
`
|
|
993
1007
|
---
|
|
994
1008
|
property_group_key: sensors
|
|
995
1009
|
---
|
|
996
|
-
|
|
1010
|
+
Estimated number of occupants detected by the device.
|
|
997
1011
|
`,
|
|
998
1012
|
)
|
|
999
1013
|
.optional(),
|
|
@@ -868,9 +868,10 @@ export type DeviceNameChangedEvent = z.infer<typeof device_name_changed_event>
|
|
|
868
868
|
|
|
869
869
|
export const camera_activated_event = device_event.extend({
|
|
870
870
|
event_type: z.literal('camera.activated'),
|
|
871
|
-
|
|
872
|
-
.
|
|
873
|
-
.
|
|
871
|
+
is_motion_detected: z
|
|
872
|
+
.boolean()
|
|
873
|
+
.optional()
|
|
874
|
+
.describe('Whether motion detection activated the camera, if known.'),
|
|
874
875
|
motion_sub_type: z
|
|
875
876
|
.enum(['human', 'vehicle', 'package', 'other'])
|
|
876
877
|
.optional()
|
|
@@ -16813,6 +16813,13 @@ const openapi: OpenAPISpec = {
|
|
|
16813
16813
|
thermostats: { name: 'Thermostats' },
|
|
16814
16814
|
},
|
|
16815
16815
|
},
|
|
16816
|
+
estimated_occupant_count: {
|
|
16817
|
+
description:
|
|
16818
|
+
'Estimated number of occupants detected by the device.',
|
|
16819
|
+
format: 'float',
|
|
16820
|
+
type: 'number',
|
|
16821
|
+
'x-property-group-key': 'sensors',
|
|
16822
|
+
},
|
|
16816
16823
|
is_door_locked: {
|
|
16817
16824
|
description: 'Indicates whether the lock is locked.',
|
|
16818
16825
|
type: 'boolean',
|
|
@@ -16825,9 +16832,8 @@ const openapi: OpenAPISpec = {
|
|
|
16825
16832
|
enum: [true],
|
|
16826
16833
|
type: 'boolean',
|
|
16827
16834
|
},
|
|
16828
|
-
|
|
16829
|
-
description:
|
|
16830
|
-
'Indicates whether the device detects that the space is occupied, if the device measures occupancy.',
|
|
16835
|
+
is_occupancy_detected: {
|
|
16836
|
+
description: 'Indicates whether the device detects occupancy.',
|
|
16831
16837
|
type: 'boolean',
|
|
16832
16838
|
'x-property-group-key': 'sensors',
|
|
16833
16839
|
},
|
|
@@ -16922,9 +16928,16 @@ const openapi: OpenAPISpec = {
|
|
|
16922
16928
|
type: 'string',
|
|
16923
16929
|
'x-property-group-key': 'sensors',
|
|
16924
16930
|
},
|
|
16925
|
-
|
|
16931
|
+
estimated_occupant_count: {
|
|
16932
|
+
description:
|
|
16933
|
+
'Estimated number of occupants detected by the device.',
|
|
16934
|
+
format: 'float',
|
|
16935
|
+
type: 'number',
|
|
16936
|
+
'x-property-group-key': 'sensors',
|
|
16937
|
+
},
|
|
16938
|
+
is_occupancy_detected: {
|
|
16926
16939
|
description:
|
|
16927
|
-
'Indicates whether the device detects
|
|
16940
|
+
'Indicates whether the device detects occupancy.',
|
|
16928
16941
|
type: 'boolean',
|
|
16929
16942
|
'x-property-group-key': 'sensors',
|
|
16930
16943
|
},
|
|
@@ -16954,13 +16967,6 @@ const openapi: OpenAPISpec = {
|
|
|
16954
16967
|
type: 'number',
|
|
16955
16968
|
'x-property-group-key': 'sensors',
|
|
16956
16969
|
},
|
|
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
16970
|
relative_humidity: {
|
|
16965
16971
|
description:
|
|
16966
16972
|
'Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity.',
|
|
@@ -17017,13 +17023,6 @@ const openapi: OpenAPISpec = {
|
|
|
17017
17023
|
type: 'number',
|
|
17018
17024
|
'x-property-group-key': 'sensors',
|
|
17019
17025
|
},
|
|
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
17026
|
parent_device_id: {
|
|
17028
17027
|
description:
|
|
17029
17028
|
'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.',
|
|
@@ -21124,6 +21123,34 @@ const openapi: OpenAPISpec = {
|
|
|
21124
21123
|
'x-variant-group-key': 'access_codes',
|
|
21125
21124
|
},
|
|
21126
21125
|
{
|
|
21126
|
+
description:
|
|
21127
|
+
'Indicates that a third-party subscription is required to enable additional device capabilities.',
|
|
21128
|
+
properties: {
|
|
21129
|
+
created_at: {
|
|
21130
|
+
description:
|
|
21131
|
+
'Date and time at which Seam created the warning.',
|
|
21132
|
+
format: 'date-time',
|
|
21133
|
+
type: 'string',
|
|
21134
|
+
},
|
|
21135
|
+
message: {
|
|
21136
|
+
description:
|
|
21137
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
21138
|
+
type: 'string',
|
|
21139
|
+
},
|
|
21140
|
+
warning_code: {
|
|
21141
|
+
description:
|
|
21142
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
21143
|
+
enum: [
|
|
21144
|
+
'subscription_required_for_additional_capabilities',
|
|
21145
|
+
],
|
|
21146
|
+
type: 'string',
|
|
21147
|
+
},
|
|
21148
|
+
},
|
|
21149
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
21150
|
+
type: 'object',
|
|
21151
|
+
},
|
|
21152
|
+
{
|
|
21153
|
+
deprecated: true,
|
|
21127
21154
|
description:
|
|
21128
21155
|
"Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable.",
|
|
21129
21156
|
properties: {
|
|
@@ -21147,6 +21174,8 @@ const openapi: OpenAPISpec = {
|
|
|
21147
21174
|
},
|
|
21148
21175
|
required: ['message', 'created_at', 'warning_code'],
|
|
21149
21176
|
type: 'object',
|
|
21177
|
+
'x-deprecated':
|
|
21178
|
+
'Use `subscription_required_for_additional_capabilities`.',
|
|
21150
21179
|
},
|
|
21151
21180
|
],
|
|
21152
21181
|
},
|
|
@@ -32361,11 +32390,6 @@ const openapi: OpenAPISpec = {
|
|
|
32361
32390
|
description:
|
|
32362
32391
|
'A camera was activated, for example, by motion detection. For Ring cameras, this event is available only in the Seam Console, not through the API or webhooks.',
|
|
32363
32392
|
properties: {
|
|
32364
|
-
activation_reason: {
|
|
32365
|
-
description: 'The reason the camera was activated.',
|
|
32366
|
-
enum: ['motion_detected'],
|
|
32367
|
-
type: 'string',
|
|
32368
|
-
},
|
|
32369
32393
|
connected_account_custom_metadata: {
|
|
32370
32394
|
additionalProperties: {
|
|
32371
32395
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
@@ -32420,6 +32444,11 @@ const openapi: OpenAPISpec = {
|
|
|
32420
32444
|
format: 'uri',
|
|
32421
32445
|
type: 'string',
|
|
32422
32446
|
},
|
|
32447
|
+
is_motion_detected: {
|
|
32448
|
+
description:
|
|
32449
|
+
'Whether motion detection activated the camera, if known.',
|
|
32450
|
+
type: 'boolean',
|
|
32451
|
+
},
|
|
32423
32452
|
media_ids: {
|
|
32424
32453
|
description:
|
|
32425
32454
|
'IDs of the media, such as a video clip and a thumbnail image, captured for this activation. Use `/media/get` to retrieve each one.',
|
|
@@ -32456,7 +32485,6 @@ const openapi: OpenAPISpec = {
|
|
|
32456
32485
|
'device_id',
|
|
32457
32486
|
'connected_account_id',
|
|
32458
32487
|
'event_type',
|
|
32459
|
-
'activation_reason',
|
|
32460
32488
|
],
|
|
32461
32489
|
type: 'object',
|
|
32462
32490
|
'x-route-path': '/devices',
|
|
@@ -34883,6 +34911,34 @@ const openapi: OpenAPISpec = {
|
|
|
34883
34911
|
'x-variant-group-key': 'access_codes',
|
|
34884
34912
|
},
|
|
34885
34913
|
{
|
|
34914
|
+
description:
|
|
34915
|
+
'Indicates that a third-party subscription is required to enable additional device capabilities.',
|
|
34916
|
+
properties: {
|
|
34917
|
+
created_at: {
|
|
34918
|
+
description:
|
|
34919
|
+
'Date and time at which Seam created the warning.',
|
|
34920
|
+
format: 'date-time',
|
|
34921
|
+
type: 'string',
|
|
34922
|
+
},
|
|
34923
|
+
message: {
|
|
34924
|
+
description:
|
|
34925
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
34926
|
+
type: 'string',
|
|
34927
|
+
},
|
|
34928
|
+
warning_code: {
|
|
34929
|
+
description:
|
|
34930
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
34931
|
+
enum: [
|
|
34932
|
+
'subscription_required_for_additional_capabilities',
|
|
34933
|
+
],
|
|
34934
|
+
type: 'string',
|
|
34935
|
+
},
|
|
34936
|
+
},
|
|
34937
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
34938
|
+
type: 'object',
|
|
34939
|
+
},
|
|
34940
|
+
{
|
|
34941
|
+
deprecated: true,
|
|
34886
34942
|
description:
|
|
34887
34943
|
"Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable.",
|
|
34888
34944
|
properties: {
|
|
@@ -34906,6 +34962,8 @@ const openapi: OpenAPISpec = {
|
|
|
34906
34962
|
},
|
|
34907
34963
|
required: ['message', 'created_at', 'warning_code'],
|
|
34908
34964
|
type: 'object',
|
|
34965
|
+
'x-deprecated':
|
|
34966
|
+
'Use `subscription_required_for_additional_capabilities`.',
|
|
34909
34967
|
},
|
|
34910
34968
|
],
|
|
34911
34969
|
},
|
|
@@ -43499,6 +43557,34 @@ const openapi: OpenAPISpec = {
|
|
|
43499
43557
|
'x-variant-group-key': 'access_codes',
|
|
43500
43558
|
},
|
|
43501
43559
|
{
|
|
43560
|
+
description:
|
|
43561
|
+
'Indicates that a third-party subscription is required to enable additional device capabilities.',
|
|
43562
|
+
properties: {
|
|
43563
|
+
created_at: {
|
|
43564
|
+
description:
|
|
43565
|
+
'Date and time at which Seam created the warning.',
|
|
43566
|
+
format: 'date-time',
|
|
43567
|
+
type: 'string',
|
|
43568
|
+
},
|
|
43569
|
+
message: {
|
|
43570
|
+
description:
|
|
43571
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
43572
|
+
type: 'string',
|
|
43573
|
+
},
|
|
43574
|
+
warning_code: {
|
|
43575
|
+
description:
|
|
43576
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
43577
|
+
enum: [
|
|
43578
|
+
'subscription_required_for_additional_capabilities',
|
|
43579
|
+
],
|
|
43580
|
+
type: 'string',
|
|
43581
|
+
},
|
|
43582
|
+
},
|
|
43583
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
43584
|
+
type: 'object',
|
|
43585
|
+
},
|
|
43586
|
+
{
|
|
43587
|
+
deprecated: true,
|
|
43502
43588
|
description:
|
|
43503
43589
|
"Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable.",
|
|
43504
43590
|
properties: {
|
|
@@ -43522,6 +43608,8 @@ const openapi: OpenAPISpec = {
|
|
|
43522
43608
|
},
|
|
43523
43609
|
required: ['message', 'created_at', 'warning_code'],
|
|
43524
43610
|
type: 'object',
|
|
43611
|
+
'x-deprecated':
|
|
43612
|
+
'Use `subscription_required_for_additional_capabilities`.',
|
|
43525
43613
|
},
|
|
43526
43614
|
],
|
|
43527
43615
|
},
|