@seamapi/types 1.977.0 → 1.979.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 (38) hide show
  1. package/dist/connect.cjs +185 -22
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +722 -57
  4. package/dist/index.cjs +185 -22
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-entrance.d.ts +49 -0
  7. package/lib/seam/connect/models/acs/acs-entrance.js +4 -0
  8. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  9. package/lib/seam/connect/models/acs/acs-system.d.ts +7 -7
  10. package/lib/seam/connect/models/acs/acs-system.js +1 -0
  11. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  12. package/lib/seam/connect/models/acs/metadata/akiles.d.ts +33 -0
  13. package/lib/seam/connect/models/acs/metadata/akiles.js +25 -0
  14. package/lib/seam/connect/models/acs/metadata/akiles.js.map +1 -0
  15. package/lib/seam/connect/models/devices/device-metadata.d.ts +48 -0
  16. package/lib/seam/connect/models/devices/device-metadata.js +40 -0
  17. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  18. package/lib/seam/connect/models/devices/device-provider.d.ts +2 -1
  19. package/lib/seam/connect/models/devices/device-provider.js +2 -1
  20. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  21. package/lib/seam/connect/models/devices/device-type.d.ts +1 -0
  22. package/lib/seam/connect/models/devices/device-type.js +1 -0
  23. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  24. package/lib/seam/connect/models/devices/device.d.ts +71 -3
  25. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +51 -3
  26. package/lib/seam/connect/models/phones/phone-session.d.ts +188 -0
  27. package/lib/seam/connect/openapi.js +136 -0
  28. package/lib/seam/connect/openapi.js.map +1 -1
  29. package/lib/seam/connect/route-types.d.ts +544 -45
  30. package/package.json +1 -1
  31. package/src/lib/seam/connect/models/acs/acs-entrance.ts +6 -0
  32. package/src/lib/seam/connect/models/acs/acs-system.ts +1 -0
  33. package/src/lib/seam/connect/models/acs/metadata/akiles.ts +31 -0
  34. package/src/lib/seam/connect/models/devices/device-metadata.ts +41 -0
  35. package/src/lib/seam/connect/models/devices/device-provider.ts +2 -1
  36. package/src/lib/seam/connect/models/devices/device-type.ts +1 -0
  37. package/src/lib/seam/connect/openapi.ts +147 -0
  38. package/src/lib/seam/connect/route-types.ts +663 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.977.0",
3
+ "version": "1.979.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -1,5 +1,6 @@
1
1
  import { z } from 'zod'
2
2
 
3
+ import { acs_entrance_akiles_metadata } from './metadata/akiles.js'
3
4
  import { acs_entrance_avigilon_alta_metadata } from './metadata/avigilon-alta.js'
4
5
  import { acs_entrance_dormakaba_ambiance_metadata } from './metadata/dormakaba-ambiance.js'
5
6
  import {
@@ -244,6 +245,11 @@ export const acs_entrance = z
244
245
  .describe(
245
246
  'Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).',
246
247
  ),
248
+ akiles_metadata: acs_entrance_akiles_metadata
249
+ .optional()
250
+ .describe(
251
+ 'Akiles-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).',
252
+ ),
247
253
  is_locked: z
248
254
  .boolean()
249
255
  .optional()
@@ -32,6 +32,7 @@ export const acs_system_external_type = z.enum([
32
32
  'assa_abloy_vostio_credential_service',
33
33
  'hotek_site',
34
34
  'kisi_organization',
35
+ 'akiles_organization',
35
36
  ])
36
37
 
37
38
  export type AcsSystemExternalType = z.infer<typeof acs_system_external_type>
@@ -0,0 +1,31 @@
1
+ import { z } from 'zod'
2
+
3
+ export const acs_entrance_akiles_metadata = z
4
+ .object({
5
+ gadget_id: z.string().optional().describe('ID of the Akiles gadget.'),
6
+ site_id: z
7
+ .string()
8
+ .optional()
9
+ .describe('ID of the Akiles site the gadget belongs to.'),
10
+ site_name: z
11
+ .string()
12
+ .optional()
13
+ .describe('Name of the Akiles site the gadget belongs to.'),
14
+ actions: z
15
+ .array(
16
+ z
17
+ .object({
18
+ id: z.string().optional().describe('ID of the gadget action.'),
19
+ name: z.string().optional().describe('Name of the gadget action.'),
20
+ })
21
+ .partial(),
22
+ )
23
+ .optional()
24
+ .describe('Actions the gadget exposes (for example, open).'),
25
+ })
26
+ .partial()
27
+ .describe('Akiles-specific metadata for the entrance.')
28
+
29
+ export type AcsEntranceAkilesMetadata = z.infer<
30
+ typeof acs_entrance_akiles_metadata
31
+ >
@@ -1162,6 +1162,47 @@ export const device_metadata = z
1162
1162
  })
1163
1163
  .partial()
1164
1164
  .describe(`Metadata for a Kisi device.`),
1165
+
1166
+ aqara_metadata: z
1167
+ .object({
1168
+ did: z
1169
+ .string()
1170
+ .optional()
1171
+ .describe(`Device ID (did) for an Aqara device.`),
1172
+ parent_did: z
1173
+ .string()
1174
+ .optional()
1175
+ .describe(`Parent gateway device ID for an Aqara device.`),
1176
+ device_name: z
1177
+ .string()
1178
+ .optional()
1179
+ .describe(`Device name for an Aqara device.`),
1180
+ model: z
1181
+ .string()
1182
+ .optional()
1183
+ .describe(`Model identifier for an Aqara device.`),
1184
+ model_type: z
1185
+ .number()
1186
+ .optional()
1187
+ .describe(`Model type for an Aqara device.`),
1188
+ time_zone: z
1189
+ .string()
1190
+ .nullable()
1191
+ .optional()
1192
+ .describe(`Time zone reported for an Aqara device (e.g. GMT-07:00).`),
1193
+ position_id: z
1194
+ .string()
1195
+ .nullable()
1196
+ .optional()
1197
+ .describe(`Position (room) ID for an Aqara device.`),
1198
+ firmware_version: z
1199
+ .string()
1200
+ .nullable()
1201
+ .optional()
1202
+ .describe(`Firmware version for an Aqara device.`),
1203
+ })
1204
+ .partial()
1205
+ .describe(`Metadata for an Aqara device.`),
1165
1206
  })
1166
1207
  .partial().describe(`
1167
1208
  ---
@@ -66,6 +66,7 @@ export const DEVICE_PROVIDERS = {
66
66
  ACUITY_SCHEDULING: 'acuity_scheduling',
67
67
  OMNITEC: 'omnitec',
68
68
  KISI: 'kisi',
69
+ AQARA: 'aqara',
69
70
  } as const
70
71
 
71
72
  export type DeviceProviderName =
@@ -145,7 +146,7 @@ export const PROVIDER_CATEGORY_MAP = {
145
146
  'thirty_three_lock',
146
147
  ],
147
148
 
148
- beta: ['salto_ks_accept'],
149
+ beta: ['salto_ks_accept', 'aqara'],
149
150
 
150
151
  thermostats: ['ecobee', 'nest', 'sensi', 'honeywell_resideo', 'first_alert'],
151
152
  noise_sensors: ['minut', 'noiseaware'],
@@ -31,6 +31,7 @@ export const LOCK_DEVICE_TYPE = {
31
31
  KEYINCODE_LOCK: 'keyincode_lock',
32
32
  OMNITEC_LOCK: 'omnitec_lock',
33
33
  KISI_LOCK: 'kisi_lock',
34
+ AQARA_LOCK: 'aqara_lock',
34
35
  } as const
35
36
 
36
37
  type LockDeviceTypeFromMapping =
@@ -3848,6 +3848,42 @@ const openapi: OpenAPISpec = {
3848
3848
  format: 'uuid',
3849
3849
  type: 'string',
3850
3850
  },
3851
+ akiles_metadata: {
3852
+ description:
3853
+ 'Akiles-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).',
3854
+ properties: {
3855
+ actions: {
3856
+ description: 'Actions the gadget exposes (for example, open).',
3857
+ items: {
3858
+ properties: {
3859
+ id: {
3860
+ description: 'ID of the gadget action.',
3861
+ type: 'string',
3862
+ },
3863
+ name: {
3864
+ description: 'Name of the gadget action.',
3865
+ type: 'string',
3866
+ },
3867
+ },
3868
+ type: 'object',
3869
+ },
3870
+ type: 'array',
3871
+ },
3872
+ gadget_id: {
3873
+ description: 'ID of the Akiles gadget.',
3874
+ type: 'string',
3875
+ },
3876
+ site_id: {
3877
+ description: 'ID of the Akiles site the gadget belongs to.',
3878
+ type: 'string',
3879
+ },
3880
+ site_name: {
3881
+ description: 'Name of the Akiles site the gadget belongs to.',
3882
+ type: 'string',
3883
+ },
3884
+ },
3885
+ type: 'object',
3886
+ },
3851
3887
  assa_abloy_vostio_metadata: {
3852
3888
  description:
3853
3889
  'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).',
@@ -4652,6 +4688,7 @@ const openapi: OpenAPISpec = {
4652
4688
  'assa_abloy_vostio_credential_service',
4653
4689
  'hotek_site',
4654
4690
  'kisi_organization',
4691
+ 'akiles_organization',
4655
4692
  ],
4656
4693
  type: 'string',
4657
4694
  },
@@ -4713,6 +4750,7 @@ const openapi: OpenAPISpec = {
4713
4750
  'assa_abloy_vostio_credential_service',
4714
4751
  'hotek_site',
4715
4752
  'kisi_organization',
4753
+ 'akiles_organization',
4716
4754
  ],
4717
4755
  type: 'string',
4718
4756
  'x-deprecated': 'Use `external_type`.',
@@ -13000,6 +13038,7 @@ const openapi: OpenAPISpec = {
13000
13038
  'keyincode_lock',
13001
13039
  'omnitec_lock',
13002
13040
  'kisi_lock',
13041
+ 'aqara_lock',
13003
13042
  ],
13004
13043
  type: 'string',
13005
13044
  },
@@ -13891,6 +13930,53 @@ const openapi: OpenAPISpec = {
13891
13930
  },
13892
13931
  type: 'object',
13893
13932
  },
13933
+ aqara_metadata: {
13934
+ description: 'Metadata for an Aqara device.',
13935
+ properties: {
13936
+ device_name: {
13937
+ description: 'Device name for an Aqara device.',
13938
+ type: 'string',
13939
+ },
13940
+ did: {
13941
+ description: 'Device ID (did) for an Aqara device.',
13942
+ type: 'string',
13943
+ },
13944
+ firmware_version: {
13945
+ description:
13946
+ 'Firmware version for an Aqara device.',
13947
+ nullable: true,
13948
+ type: 'string',
13949
+ },
13950
+ model: {
13951
+ description:
13952
+ 'Model identifier for an Aqara device.',
13953
+ type: 'string',
13954
+ },
13955
+ model_type: {
13956
+ description: 'Model type for an Aqara device.',
13957
+ format: 'float',
13958
+ type: 'number',
13959
+ },
13960
+ parent_did: {
13961
+ description:
13962
+ 'Parent gateway device ID for an Aqara device.',
13963
+ type: 'string',
13964
+ },
13965
+ position_id: {
13966
+ description:
13967
+ 'Position (room) ID for an Aqara device.',
13968
+ nullable: true,
13969
+ type: 'string',
13970
+ },
13971
+ time_zone: {
13972
+ description:
13973
+ 'Time zone reported for an Aqara device (e.g. GMT-07:00).',
13974
+ nullable: true,
13975
+ type: 'string',
13976
+ },
13977
+ },
13978
+ type: 'object',
13979
+ },
13894
13980
  assa_abloy_vostio_metadata: {
13895
13981
  description:
13896
13982
  'Metadata for an ASSA ABLOY Vostio system.',
@@ -17305,6 +17391,7 @@ const openapi: OpenAPISpec = {
17305
17391
  'acuity_scheduling',
17306
17392
  'omnitec',
17307
17393
  'kisi',
17394
+ 'aqara',
17308
17395
  ],
17309
17396
  type: 'string',
17310
17397
  },
@@ -27776,6 +27863,46 @@ const openapi: OpenAPISpec = {
27776
27863
  format: 'uuid',
27777
27864
  type: 'string',
27778
27865
  },
27866
+ akiles_metadata: {
27867
+ description:
27868
+ 'Akiles-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).',
27869
+ properties: {
27870
+ actions: {
27871
+ description:
27872
+ 'Actions the gadget exposes (for example, open).',
27873
+ items: {
27874
+ properties: {
27875
+ id: {
27876
+ description: 'ID of the gadget action.',
27877
+ type: 'string',
27878
+ },
27879
+ name: {
27880
+ description:
27881
+ 'Name of the gadget action.',
27882
+ type: 'string',
27883
+ },
27884
+ },
27885
+ type: 'object',
27886
+ },
27887
+ type: 'array',
27888
+ },
27889
+ gadget_id: {
27890
+ description: 'ID of the Akiles gadget.',
27891
+ type: 'string',
27892
+ },
27893
+ site_id: {
27894
+ description:
27895
+ 'ID of the Akiles site the gadget belongs to.',
27896
+ type: 'string',
27897
+ },
27898
+ site_name: {
27899
+ description:
27900
+ 'Name of the Akiles site the gadget belongs to.',
27901
+ type: 'string',
27902
+ },
27903
+ },
27904
+ type: 'object',
27905
+ },
27779
27906
  assa_abloy_vostio_metadata: {
27780
27907
  description:
27781
27908
  'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).',
@@ -32778,6 +32905,7 @@ const openapi: OpenAPISpec = {
32778
32905
  'keyincode_lock',
32779
32906
  'omnitec_lock',
32780
32907
  'kisi_lock',
32908
+ 'aqara_lock',
32781
32909
  ],
32782
32910
  type: 'string',
32783
32911
  },
@@ -53205,6 +53333,7 @@ const openapi: OpenAPISpec = {
53205
53333
  'acuity_scheduling',
53206
53334
  'omnitec',
53207
53335
  'kisi',
53336
+ 'aqara',
53208
53337
  'yale_access',
53209
53338
  'hid_cm',
53210
53339
  'google_nest',
@@ -57581,6 +57710,7 @@ const openapi: OpenAPISpec = {
57581
57710
  'keyincode_lock',
57582
57711
  'omnitec_lock',
57583
57712
  'kisi_lock',
57713
+ 'aqara_lock',
57584
57714
  ],
57585
57715
  type: 'string',
57586
57716
  },
@@ -57659,6 +57789,7 @@ const openapi: OpenAPISpec = {
57659
57789
  'keyincode_lock',
57660
57790
  'omnitec_lock',
57661
57791
  'kisi_lock',
57792
+ 'aqara_lock',
57662
57793
  ],
57663
57794
  type: 'string',
57664
57795
  },
@@ -57735,6 +57866,7 @@ const openapi: OpenAPISpec = {
57735
57866
  'tedee',
57736
57867
  'keyincode',
57737
57868
  'akiles',
57869
+ 'aqara',
57738
57870
  'ecobee',
57739
57871
  'honeywell_resideo',
57740
57872
  'keynest',
@@ -58047,6 +58179,7 @@ const openapi: OpenAPISpec = {
58047
58179
  'keyincode_lock',
58048
58180
  'omnitec_lock',
58049
58181
  'kisi_lock',
58182
+ 'aqara_lock',
58050
58183
  ],
58051
58184
  type: 'string',
58052
58185
  },
@@ -58123,6 +58256,7 @@ const openapi: OpenAPISpec = {
58123
58256
  'keyincode_lock',
58124
58257
  'omnitec_lock',
58125
58258
  'kisi_lock',
58259
+ 'aqara_lock',
58126
58260
  ],
58127
58261
  type: 'string',
58128
58262
  },
@@ -58263,6 +58397,7 @@ const openapi: OpenAPISpec = {
58263
58397
  'tedee',
58264
58398
  'keyincode',
58265
58399
  'akiles',
58400
+ 'aqara',
58266
58401
  'ecobee',
58267
58402
  'honeywell_resideo',
58268
58403
  'keynest',
@@ -60399,6 +60534,7 @@ const openapi: OpenAPISpec = {
60399
60534
  'keyincode_lock',
60400
60535
  'omnitec_lock',
60401
60536
  'kisi_lock',
60537
+ 'aqara_lock',
60402
60538
  ],
60403
60539
  type: 'string',
60404
60540
  },
@@ -60477,6 +60613,7 @@ const openapi: OpenAPISpec = {
60477
60613
  'keyincode_lock',
60478
60614
  'omnitec_lock',
60479
60615
  'kisi_lock',
60616
+ 'aqara_lock',
60480
60617
  ],
60481
60618
  type: 'string',
60482
60619
  },
@@ -60553,6 +60690,7 @@ const openapi: OpenAPISpec = {
60553
60690
  'tedee',
60554
60691
  'keyincode',
60555
60692
  'akiles',
60693
+ 'aqara',
60556
60694
  'ecobee',
60557
60695
  'honeywell_resideo',
60558
60696
  'keynest',
@@ -60864,6 +61002,7 @@ const openapi: OpenAPISpec = {
60864
61002
  'keyincode_lock',
60865
61003
  'omnitec_lock',
60866
61004
  'kisi_lock',
61005
+ 'aqara_lock',
60867
61006
  ],
60868
61007
  type: 'string',
60869
61008
  },
@@ -60940,6 +61079,7 @@ const openapi: OpenAPISpec = {
60940
61079
  'keyincode_lock',
60941
61080
  'omnitec_lock',
60942
61081
  'kisi_lock',
61082
+ 'aqara_lock',
60943
61083
  ],
60944
61084
  type: 'string',
60945
61085
  },
@@ -61080,6 +61220,7 @@ const openapi: OpenAPISpec = {
61080
61220
  'tedee',
61081
61221
  'keyincode',
61082
61222
  'akiles',
61223
+ 'aqara',
61083
61224
  'ecobee',
61084
61225
  'honeywell_resideo',
61085
61226
  'keynest',
@@ -63236,6 +63377,7 @@ const openapi: OpenAPISpec = {
63236
63377
  'keyincode_lock',
63237
63378
  'omnitec_lock',
63238
63379
  'kisi_lock',
63380
+ 'aqara_lock',
63239
63381
  ],
63240
63382
  type: 'string',
63241
63383
  },
@@ -63277,6 +63419,7 @@ const openapi: OpenAPISpec = {
63277
63419
  'keyincode_lock',
63278
63420
  'omnitec_lock',
63279
63421
  'kisi_lock',
63422
+ 'aqara_lock',
63280
63423
  ],
63281
63424
  type: 'string',
63282
63425
  },
@@ -63315,6 +63458,7 @@ const openapi: OpenAPISpec = {
63315
63458
  'tedee',
63316
63459
  'keyincode',
63317
63460
  'akiles',
63461
+ 'aqara',
63318
63462
  'korelock',
63319
63463
  'smartthings',
63320
63464
  'ultraloq',
@@ -63610,6 +63754,7 @@ const openapi: OpenAPISpec = {
63610
63754
  'keyincode_lock',
63611
63755
  'omnitec_lock',
63612
63756
  'kisi_lock',
63757
+ 'aqara_lock',
63613
63758
  ],
63614
63759
  type: 'string',
63615
63760
  },
@@ -63648,6 +63793,7 @@ const openapi: OpenAPISpec = {
63648
63793
  'keyincode_lock',
63649
63794
  'omnitec_lock',
63650
63795
  'kisi_lock',
63796
+ 'aqara_lock',
63651
63797
  ],
63652
63798
  type: 'string',
63653
63799
  },
@@ -63748,6 +63894,7 @@ const openapi: OpenAPISpec = {
63748
63894
  'tedee',
63749
63895
  'keyincode',
63750
63896
  'akiles',
63897
+ 'aqara',
63751
63898
  'korelock',
63752
63899
  'smartthings',
63753
63900
  'ultraloq',