@seamapi/types 1.1181.0 → 1.1182.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/events/devices.d.ts +234 -0
- package/lib/seam/connect/models/events/devices.js +27 -0
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +115 -1
- package/lib/seam/connect/openapi.js +225 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +396 -6
- package/package.json +1 -1
- package/src/lib/seam/connect/models/events/devices.ts +36 -0
- package/src/lib/seam/connect/openapi.ts +243 -0
- package/src/lib/seam/connect/route-types.ts +483 -0
|
@@ -633,6 +633,39 @@ export const lock_access_denied_event = device_event.extend({
|
|
|
633
633
|
|
|
634
634
|
export type LockAccessDeniedEvent = z.infer<typeof lock_access_denied_event>
|
|
635
635
|
|
|
636
|
+
export const lock_jammed_event = device_event.extend({
|
|
637
|
+
event_type: z.literal('lock.jammed'),
|
|
638
|
+
}).describe(`
|
|
639
|
+
---
|
|
640
|
+
route_path: /locks
|
|
641
|
+
---
|
|
642
|
+
The [lock](https://www.seam.co/docs/low-level-apis/smart-locks) reported that its bolt is jammed.
|
|
643
|
+
`)
|
|
644
|
+
|
|
645
|
+
export type LockJammedEvent = z.infer<typeof lock_jammed_event>
|
|
646
|
+
|
|
647
|
+
export const lock_door_opened_event = device_event.extend({
|
|
648
|
+
event_type: z.literal('lock.door_opened'),
|
|
649
|
+
}).describe(`
|
|
650
|
+
---
|
|
651
|
+
route_path: /locks
|
|
652
|
+
---
|
|
653
|
+
The door sensor of the [lock](https://www.seam.co/docs/low-level-apis/smart-locks) reported that the door was opened.
|
|
654
|
+
`)
|
|
655
|
+
|
|
656
|
+
export type LockDoorOpenedEvent = z.infer<typeof lock_door_opened_event>
|
|
657
|
+
|
|
658
|
+
export const lock_door_closed_event = device_event.extend({
|
|
659
|
+
event_type: z.literal('lock.door_closed'),
|
|
660
|
+
}).describe(`
|
|
661
|
+
---
|
|
662
|
+
route_path: /locks
|
|
663
|
+
---
|
|
664
|
+
The door sensor of the [lock](https://www.seam.co/docs/low-level-apis/smart-locks) reported that the door was closed.
|
|
665
|
+
`)
|
|
666
|
+
|
|
667
|
+
export type LockDoorClosedEvent = z.infer<typeof lock_door_closed_event>
|
|
668
|
+
|
|
636
669
|
export const thermostat_climate_preset_activated_event = device_event.extend({
|
|
637
670
|
event_type: z.literal('thermostat.climate_preset_activated'),
|
|
638
671
|
thermostat_schedule_id: z
|
|
@@ -925,6 +958,9 @@ export const device_events = [
|
|
|
925
958
|
lock_locked_event,
|
|
926
959
|
lock_unlocked_event,
|
|
927
960
|
lock_access_denied_event,
|
|
961
|
+
lock_jammed_event,
|
|
962
|
+
lock_door_opened_event,
|
|
963
|
+
lock_door_closed_event,
|
|
928
964
|
thermostat_climate_preset_activated_event,
|
|
929
965
|
thermostat_manually_adjusted_event,
|
|
930
966
|
temperature_threshold_exceeded_event,
|
|
@@ -30835,6 +30835,231 @@ const openapi: OpenAPISpec = {
|
|
|
30835
30835
|
type: 'object',
|
|
30836
30836
|
'x-route-path': '/locks',
|
|
30837
30837
|
},
|
|
30838
|
+
{
|
|
30839
|
+
description:
|
|
30840
|
+
'The [lock](https://www.seam.co/docs/low-level-apis/smart-locks) reported that its bolt is jammed.',
|
|
30841
|
+
properties: {
|
|
30842
|
+
connected_account_custom_metadata: {
|
|
30843
|
+
additionalProperties: {
|
|
30844
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
30845
|
+
},
|
|
30846
|
+
description:
|
|
30847
|
+
'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
30848
|
+
type: 'object',
|
|
30849
|
+
},
|
|
30850
|
+
connected_account_id: {
|
|
30851
|
+
description:
|
|
30852
|
+
'ID of the connected account associated with the event.',
|
|
30853
|
+
format: 'uuid',
|
|
30854
|
+
type: 'string',
|
|
30855
|
+
},
|
|
30856
|
+
created_at: {
|
|
30857
|
+
description: 'Date and time at which the event was created.',
|
|
30858
|
+
format: 'date-time',
|
|
30859
|
+
type: 'string',
|
|
30860
|
+
},
|
|
30861
|
+
customer_key: {
|
|
30862
|
+
description:
|
|
30863
|
+
'The customer key associated with the device, if any.',
|
|
30864
|
+
type: 'string',
|
|
30865
|
+
},
|
|
30866
|
+
device_custom_metadata: {
|
|
30867
|
+
additionalProperties: {
|
|
30868
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
30869
|
+
},
|
|
30870
|
+
description:
|
|
30871
|
+
'Custom metadata of the device, present when device_id is provided.',
|
|
30872
|
+
type: 'object',
|
|
30873
|
+
},
|
|
30874
|
+
device_id: {
|
|
30875
|
+
description: 'ID of the affected device.',
|
|
30876
|
+
format: 'uuid',
|
|
30877
|
+
type: 'string',
|
|
30878
|
+
},
|
|
30879
|
+
event_description: {
|
|
30880
|
+
description:
|
|
30881
|
+
'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.',
|
|
30882
|
+
type: 'string',
|
|
30883
|
+
},
|
|
30884
|
+
event_id: {
|
|
30885
|
+
description: 'ID of the event.',
|
|
30886
|
+
format: 'uuid',
|
|
30887
|
+
type: 'string',
|
|
30888
|
+
},
|
|
30889
|
+
event_type: { enum: ['lock.jammed'], type: 'string' },
|
|
30890
|
+
occurred_at: {
|
|
30891
|
+
description: 'Date and time at which the event occurred.',
|
|
30892
|
+
format: 'date-time',
|
|
30893
|
+
type: 'string',
|
|
30894
|
+
},
|
|
30895
|
+
workspace_id: {
|
|
30896
|
+
description: 'ID of the workspace associated with the event.',
|
|
30897
|
+
format: 'uuid',
|
|
30898
|
+
type: 'string',
|
|
30899
|
+
},
|
|
30900
|
+
},
|
|
30901
|
+
required: [
|
|
30902
|
+
'event_id',
|
|
30903
|
+
'workspace_id',
|
|
30904
|
+
'created_at',
|
|
30905
|
+
'occurred_at',
|
|
30906
|
+
'device_id',
|
|
30907
|
+
'connected_account_id',
|
|
30908
|
+
'event_type',
|
|
30909
|
+
],
|
|
30910
|
+
type: 'object',
|
|
30911
|
+
'x-route-path': '/locks',
|
|
30912
|
+
},
|
|
30913
|
+
{
|
|
30914
|
+
description:
|
|
30915
|
+
'The door sensor of the [lock](https://www.seam.co/docs/low-level-apis/smart-locks) reported that the door was opened.',
|
|
30916
|
+
properties: {
|
|
30917
|
+
connected_account_custom_metadata: {
|
|
30918
|
+
additionalProperties: {
|
|
30919
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
30920
|
+
},
|
|
30921
|
+
description:
|
|
30922
|
+
'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
30923
|
+
type: 'object',
|
|
30924
|
+
},
|
|
30925
|
+
connected_account_id: {
|
|
30926
|
+
description:
|
|
30927
|
+
'ID of the connected account associated with the event.',
|
|
30928
|
+
format: 'uuid',
|
|
30929
|
+
type: 'string',
|
|
30930
|
+
},
|
|
30931
|
+
created_at: {
|
|
30932
|
+
description: 'Date and time at which the event was created.',
|
|
30933
|
+
format: 'date-time',
|
|
30934
|
+
type: 'string',
|
|
30935
|
+
},
|
|
30936
|
+
customer_key: {
|
|
30937
|
+
description:
|
|
30938
|
+
'The customer key associated with the device, if any.',
|
|
30939
|
+
type: 'string',
|
|
30940
|
+
},
|
|
30941
|
+
device_custom_metadata: {
|
|
30942
|
+
additionalProperties: {
|
|
30943
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
30944
|
+
},
|
|
30945
|
+
description:
|
|
30946
|
+
'Custom metadata of the device, present when device_id is provided.',
|
|
30947
|
+
type: 'object',
|
|
30948
|
+
},
|
|
30949
|
+
device_id: {
|
|
30950
|
+
description: 'ID of the affected device.',
|
|
30951
|
+
format: 'uuid',
|
|
30952
|
+
type: 'string',
|
|
30953
|
+
},
|
|
30954
|
+
event_description: {
|
|
30955
|
+
description:
|
|
30956
|
+
'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.',
|
|
30957
|
+
type: 'string',
|
|
30958
|
+
},
|
|
30959
|
+
event_id: {
|
|
30960
|
+
description: 'ID of the event.',
|
|
30961
|
+
format: 'uuid',
|
|
30962
|
+
type: 'string',
|
|
30963
|
+
},
|
|
30964
|
+
event_type: { enum: ['lock.door_opened'], type: 'string' },
|
|
30965
|
+
occurred_at: {
|
|
30966
|
+
description: 'Date and time at which the event occurred.',
|
|
30967
|
+
format: 'date-time',
|
|
30968
|
+
type: 'string',
|
|
30969
|
+
},
|
|
30970
|
+
workspace_id: {
|
|
30971
|
+
description: 'ID of the workspace associated with the event.',
|
|
30972
|
+
format: 'uuid',
|
|
30973
|
+
type: 'string',
|
|
30974
|
+
},
|
|
30975
|
+
},
|
|
30976
|
+
required: [
|
|
30977
|
+
'event_id',
|
|
30978
|
+
'workspace_id',
|
|
30979
|
+
'created_at',
|
|
30980
|
+
'occurred_at',
|
|
30981
|
+
'device_id',
|
|
30982
|
+
'connected_account_id',
|
|
30983
|
+
'event_type',
|
|
30984
|
+
],
|
|
30985
|
+
type: 'object',
|
|
30986
|
+
'x-route-path': '/locks',
|
|
30987
|
+
},
|
|
30988
|
+
{
|
|
30989
|
+
description:
|
|
30990
|
+
'The door sensor of the [lock](https://www.seam.co/docs/low-level-apis/smart-locks) reported that the door was closed.',
|
|
30991
|
+
properties: {
|
|
30992
|
+
connected_account_custom_metadata: {
|
|
30993
|
+
additionalProperties: {
|
|
30994
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
30995
|
+
},
|
|
30996
|
+
description:
|
|
30997
|
+
'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
30998
|
+
type: 'object',
|
|
30999
|
+
},
|
|
31000
|
+
connected_account_id: {
|
|
31001
|
+
description:
|
|
31002
|
+
'ID of the connected account associated with the event.',
|
|
31003
|
+
format: 'uuid',
|
|
31004
|
+
type: 'string',
|
|
31005
|
+
},
|
|
31006
|
+
created_at: {
|
|
31007
|
+
description: 'Date and time at which the event was created.',
|
|
31008
|
+
format: 'date-time',
|
|
31009
|
+
type: 'string',
|
|
31010
|
+
},
|
|
31011
|
+
customer_key: {
|
|
31012
|
+
description:
|
|
31013
|
+
'The customer key associated with the device, if any.',
|
|
31014
|
+
type: 'string',
|
|
31015
|
+
},
|
|
31016
|
+
device_custom_metadata: {
|
|
31017
|
+
additionalProperties: {
|
|
31018
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
31019
|
+
},
|
|
31020
|
+
description:
|
|
31021
|
+
'Custom metadata of the device, present when device_id is provided.',
|
|
31022
|
+
type: 'object',
|
|
31023
|
+
},
|
|
31024
|
+
device_id: {
|
|
31025
|
+
description: 'ID of the affected device.',
|
|
31026
|
+
format: 'uuid',
|
|
31027
|
+
type: 'string',
|
|
31028
|
+
},
|
|
31029
|
+
event_description: {
|
|
31030
|
+
description:
|
|
31031
|
+
'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.',
|
|
31032
|
+
type: 'string',
|
|
31033
|
+
},
|
|
31034
|
+
event_id: {
|
|
31035
|
+
description: 'ID of the event.',
|
|
31036
|
+
format: 'uuid',
|
|
31037
|
+
type: 'string',
|
|
31038
|
+
},
|
|
31039
|
+
event_type: { enum: ['lock.door_closed'], type: 'string' },
|
|
31040
|
+
occurred_at: {
|
|
31041
|
+
description: 'Date and time at which the event occurred.',
|
|
31042
|
+
format: 'date-time',
|
|
31043
|
+
type: 'string',
|
|
31044
|
+
},
|
|
31045
|
+
workspace_id: {
|
|
31046
|
+
description: 'ID of the workspace associated with the event.',
|
|
31047
|
+
format: 'uuid',
|
|
31048
|
+
type: 'string',
|
|
31049
|
+
},
|
|
31050
|
+
},
|
|
31051
|
+
required: [
|
|
31052
|
+
'event_id',
|
|
31053
|
+
'workspace_id',
|
|
31054
|
+
'created_at',
|
|
31055
|
+
'occurred_at',
|
|
31056
|
+
'device_id',
|
|
31057
|
+
'connected_account_id',
|
|
31058
|
+
'event_type',
|
|
31059
|
+
],
|
|
31060
|
+
type: 'object',
|
|
31061
|
+
'x-route-path': '/locks',
|
|
31062
|
+
},
|
|
30838
31063
|
{
|
|
30839
31064
|
description:
|
|
30840
31065
|
'A thermostat [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.',
|
|
@@ -59186,6 +59411,9 @@ const openapi: OpenAPISpec = {
|
|
|
59186
59411
|
'lock.locked',
|
|
59187
59412
|
'lock.unlocked',
|
|
59188
59413
|
'lock.access_denied',
|
|
59414
|
+
'lock.jammed',
|
|
59415
|
+
'lock.door_opened',
|
|
59416
|
+
'lock.door_closed',
|
|
59189
59417
|
'thermostat.climate_preset_activated',
|
|
59190
59418
|
'thermostat.manually_adjusted',
|
|
59191
59419
|
'thermostat.temperature_threshold_exceeded',
|
|
@@ -59311,6 +59539,9 @@ const openapi: OpenAPISpec = {
|
|
|
59311
59539
|
'lock.locked',
|
|
59312
59540
|
'lock.unlocked',
|
|
59313
59541
|
'lock.access_denied',
|
|
59542
|
+
'lock.jammed',
|
|
59543
|
+
'lock.door_opened',
|
|
59544
|
+
'lock.door_closed',
|
|
59314
59545
|
'thermostat.climate_preset_activated',
|
|
59315
59546
|
'thermostat.manually_adjusted',
|
|
59316
59547
|
'thermostat.temperature_threshold_exceeded',
|
|
@@ -70990,6 +71221,9 @@ const openapi: OpenAPISpec = {
|
|
|
70990
71221
|
'lock.locked',
|
|
70991
71222
|
'lock.unlocked',
|
|
70992
71223
|
'lock.access_denied',
|
|
71224
|
+
'lock.jammed',
|
|
71225
|
+
'lock.door_opened',
|
|
71226
|
+
'lock.door_closed',
|
|
70993
71227
|
'thermostat.climate_preset_activated',
|
|
70994
71228
|
'thermostat.manually_adjusted',
|
|
70995
71229
|
'thermostat.temperature_threshold_exceeded',
|
|
@@ -71116,6 +71350,9 @@ const openapi: OpenAPISpec = {
|
|
|
71116
71350
|
'lock.locked',
|
|
71117
71351
|
'lock.unlocked',
|
|
71118
71352
|
'lock.access_denied',
|
|
71353
|
+
'lock.jammed',
|
|
71354
|
+
'lock.door_opened',
|
|
71355
|
+
'lock.door_closed',
|
|
71119
71356
|
'thermostat.climate_preset_activated',
|
|
71120
71357
|
'thermostat.manually_adjusted',
|
|
71121
71358
|
'thermostat.temperature_threshold_exceeded',
|
|
@@ -74803,6 +75040,9 @@ const openapi: OpenAPISpec = {
|
|
|
74803
75040
|
'lock.locked',
|
|
74804
75041
|
'lock.unlocked',
|
|
74805
75042
|
'lock.access_denied',
|
|
75043
|
+
'lock.jammed',
|
|
75044
|
+
'lock.door_opened',
|
|
75045
|
+
'lock.door_closed',
|
|
74806
75046
|
'thermostat.climate_preset_activated',
|
|
74807
75047
|
'thermostat.manually_adjusted',
|
|
74808
75048
|
'thermostat.temperature_threshold_exceeded',
|
|
@@ -75014,6 +75254,9 @@ const openapi: OpenAPISpec = {
|
|
|
75014
75254
|
'lock.locked',
|
|
75015
75255
|
'lock.unlocked',
|
|
75016
75256
|
'lock.access_denied',
|
|
75257
|
+
'lock.jammed',
|
|
75258
|
+
'lock.door_opened',
|
|
75259
|
+
'lock.door_closed',
|
|
75017
75260
|
'thermostat.climate_preset_activated',
|
|
75018
75261
|
'thermostat.manually_adjusted',
|
|
75019
75262
|
'thermostat.temperature_threshold_exceeded',
|