@seamapi/types 1.933.0 → 1.934.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 (29) hide show
  1. package/dist/connect.cjs +88 -21
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +299 -43
  4. package/dist/index.cjs +88 -21
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/devices/device-metadata.d.ts +28 -0
  7. package/lib/seam/connect/models/devices/device-metadata.js +14 -0
  8. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  9. package/lib/seam/connect/models/devices/device-provider.d.ts +2 -1
  10. package/lib/seam/connect/models/devices/device-provider.js +2 -1
  11. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  12. package/lib/seam/connect/models/devices/device-type.d.ts +1 -0
  13. package/lib/seam/connect/models/devices/device-type.js +1 -0
  14. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  15. package/lib/seam/connect/models/devices/device.d.ts +43 -3
  16. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +31 -3
  17. package/lib/seam/connect/models/events/access-codes.d.ts +12 -12
  18. package/lib/seam/connect/models/events/seam-event.d.ts +6 -6
  19. package/lib/seam/connect/openapi.js +59 -0
  20. package/lib/seam/connect/openapi.js.map +1 -1
  21. package/lib/seam/connect/route-types.d.ts +218 -31
  22. package/lib/seam/devicedb/models/device-model.d.ts +4 -4
  23. package/lib/seam/devicedb/route-specs.d.ts +8 -8
  24. package/package.json +1 -1
  25. package/src/lib/seam/connect/models/devices/device-metadata.ts +15 -0
  26. package/src/lib/seam/connect/models/devices/device-provider.ts +2 -1
  27. package/src/lib/seam/connect/models/devices/device-type.ts +1 -0
  28. package/src/lib/seam/connect/openapi.ts +59 -0
  29. package/src/lib/seam/connect/route-types.ts +255 -0
@@ -545,6 +545,7 @@ export declare const base_device_model_v1: z.ZodObject<{
545
545
  power_sources: z.ZodArray<z.ZodEnum<["battery", "hardwired", "mechanical_harvesting", "wireless", "ethernet"]>, "many">;
546
546
  }, "strip", z.ZodTypeAny, {
547
547
  display_name: string;
548
+ description: string;
548
549
  manufacturer: {
549
550
  display_name: string;
550
551
  manufacturer_id: string;
@@ -573,7 +574,6 @@ export declare const base_device_model_v1: z.ZodObject<{
573
574
  us_customer_support_contact_url?: string | undefined;
574
575
  seam_api_guide?: string | undefined;
575
576
  };
576
- description: string;
577
577
  hardware: {
578
578
  has_physical_key?: boolean | undefined;
579
579
  };
@@ -605,6 +605,7 @@ export declare const base_device_model_v1: z.ZodObject<{
605
605
  product_url?: string | undefined;
606
606
  }, {
607
607
  display_name: string;
608
+ description: string;
608
609
  manufacturer: {
609
610
  display_name: string;
610
611
  manufacturer_id: string;
@@ -633,7 +634,6 @@ export declare const base_device_model_v1: z.ZodObject<{
633
634
  us_customer_support_contact_url?: string | undefined;
634
635
  seam_api_guide?: string | undefined;
635
636
  };
636
- description: string;
637
637
  hardware: {
638
638
  has_physical_key?: boolean | undefined;
639
639
  };
@@ -864,6 +864,7 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
864
864
  power_sources: z.ZodArray<z.ZodEnum<["battery", "hardwired", "mechanical_harvesting", "wireless", "ethernet"]>, "many">;
865
865
  }, "strip", z.ZodTypeAny, {
866
866
  display_name: string;
867
+ description: string;
867
868
  manufacturer: {
868
869
  display_name: string;
869
870
  manufacturer_id: string;
@@ -892,7 +893,6 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
892
893
  us_customer_support_contact_url?: string | undefined;
893
894
  seam_api_guide?: string | undefined;
894
895
  };
895
- description: string;
896
896
  hardware: {
897
897
  has_physical_key?: boolean | undefined;
898
898
  };
@@ -924,6 +924,7 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
924
924
  product_url?: string | undefined;
925
925
  }, {
926
926
  display_name: string;
927
+ description: string;
927
928
  manufacturer: {
928
929
  display_name: string;
929
930
  manufacturer_id: string;
@@ -952,7 +953,6 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
952
953
  us_customer_support_contact_url?: string | undefined;
953
954
  seam_api_guide?: string | undefined;
954
955
  };
955
- description: string;
956
956
  hardware: {
957
957
  has_physical_key?: boolean | undefined;
958
958
  };
@@ -210,6 +210,7 @@ export declare const routes: {
210
210
  power_sources: z.ZodArray<z.ZodEnum<["battery", "hardwired", "mechanical_harvesting", "wireless", "ethernet"]>, "many">;
211
211
  }, "strip", z.ZodTypeAny, {
212
212
  display_name: string;
213
+ description: string;
213
214
  manufacturer: {
214
215
  display_name: string;
215
216
  manufacturer_id: string;
@@ -238,7 +239,6 @@ export declare const routes: {
238
239
  us_customer_support_contact_url?: string | undefined;
239
240
  seam_api_guide?: string | undefined;
240
241
  };
241
- description: string;
242
242
  hardware: {
243
243
  has_physical_key?: boolean | undefined;
244
244
  };
@@ -270,6 +270,7 @@ export declare const routes: {
270
270
  product_url?: string | undefined;
271
271
  }, {
272
272
  display_name: string;
273
+ description: string;
273
274
  manufacturer: {
274
275
  display_name: string;
275
276
  manufacturer_id: string;
@@ -298,7 +299,6 @@ export declare const routes: {
298
299
  us_customer_support_contact_url?: string | undefined;
299
300
  seam_api_guide?: string | undefined;
300
301
  };
301
- description: string;
302
302
  hardware: {
303
303
  has_physical_key?: boolean | undefined;
304
304
  };
@@ -593,6 +593,7 @@ export declare const routes: {
593
593
  }, "strip", z.ZodTypeAny, {
594
594
  device_model: {
595
595
  display_name: string;
596
+ description: string;
596
597
  manufacturer: {
597
598
  display_name: string;
598
599
  manufacturer_id: string;
@@ -621,7 +622,6 @@ export declare const routes: {
621
622
  us_customer_support_contact_url?: string | undefined;
622
623
  seam_api_guide?: string | undefined;
623
624
  };
624
- description: string;
625
625
  hardware: {
626
626
  has_physical_key?: boolean | undefined;
627
627
  };
@@ -716,6 +716,7 @@ export declare const routes: {
716
716
  }, {
717
717
  device_model: {
718
718
  display_name: string;
719
+ description: string;
719
720
  manufacturer: {
720
721
  display_name: string;
721
722
  manufacturer_id: string;
@@ -744,7 +745,6 @@ export declare const routes: {
744
745
  us_customer_support_contact_url?: string | undefined;
745
746
  seam_api_guide?: string | undefined;
746
747
  };
747
- description: string;
748
748
  hardware: {
749
749
  has_physical_key?: boolean | undefined;
750
750
  };
@@ -1070,6 +1070,7 @@ export declare const routes: {
1070
1070
  power_sources: z.ZodArray<z.ZodEnum<["battery", "hardwired", "mechanical_harvesting", "wireless", "ethernet"]>, "many">;
1071
1071
  }, "strip", z.ZodTypeAny, {
1072
1072
  display_name: string;
1073
+ description: string;
1073
1074
  manufacturer: {
1074
1075
  display_name: string;
1075
1076
  manufacturer_id: string;
@@ -1098,7 +1099,6 @@ export declare const routes: {
1098
1099
  us_customer_support_contact_url?: string | undefined;
1099
1100
  seam_api_guide?: string | undefined;
1100
1101
  };
1101
- description: string;
1102
1102
  hardware: {
1103
1103
  has_physical_key?: boolean | undefined;
1104
1104
  };
@@ -1130,6 +1130,7 @@ export declare const routes: {
1130
1130
  product_url?: string | undefined;
1131
1131
  }, {
1132
1132
  display_name: string;
1133
+ description: string;
1133
1134
  manufacturer: {
1134
1135
  display_name: string;
1135
1136
  manufacturer_id: string;
@@ -1158,7 +1159,6 @@ export declare const routes: {
1158
1159
  us_customer_support_contact_url?: string | undefined;
1159
1160
  seam_api_guide?: string | undefined;
1160
1161
  };
1161
- description: string;
1162
1162
  hardware: {
1163
1163
  has_physical_key?: boolean | undefined;
1164
1164
  };
@@ -1453,6 +1453,7 @@ export declare const routes: {
1453
1453
  }, "strip", z.ZodTypeAny, {
1454
1454
  device_models: ({
1455
1455
  display_name: string;
1456
+ description: string;
1456
1457
  manufacturer: {
1457
1458
  display_name: string;
1458
1459
  manufacturer_id: string;
@@ -1481,7 +1482,6 @@ export declare const routes: {
1481
1482
  us_customer_support_contact_url?: string | undefined;
1482
1483
  seam_api_guide?: string | undefined;
1483
1484
  };
1484
- description: string;
1485
1485
  hardware: {
1486
1486
  has_physical_key?: boolean | undefined;
1487
1487
  };
@@ -1576,6 +1576,7 @@ export declare const routes: {
1576
1576
  }, {
1577
1577
  device_models: ({
1578
1578
  display_name: string;
1579
+ description: string;
1579
1580
  manufacturer: {
1580
1581
  display_name: string;
1581
1582
  manufacturer_id: string;
@@ -1604,7 +1605,6 @@ export declare const routes: {
1604
1605
  us_customer_support_contact_url?: string | undefined;
1605
1606
  seam_api_guide?: string | undefined;
1606
1607
  };
1607
- description: string;
1608
1608
  hardware: {
1609
1609
  has_physical_key?: boolean | undefined;
1610
1610
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.933.0",
3
+ "version": "1.934.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -797,6 +797,21 @@ export const device_metadata = z
797
797
  })
798
798
  .partial()
799
799
  .describe(`Metadata for a Korelock device.`),
800
+
801
+ kisi_metadata: z
802
+ .object({
803
+ lock_id: z.number().describe(`Lock ID for a Kisi device.`),
804
+ lock_name: z.string().describe(`Lock name for a Kisi device.`),
805
+ place_name: z
806
+ .string()
807
+ .nullable()
808
+ .describe(`Place name for a Kisi device.`),
809
+ description: z
810
+ .string()
811
+ .nullable()
812
+ .describe(`Description for a Kisi device.`),
813
+ })
814
+ .describe(`Metadata for a Kisi device.`),
800
815
  })
801
816
  .partial().describe(`
802
817
  ---
@@ -64,6 +64,7 @@ export const DEVICE_PROVIDERS = {
64
64
  GUESTY: 'guesty',
65
65
  ACUITY_SCHEDULING: 'acuity_scheduling',
66
66
  OMNITEC: 'omnitec',
67
+ KISI: 'kisi',
67
68
  } as const
68
69
 
69
70
  export type DeviceProviderName =
@@ -142,7 +143,7 @@ export const PROVIDER_CATEGORY_MAP = {
142
143
  'thirty_three_lock',
143
144
  ],
144
145
 
145
- beta: [],
146
+ beta: ['kisi'],
146
147
 
147
148
  thermostats: ['ecobee', 'nest', 'sensi', 'honeywell_resideo', 'first_alert'],
148
149
  noise_sensors: ['minut', 'noiseaware'],
@@ -30,6 +30,7 @@ export const LOCK_DEVICE_TYPE = {
30
30
  ULTRALOQ_LOCK: 'ultraloq_lock',
31
31
  KEYINCODE_LOCK: 'keyincode_lock',
32
32
  OMNITEC_LOCK: 'omnitec_lock',
33
+ KISI_LOCK: 'kisi_lock',
33
34
  } as const
34
35
 
35
36
  type LockDeviceTypeFromMapping =
@@ -13014,6 +13014,7 @@ const openapi: OpenAPISpec = {
13014
13014
  'ultraloq_lock',
13015
13015
  'keyincode_lock',
13016
13016
  'omnitec_lock',
13017
+ 'kisi_lock',
13017
13018
  ],
13018
13019
  type: 'string',
13019
13020
  },
@@ -14549,6 +14550,37 @@ const openapi: OpenAPISpec = {
14549
14550
  },
14550
14551
  type: 'object',
14551
14552
  },
14553
+ kisi_metadata: {
14554
+ description: 'Metadata for a Kisi device.',
14555
+ properties: {
14556
+ description: {
14557
+ description: 'Description for a Kisi device.',
14558
+ nullable: true,
14559
+ type: 'string',
14560
+ },
14561
+ lock_id: {
14562
+ description: 'Lock ID for a Kisi device.',
14563
+ format: 'float',
14564
+ type: 'number',
14565
+ },
14566
+ lock_name: {
14567
+ description: 'Lock name for a Kisi device.',
14568
+ type: 'string',
14569
+ },
14570
+ place_name: {
14571
+ description: 'Place name for a Kisi device.',
14572
+ nullable: true,
14573
+ type: 'string',
14574
+ },
14575
+ },
14576
+ required: [
14577
+ 'lock_id',
14578
+ 'lock_name',
14579
+ 'place_name',
14580
+ 'description',
14581
+ ],
14582
+ type: 'object',
14583
+ },
14552
14584
  korelock_metadata: {
14553
14585
  description: 'Metadata for a Korelock device.',
14554
14586
  properties: {
@@ -17499,6 +17531,7 @@ const openapi: OpenAPISpec = {
17499
17531
  'guesty',
17500
17532
  'acuity_scheduling',
17501
17533
  'omnitec',
17534
+ 'kisi',
17502
17535
  ],
17503
17536
  type: 'string',
17504
17537
  },
@@ -32370,6 +32403,7 @@ const openapi: OpenAPISpec = {
32370
32403
  'ultraloq_lock',
32371
32404
  'keyincode_lock',
32372
32405
  'omnitec_lock',
32406
+ 'kisi_lock',
32373
32407
  ],
32374
32408
  type: 'string',
32375
32409
  },
@@ -52419,6 +52453,7 @@ const openapi: OpenAPISpec = {
52419
52453
  'guesty',
52420
52454
  'acuity_scheduling',
52421
52455
  'omnitec',
52456
+ 'kisi',
52422
52457
  'yale_access',
52423
52458
  'hid_cm',
52424
52459
  'google_nest',
@@ -56740,6 +56775,7 @@ const openapi: OpenAPISpec = {
56740
56775
  'ultraloq_lock',
56741
56776
  'keyincode_lock',
56742
56777
  'omnitec_lock',
56778
+ 'kisi_lock',
56743
56779
  ],
56744
56780
  type: 'string',
56745
56781
  },
@@ -56817,6 +56853,7 @@ const openapi: OpenAPISpec = {
56817
56853
  'ultraloq_lock',
56818
56854
  'keyincode_lock',
56819
56855
  'omnitec_lock',
56856
+ 'kisi_lock',
56820
56857
  ],
56821
56858
  type: 'string',
56822
56859
  },
@@ -56892,6 +56929,7 @@ const openapi: OpenAPISpec = {
56892
56929
  'dormakaba_oracode',
56893
56930
  'tedee',
56894
56931
  'keyincode',
56932
+ 'kisi',
56895
56933
  'akiles',
56896
56934
  'ecobee',
56897
56935
  'honeywell_resideo',
@@ -56911,6 +56949,7 @@ const openapi: OpenAPISpec = {
56911
56949
  'guesty',
56912
56950
  'acuity_scheduling',
56913
56951
  'omnitec',
56952
+ 'kisi',
56914
56953
  'slack',
56915
56954
  ],
56916
56955
  type: 'string',
@@ -57201,6 +57240,7 @@ const openapi: OpenAPISpec = {
57201
57240
  'ultraloq_lock',
57202
57241
  'keyincode_lock',
57203
57242
  'omnitec_lock',
57243
+ 'kisi_lock',
57204
57244
  ],
57205
57245
  type: 'string',
57206
57246
  },
@@ -57276,6 +57316,7 @@ const openapi: OpenAPISpec = {
57276
57316
  'ultraloq_lock',
57277
57317
  'keyincode_lock',
57278
57318
  'omnitec_lock',
57319
+ 'kisi_lock',
57279
57320
  ],
57280
57321
  type: 'string',
57281
57322
  },
@@ -57415,6 +57456,7 @@ const openapi: OpenAPISpec = {
57415
57456
  'dormakaba_oracode',
57416
57457
  'tedee',
57417
57458
  'keyincode',
57459
+ 'kisi',
57418
57460
  'akiles',
57419
57461
  'ecobee',
57420
57462
  'honeywell_resideo',
@@ -57434,6 +57476,7 @@ const openapi: OpenAPISpec = {
57434
57476
  'guesty',
57435
57477
  'acuity_scheduling',
57436
57478
  'omnitec',
57479
+ 'kisi',
57437
57480
  'slack',
57438
57481
  ],
57439
57482
  type: 'string',
@@ -59544,6 +59587,7 @@ const openapi: OpenAPISpec = {
59544
59587
  'ultraloq_lock',
59545
59588
  'keyincode_lock',
59546
59589
  'omnitec_lock',
59590
+ 'kisi_lock',
59547
59591
  ],
59548
59592
  type: 'string',
59549
59593
  },
@@ -59621,6 +59665,7 @@ const openapi: OpenAPISpec = {
59621
59665
  'ultraloq_lock',
59622
59666
  'keyincode_lock',
59623
59667
  'omnitec_lock',
59668
+ 'kisi_lock',
59624
59669
  ],
59625
59670
  type: 'string',
59626
59671
  },
@@ -59696,6 +59741,7 @@ const openapi: OpenAPISpec = {
59696
59741
  'dormakaba_oracode',
59697
59742
  'tedee',
59698
59743
  'keyincode',
59744
+ 'kisi',
59699
59745
  'akiles',
59700
59746
  'ecobee',
59701
59747
  'honeywell_resideo',
@@ -59715,6 +59761,7 @@ const openapi: OpenAPISpec = {
59715
59761
  'guesty',
59716
59762
  'acuity_scheduling',
59717
59763
  'omnitec',
59764
+ 'kisi',
59718
59765
  'slack',
59719
59766
  ],
59720
59767
  type: 'string',
@@ -60004,6 +60051,7 @@ const openapi: OpenAPISpec = {
60004
60051
  'ultraloq_lock',
60005
60052
  'keyincode_lock',
60006
60053
  'omnitec_lock',
60054
+ 'kisi_lock',
60007
60055
  ],
60008
60056
  type: 'string',
60009
60057
  },
@@ -60079,6 +60127,7 @@ const openapi: OpenAPISpec = {
60079
60127
  'ultraloq_lock',
60080
60128
  'keyincode_lock',
60081
60129
  'omnitec_lock',
60130
+ 'kisi_lock',
60082
60131
  ],
60083
60132
  type: 'string',
60084
60133
  },
@@ -60218,6 +60267,7 @@ const openapi: OpenAPISpec = {
60218
60267
  'dormakaba_oracode',
60219
60268
  'tedee',
60220
60269
  'keyincode',
60270
+ 'kisi',
60221
60271
  'akiles',
60222
60272
  'ecobee',
60223
60273
  'honeywell_resideo',
@@ -60237,6 +60287,7 @@ const openapi: OpenAPISpec = {
60237
60287
  'guesty',
60238
60288
  'acuity_scheduling',
60239
60289
  'omnitec',
60290
+ 'kisi',
60240
60291
  'slack',
60241
60292
  ],
60242
60293
  type: 'string',
@@ -62339,6 +62390,7 @@ const openapi: OpenAPISpec = {
62339
62390
  'ultraloq_lock',
62340
62391
  'keyincode_lock',
62341
62392
  'omnitec_lock',
62393
+ 'kisi_lock',
62342
62394
  ],
62343
62395
  type: 'string',
62344
62396
  },
@@ -62379,6 +62431,7 @@ const openapi: OpenAPISpec = {
62379
62431
  'ultraloq_lock',
62380
62432
  'keyincode_lock',
62381
62433
  'omnitec_lock',
62434
+ 'kisi_lock',
62382
62435
  ],
62383
62436
  type: 'string',
62384
62437
  },
@@ -62416,11 +62469,13 @@ const openapi: OpenAPISpec = {
62416
62469
  'dormakaba_oracode',
62417
62470
  'tedee',
62418
62471
  'keyincode',
62472
+ 'kisi',
62419
62473
  'akiles',
62420
62474
  'korelock',
62421
62475
  'smartthings',
62422
62476
  'ultraloq',
62423
62477
  'omnitec',
62478
+ 'kisi',
62424
62479
  ],
62425
62480
  type: 'string',
62426
62481
  },
@@ -62709,6 +62764,7 @@ const openapi: OpenAPISpec = {
62709
62764
  'ultraloq_lock',
62710
62765
  'keyincode_lock',
62711
62766
  'omnitec_lock',
62767
+ 'kisi_lock',
62712
62768
  ],
62713
62769
  type: 'string',
62714
62770
  },
@@ -62746,6 +62802,7 @@ const openapi: OpenAPISpec = {
62746
62802
  'ultraloq_lock',
62747
62803
  'keyincode_lock',
62748
62804
  'omnitec_lock',
62805
+ 'kisi_lock',
62749
62806
  ],
62750
62807
  type: 'string',
62751
62808
  },
@@ -62845,11 +62902,13 @@ const openapi: OpenAPISpec = {
62845
62902
  'dormakaba_oracode',
62846
62903
  'tedee',
62847
62904
  'keyincode',
62905
+ 'kisi',
62848
62906
  'akiles',
62849
62907
  'korelock',
62850
62908
  'smartthings',
62851
62909
  'ultraloq',
62852
62910
  'omnitec',
62911
+ 'kisi',
62853
62912
  ],
62854
62913
  type: 'string',
62855
62914
  },