@seamapi/types 1.530.0 → 1.532.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 (34) hide show
  1. package/dist/connect.cjs +67 -4
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +173 -5
  4. package/dist/index.cjs +67 -4
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-entrance.d.ts +13 -0
  7. package/lib/seam/connect/models/acs/acs-entrance.js +4 -1
  8. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  9. package/lib/seam/connect/models/acs/metadata/hotek.d.ts +9 -0
  10. package/lib/seam/connect/models/acs/metadata/hotek.js +7 -0
  11. package/lib/seam/connect/models/acs/metadata/hotek.js.map +1 -0
  12. package/lib/seam/connect/models/acs/metadata/index.d.ts +1 -0
  13. package/lib/seam/connect/models/acs/metadata/index.js +1 -0
  14. package/lib/seam/connect/models/acs/metadata/index.js.map +1 -1
  15. package/lib/seam/connect/models/batch.d.ts +105 -2
  16. package/lib/seam/connect/models/devices/device-provider.d.ts +2 -1
  17. package/lib/seam/connect/models/devices/device-provider.js +2 -0
  18. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  19. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +3 -1
  20. package/lib/seam/connect/models/devices/unmanaged-device.js +1 -0
  21. package/lib/seam/connect/models/devices/unmanaged-device.js.map +1 -1
  22. package/lib/seam/connect/models/phones/phone-session.d.ts +56 -0
  23. package/lib/seam/connect/openapi.d.ts +59 -0
  24. package/lib/seam/connect/openapi.js +56 -2
  25. package/lib/seam/connect/openapi.js.map +1 -1
  26. package/lib/seam/connect/route-types.d.ts +73 -3
  27. package/package.json +1 -1
  28. package/src/lib/seam/connect/models/acs/acs-entrance.ts +6 -0
  29. package/src/lib/seam/connect/models/acs/metadata/hotek.ts +11 -0
  30. package/src/lib/seam/connect/models/acs/metadata/index.ts +1 -0
  31. package/src/lib/seam/connect/models/devices/device-provider.ts +2 -0
  32. package/src/lib/seam/connect/models/devices/unmanaged-device.ts +1 -0
  33. package/src/lib/seam/connect/openapi.ts +61 -2
  34. package/src/lib/seam/connect/route-types.ts +95 -1
package/lib/seam/connect/models/phones/phone-session.d.ts CHANGED
@@ -215,6 +215,13 @@ declare const phone_provider_session: z.ZodObject<{
215
215
  door_type: string;
216
216
  accessibility_type: string;
217
217
  }>>;
218
+ hotek_metadata: z.ZodOptional<z.ZodObject<{
219
+ room_number: z.ZodString;
220
+ }, "strip", z.ZodTypeAny, {
221
+ room_number: string;
222
+ }, {
223
+ room_number: string;
224
+ }>>;
218
225
  visionline_metadata: z.ZodOptional<z.ZodObject<{
219
226
  door_name: z.ZodString;
220
227
  door_category: z.ZodEnum<["entrance", "guest", "elevator reader", "common", "common (PMS)"]>;
@@ -374,6 +381,9 @@ declare const phone_provider_session: z.ZodObject<{
374
381
  door_type: string;
375
382
  accessibility_type: string;
376
383
  } | undefined;
384
+ hotek_metadata?: {
385
+ room_number: string;
386
+ } | undefined;
377
387
  dormakaba_community_metadata?: {
378
388
  access_point_name: string;
379
389
  } | undefined;
@@ -432,6 +442,9 @@ declare const phone_provider_session: z.ZodObject<{
432
442
  door_type: string;
433
443
  accessibility_type: string;
434
444
  } | undefined;
445
+ hotek_metadata?: {
446
+ room_number: string;
447
+ } | undefined;
435
448
  dormakaba_community_metadata?: {
436
449
  access_point_name: string;
437
450
  } | undefined;
@@ -529,6 +542,9 @@ declare const phone_provider_session: z.ZodObject<{
529
542
  door_type: string;
530
543
  accessibility_type: string;
531
544
  } | undefined;
545
+ hotek_metadata?: {
546
+ room_number: string;
547
+ } | undefined;
532
548
  dormakaba_community_metadata?: {
533
549
  access_point_name: string;
534
550
  } | undefined;
@@ -660,6 +676,9 @@ declare const phone_provider_session: z.ZodObject<{
660
676
  door_type: string;
661
677
  accessibility_type: string;
662
678
  } | undefined;
679
+ hotek_metadata?: {
680
+ room_number: string;
681
+ } | undefined;
663
682
  dormakaba_community_metadata?: {
664
683
  access_point_name: string;
665
684
  } | undefined;
@@ -793,6 +812,9 @@ declare const phone_provider_session: z.ZodObject<{
793
812
  door_type: string;
794
813
  accessibility_type: string;
795
814
  } | undefined;
815
+ hotek_metadata?: {
816
+ room_number: string;
817
+ } | undefined;
796
818
  dormakaba_community_metadata?: {
797
819
  access_point_name: string;
798
820
  } | undefined;
@@ -932,6 +954,9 @@ declare const phone_provider_session: z.ZodObject<{
932
954
  door_type: string;
933
955
  accessibility_type: string;
934
956
  } | undefined;
957
+ hotek_metadata?: {
958
+ room_number: string;
959
+ } | undefined;
935
960
  dormakaba_community_metadata?: {
936
961
  access_point_name: string;
937
962
  } | undefined;
@@ -1206,6 +1231,13 @@ export declare const phone_session: z.ZodObject<{
1206
1231
  door_type: string;
1207
1232
  accessibility_type: string;
1208
1233
  }>>;
1234
+ hotek_metadata: z.ZodOptional<z.ZodObject<{
1235
+ room_number: z.ZodString;
1236
+ }, "strip", z.ZodTypeAny, {
1237
+ room_number: string;
1238
+ }, {
1239
+ room_number: string;
1240
+ }>>;
1209
1241
  visionline_metadata: z.ZodOptional<z.ZodObject<{
1210
1242
  door_name: z.ZodString;
1211
1243
  door_category: z.ZodEnum<["entrance", "guest", "elevator reader", "common", "common (PMS)"]>;
@@ -1365,6 +1397,9 @@ export declare const phone_session: z.ZodObject<{
1365
1397
  door_type: string;
1366
1398
  accessibility_type: string;
1367
1399
  } | undefined;
1400
+ hotek_metadata?: {
1401
+ room_number: string;
1402
+ } | undefined;
1368
1403
  dormakaba_community_metadata?: {
1369
1404
  access_point_name: string;
1370
1405
  } | undefined;
@@ -1423,6 +1458,9 @@ export declare const phone_session: z.ZodObject<{
1423
1458
  door_type: string;
1424
1459
  accessibility_type: string;
1425
1460
  } | undefined;
1461
+ hotek_metadata?: {
1462
+ room_number: string;
1463
+ } | undefined;
1426
1464
  dormakaba_community_metadata?: {
1427
1465
  access_point_name: string;
1428
1466
  } | undefined;
@@ -1520,6 +1558,9 @@ export declare const phone_session: z.ZodObject<{
1520
1558
  door_type: string;
1521
1559
  accessibility_type: string;
1522
1560
  } | undefined;
1561
+ hotek_metadata?: {
1562
+ room_number: string;
1563
+ } | undefined;
1523
1564
  dormakaba_community_metadata?: {
1524
1565
  access_point_name: string;
1525
1566
  } | undefined;
@@ -1651,6 +1692,9 @@ export declare const phone_session: z.ZodObject<{
1651
1692
  door_type: string;
1652
1693
  accessibility_type: string;
1653
1694
  } | undefined;
1695
+ hotek_metadata?: {
1696
+ room_number: string;
1697
+ } | undefined;
1654
1698
  dormakaba_community_metadata?: {
1655
1699
  access_point_name: string;
1656
1700
  } | undefined;
@@ -1784,6 +1828,9 @@ export declare const phone_session: z.ZodObject<{
1784
1828
  door_type: string;
1785
1829
  accessibility_type: string;
1786
1830
  } | undefined;
1831
+ hotek_metadata?: {
1832
+ room_number: string;
1833
+ } | undefined;
1787
1834
  dormakaba_community_metadata?: {
1788
1835
  access_point_name: string;
1789
1836
  } | undefined;
@@ -1923,6 +1970,9 @@ export declare const phone_session: z.ZodObject<{
1923
1970
  door_type: string;
1924
1971
  accessibility_type: string;
1925
1972
  } | undefined;
1973
+ hotek_metadata?: {
1974
+ room_number: string;
1975
+ } | undefined;
1926
1976
  dormakaba_community_metadata?: {
1927
1977
  access_point_name: string;
1928
1978
  } | undefined;
@@ -2176,6 +2226,9 @@ export declare const phone_session: z.ZodObject<{
2176
2226
  door_type: string;
2177
2227
  accessibility_type: string;
2178
2228
  } | undefined;
2229
+ hotek_metadata?: {
2230
+ room_number: string;
2231
+ } | undefined;
2179
2232
  dormakaba_community_metadata?: {
2180
2233
  access_point_name: string;
2181
2234
  } | undefined;
@@ -2345,6 +2398,9 @@ export declare const phone_session: z.ZodObject<{
2345
2398
  door_type: string;
2346
2399
  accessibility_type: string;
2347
2400
  } | undefined;
2401
+ hotek_metadata?: {
2402
+ room_number: string;
2403
+ } | undefined;
2348
2404
  dormakaba_community_metadata?: {
2349
2405
  access_point_name: string;
2350
2406
  } | undefined;
package/lib/seam/connect/openapi.d.ts CHANGED
@@ -1156,6 +1156,17 @@ declare const _default: {
1156
1156
  };
1157
1157
  type: string;
1158
1158
  };
1159
+ hotek_metadata: {
1160
+ description: string;
1161
+ properties: {
1162
+ room_number: {
1163
+ description: string;
1164
+ type: string;
1165
+ };
1166
+ };
1167
+ required: string[];
1168
+ type: string;
1169
+ };
1159
1170
  latch_metadata: {
1160
1171
  description: string;
1161
1172
  properties: {
@@ -10970,6 +10981,17 @@ declare const _default: {
10970
10981
  };
10971
10982
  type: string;
10972
10983
  };
10984
+ hotek_metadata: {
10985
+ description: string;
10986
+ properties: {
10987
+ room_number: {
10988
+ description: string;
10989
+ type: string;
10990
+ };
10991
+ };
10992
+ required: string[];
10993
+ type: string;
10994
+ };
10973
10995
  latch_metadata: {
10974
10996
  description: string;
10975
10997
  properties: {
@@ -12912,6 +12934,15 @@ declare const _default: {
12912
12934
  format: string;
12913
12935
  type: string;
12914
12936
  };
12937
+ custom_metadata: {
12938
+ additionalProperties: {
12939
+ oneOf: {
12940
+ type: string;
12941
+ }[];
12942
+ };
12943
+ description: string;
12944
+ type: string;
12945
+ };
12915
12946
  device_id: {
12916
12947
  description: string;
12917
12948
  format: string;
@@ -32766,6 +32797,20 @@ declare const _default: {
32766
32797
  'application/json': {
32767
32798
  schema: {
32768
32799
  properties: {
32800
+ custom_metadata: {
32801
+ additionalProperties: {
32802
+ nullable: boolean;
32803
+ oneOf: ({
32804
+ maxLength: number;
32805
+ type: string;
32806
+ } | {
32807
+ type: string;
32808
+ maxLength?: never;
32809
+ })[];
32810
+ };
32811
+ description: string;
32812
+ type: string;
32813
+ };
32769
32814
  device_id: {
32770
32815
  description: string;
32771
32816
  format: string;
@@ -32835,6 +32880,20 @@ declare const _default: {
32835
32880
  'application/json': {
32836
32881
  schema: {
32837
32882
  properties: {
32883
+ custom_metadata: {
32884
+ additionalProperties: {
32885
+ nullable: boolean;
32886
+ oneOf: ({
32887
+ maxLength: number;
32888
+ type: string;
32889
+ } | {
32890
+ type: string;
32891
+ maxLength?: never;
32892
+ })[];
32893
+ };
32894
+ description: string;
32895
+ type: string;
32896
+ };
32838
32897
  device_id: {
32839
32898
  description: string;
32840
32899
  format: string;
package/lib/seam/connect/openapi.js CHANGED
@@ -2482,6 +2482,17 @@ export default {
2482
2482
  },
2483
2483
  type: 'array',
2484
2484
  },
2485
+ hotek_metadata: {
2486
+ description: 'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
2487
+ properties: {
2488
+ room_number: {
2489
+ description: 'Room number of the entrance.',
2490
+ type: 'string',
2491
+ },
2492
+ },
2493
+ required: ['room_number'],
2494
+ type: 'object',
2495
+ },
2485
2496
  latch_metadata: {
2486
2497
  description: 'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
2487
2498
  properties: {
@@ -11450,6 +11461,7 @@ export default {
11450
11461
  can_unlock_with_code: { type: 'boolean' },
11451
11462
  device_provider_name: {
11452
11463
  enum: [
11464
+ 'hotek',
11453
11465
  'dormakaba_community',
11454
11466
  'legic_connect',
11455
11467
  'akuvox',
@@ -17620,6 +17632,17 @@ export default {
17620
17632
  },
17621
17633
  type: 'array',
17622
17634
  },
17635
+ hotek_metadata: {
17636
+ description: 'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
17637
+ properties: {
17638
+ room_number: {
17639
+ description: 'Room number of the entrance.',
17640
+ type: 'string',
17641
+ },
17642
+ },
17643
+ required: ['room_number'],
17644
+ type: 'object',
17645
+ },
17623
17646
  latch_metadata: {
17624
17647
  description: 'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
17625
17648
  properties: {
@@ -21229,6 +21252,13 @@ export default {
21229
21252
  format: 'date-time',
21230
21253
  type: 'string',
21231
21254
  },
21255
+ custom_metadata: {
21256
+ additionalProperties: {
21257
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
21258
+ },
21259
+ description: 'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
21260
+ type: 'object',
21261
+ },
21232
21262
  device_id: {
21233
21263
  description: 'ID of the device.',
21234
21264
  format: 'uuid',
@@ -22384,6 +22414,7 @@ export default {
22384
22414
  'errors',
22385
22415
  'warnings',
22386
22416
  'created_at',
22417
+ 'custom_metadata',
22387
22418
  'is_managed',
22388
22419
  'properties',
22389
22420
  ],
@@ -33894,6 +33925,7 @@ export default {
33894
33925
  description: 'Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.',
33895
33926
  items: {
33896
33927
  enum: [
33928
+ 'hotek',
33897
33929
  'dormakaba_community',
33898
33930
  'legic_connect',
33899
33931
  'akuvox',
@@ -38874,6 +38906,17 @@ export default {
38874
38906
  'application/json': {
38875
38907
  schema: {
38876
38908
  properties: {
38909
+ custom_metadata: {
38910
+ additionalProperties: {
38911
+ nullable: true,
38912
+ oneOf: [
38913
+ { maxLength: 500, type: 'string' },
38914
+ { type: 'boolean' },
38915
+ ],
38916
+ },
38917
+ description: 'Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.',
38918
+ type: 'object',
38919
+ },
38877
38920
  device_id: {
38878
38921
  description: 'ID of the unmanaged device that you want to update.',
38879
38922
  format: 'uuid',
@@ -38885,7 +38928,7 @@ export default {
38885
38928
  type: 'boolean',
38886
38929
  },
38887
38930
  },
38888
- required: ['device_id', 'is_managed'],
38931
+ required: ['device_id'],
38889
38932
  type: 'object',
38890
38933
  },
38891
38934
  },
@@ -38927,6 +38970,17 @@ export default {
38927
38970
  'application/json': {
38928
38971
  schema: {
38929
38972
  properties: {
38973
+ custom_metadata: {
38974
+ additionalProperties: {
38975
+ nullable: true,
38976
+ oneOf: [
38977
+ { maxLength: 500, type: 'string' },
38978
+ { type: 'boolean' },
38979
+ ],
38980
+ },
38981
+ description: 'Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.',
38982
+ type: 'object',
38983
+ },
38930
38984
  device_id: {
38931
38985
  description: 'ID of the unmanaged device that you want to update.',
38932
38986
  format: 'uuid',
@@ -38938,7 +38992,7 @@ export default {
38938
38992
  type: 'boolean',
38939
38993
  },
38940
38994
  },
38941
- required: ['device_id', 'is_managed'],
38995
+ required: ['device_id'],
38942
38996
  type: 'object',
38943
38997
  },
38944
38998
  },