@seamapi/types 1.551.0 → 1.553.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 +169 -1
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +1365 -125
  4. package/dist/index.cjs +169 -1
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-credential.d.ts +8 -8
  7. package/lib/seam/connect/models/acs/metadata/assa-abloy-vostio.d.ts +2 -2
  8. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +28 -28
  9. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +12 -12
  10. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +16 -16
  11. package/lib/seam/connect/models/batch.d.ts +1176 -131
  12. package/lib/seam/connect/models/devices/device-metadata.d.ts +95 -0
  13. package/lib/seam/connect/models/devices/device-metadata.js +62 -0
  14. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  15. package/lib/seam/connect/models/devices/device-type.d.ts +8 -1
  16. package/lib/seam/connect/models/devices/device-type.js +8 -0
  17. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  18. package/lib/seam/connect/models/devices/device.d.ts +136 -3
  19. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +98 -3
  20. package/lib/seam/connect/models/phones/phone-session.d.ts +14 -14
  21. package/lib/seam/connect/openapi.d.ts +100 -0
  22. package/lib/seam/connect/openapi.js +141 -0
  23. package/lib/seam/connect/openapi.js.map +1 -1
  24. package/lib/seam/connect/route-types.d.ts +671 -25
  25. package/package.json +1 -1
  26. package/src/lib/seam/connect/models/devices/device-metadata.ts +62 -0
  27. package/src/lib/seam/connect/models/devices/device-type.ts +18 -0
  28. package/src/lib/seam/connect/openapi.ts +153 -0
  29. package/src/lib/seam/connect/route-types.ts +671 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.551.0",
3
+ "version": "1.553.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
package/src/lib/seam/connect/models/devices/device-metadata.ts CHANGED
@@ -618,7 +618,69 @@ export const device_metadata = z
618
618
 
619
619
  keynest_metadata: z
620
620
  .object({
621
+ key_id: z.string().describe(`Key ID for a KeyNest device.`),
621
622
  device_name: z.string().describe(`Device name for a KeyNest device.`),
623
+ property_id: z
624
+ .string()
625
+ .nullable()
626
+ .describe(`Property ID for a KeyNest device.`),
627
+ property_postcode: z
628
+ .string()
629
+ .nullable()
630
+ .describe(`Property postcode for a KeyNest device.`),
631
+ key_notes: z
632
+ .string()
633
+ .nullable()
634
+ .describe(`Key notes for a KeyNest device.`),
635
+ subscription_plan: z
636
+ .string()
637
+ .describe(`Subscription plan for a KeyNest device.`),
638
+ status_type: z.string().describe(`Status type for a KeyNest device.`),
639
+ current_or_last_store_id: z
640
+ .number()
641
+ .describe(`Current or last store ID for a KeyNest device.`),
642
+ last_movement: z
643
+ .string()
644
+ .describe(`Last movement timestamp for a KeyNest device.`),
645
+ address: z
646
+ .string()
647
+ .nullable()
648
+ .describe(`Address for a KeyNest device.`),
649
+ current_status: z
650
+ .string()
651
+ .nullable()
652
+ .describe(`Current status for a KeyNest device.`),
653
+ current_user_name: z
654
+ .string()
655
+ .nullable()
656
+ .describe(`Current user name for a KeyNest device.`),
657
+ current_user_email: z
658
+ .string()
659
+ .nullable()
660
+ .describe(`Current user email for a KeyNest device.`),
661
+ current_user_phone_number: z
662
+ .string()
663
+ .nullable()
664
+ .describe(`Current user phone number for a KeyNest device.`),
665
+ current_user_company: z
666
+ .string()
667
+ .nullable()
668
+ .describe(`Current user company for a KeyNest device.`),
669
+ handover_method: z
670
+ .string()
671
+ .nullable()
672
+ .describe(`Handover method for a KeyNest device.`),
673
+ keynest_app_user: z
674
+ .string()
675
+ .nullable()
676
+ .describe(`KeyNest app user for a KeyNest device.`),
677
+ default_office_id: z
678
+ .number()
679
+ .describe(`Default office ID for a KeyNest device.`),
680
+ fob_id: z.number().describe(`Fob ID for a KeyNest device.`),
681
+ has_photo: z
682
+ .boolean()
683
+ .describe(`Whether the KeyNest device has a photo.`),
622
684
  })
623
685
  .partial()
624
686
  .describe(`Metadata for a KeyNest device.`),
package/src/lib/seam/connect/models/devices/device-type.ts CHANGED
@@ -45,6 +45,23 @@ export const lock_device_type = z.enum(
45
45
 
46
46
  export type LockDeviceType = z.infer<typeof lock_device_type>
47
47
 
48
+ /** Keys */
49
+ export const KEY_DEVICE_TYPE = {
50
+ KEYNEST_KEY: 'keynest_key',
51
+ } as const
52
+
53
+ type KeyDeviceTypeFromMapping =
54
+ (typeof KEY_DEVICE_TYPE)[keyof typeof KEY_DEVICE_TYPE]
55
+
56
+ export const KEY_DEVICE_TYPE_LIST = Object.values(KEY_DEVICE_TYPE)
57
+
58
+ export const key_device_type = z.enum(
59
+ Object.values(KEY_DEVICE_TYPE) as [KeyDeviceTypeFromMapping],
60
+ ).describe(`Device type for keys.
61
+ `)
62
+
63
+ export type KeyDeviceType = z.infer<typeof key_device_type>
64
+
48
65
  /** Noise Sensors */
49
66
  export const NOISE_SENSOR_DEVICE_TYPE = {
50
67
  NOISEAWARE_ACTIVITY_ZONE: 'noiseaware_activity_zone',
@@ -111,6 +128,7 @@ export type PhoneDeviceType = z.infer<typeof phone_device_type>
111
128
 
112
129
  export const any_device_type = z.union([
113
130
  lock_device_type,
131
+ key_device_type,
114
132
  noise_sensor_device_type,
115
133
  thermostat_device_type,
116
134
  phone_device_type,
package/src/lib/seam/connect/openapi.ts CHANGED
@@ -9386,6 +9386,11 @@ export default {
9386
9386
  ],
9387
9387
  type: 'string',
9388
9388
  },
9389
+ {
9390
+ description: 'Device type for keys.\n ',
9391
+ enum: ['keynest_key'],
9392
+ type: 'string',
9393
+ },
9389
9394
  {
9390
9395
  description: 'Device type for noise sensors.\n ',
9391
9396
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
@@ -10773,10 +10778,112 @@ export default {
10773
10778
  keynest_metadata: {
10774
10779
  description: 'Metadata for a KeyNest device.',
10775
10780
  properties: {
10781
+ address: {
10782
+ description: 'Address for a KeyNest device.',
10783
+ nullable: true,
10784
+ type: 'string',
10785
+ },
10786
+ current_or_last_store_id: {
10787
+ description:
10788
+ 'Current or last store ID for a KeyNest device.',
10789
+ format: 'float',
10790
+ type: 'number',
10791
+ },
10792
+ current_status: {
10793
+ description: 'Current status for a KeyNest device.',
10794
+ nullable: true,
10795
+ type: 'string',
10796
+ },
10797
+ current_user_company: {
10798
+ description:
10799
+ 'Current user company for a KeyNest device.',
10800
+ nullable: true,
10801
+ type: 'string',
10802
+ },
10803
+ current_user_email: {
10804
+ description:
10805
+ 'Current user email for a KeyNest device.',
10806
+ nullable: true,
10807
+ type: 'string',
10808
+ },
10809
+ current_user_name: {
10810
+ description:
10811
+ 'Current user name for a KeyNest device.',
10812
+ nullable: true,
10813
+ type: 'string',
10814
+ },
10815
+ current_user_phone_number: {
10816
+ description:
10817
+ 'Current user phone number for a KeyNest device.',
10818
+ nullable: true,
10819
+ type: 'string',
10820
+ },
10821
+ default_office_id: {
10822
+ description:
10823
+ 'Default office ID for a KeyNest device.',
10824
+ format: 'float',
10825
+ type: 'number',
10826
+ },
10776
10827
  device_name: {
10777
10828
  description: 'Device name for a KeyNest device.',
10778
10829
  type: 'string',
10779
10830
  },
10831
+ fob_id: {
10832
+ description: 'Fob ID for a KeyNest device.',
10833
+ format: 'float',
10834
+ type: 'number',
10835
+ },
10836
+ handover_method: {
10837
+ description:
10838
+ 'Handover method for a KeyNest device.',
10839
+ nullable: true,
10840
+ type: 'string',
10841
+ },
10842
+ has_photo: {
10843
+ description:
10844
+ 'Whether the KeyNest device has a photo.',
10845
+ type: 'boolean',
10846
+ },
10847
+ key_id: {
10848
+ description: 'Key ID for a KeyNest device.',
10849
+ type: 'string',
10850
+ },
10851
+ key_notes: {
10852
+ description: 'Key notes for a KeyNest device.',
10853
+ nullable: true,
10854
+ type: 'string',
10855
+ },
10856
+ keynest_app_user: {
10857
+ description:
10858
+ 'KeyNest app user for a KeyNest device.',
10859
+ nullable: true,
10860
+ type: 'string',
10861
+ },
10862
+ last_movement: {
10863
+ description:
10864
+ 'Last movement timestamp for a KeyNest device.',
10865
+ type: 'string',
10866
+ },
10867
+ property_id: {
10868
+ description: 'Property ID for a KeyNest device.',
10869
+ nullable: true,
10870
+ type: 'string',
10871
+ },
10872
+ property_postcode: {
10873
+ description:
10874
+ 'Property postcode for a KeyNest device.',
10875
+ nullable: true,
10876
+ type: 'string',
10877
+ },
10878
+ status_type: {
10879
+ description: 'Status type for a KeyNest device.',
10880
+ type: 'string',
10881
+ },
10882
+ subscription_plan: {
10883
+ description:
10884
+ 'Subscription plan for a KeyNest device.',
10885
+ type: 'string',
10886
+ },
10780
10887
  },
10781
10888
  type: 'object',
10782
10889
  },
@@ -23847,6 +23954,11 @@ export default {
23847
23954
  ],
23848
23955
  type: 'string',
23849
23956
  },
23957
+ {
23958
+ description: 'Device type for keys.\n ',
23959
+ enum: ['keynest_key'],
23960
+ type: 'string',
23961
+ },
23850
23962
  {
23851
23963
  description: 'Device type for noise sensors.\n ',
23852
23964
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
@@ -26556,6 +26668,7 @@ export default {
26556
26668
  },
26557
26669
  security: [
26558
26670
  { client_session: [] },
26671
+ { client_session_with_customer: [] },
26559
26672
  { pat_with_workspace: [] },
26560
26673
  { console_session_with_workspace: [] },
26561
26674
  { api_key: [] },
@@ -40667,6 +40780,11 @@ export default {
40667
40780
  ],
40668
40781
  type: 'string',
40669
40782
  },
40783
+ {
40784
+ description: 'Device type for keys.\n ',
40785
+ enum: ['keynest_key'],
40786
+ type: 'string',
40787
+ },
40670
40788
  {
40671
40789
  description: 'Device type for noise sensors.\n ',
40672
40790
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
@@ -40733,6 +40851,11 @@ export default {
40733
40851
  ],
40734
40852
  type: 'string',
40735
40853
  },
40854
+ {
40855
+ description: 'Device type for keys.\n ',
40856
+ enum: ['keynest_key'],
40857
+ type: 'string',
40858
+ },
40736
40859
  {
40737
40860
  description: 'Device type for noise sensors.\n ',
40738
40861
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
@@ -41089,6 +41212,11 @@ export default {
41089
41212
  ],
41090
41213
  type: 'string',
41091
41214
  },
41215
+ {
41216
+ description: 'Device type for keys.\n ',
41217
+ enum: ['keynest_key'],
41218
+ type: 'string',
41219
+ },
41092
41220
  {
41093
41221
  description:
41094
41222
  'Device type for noise sensors.\n ',
@@ -41153,6 +41281,11 @@ export default {
41153
41281
  ],
41154
41282
  type: 'string',
41155
41283
  },
41284
+ {
41285
+ description: 'Device type for keys.\n ',
41286
+ enum: ['keynest_key'],
41287
+ type: 'string',
41288
+ },
41156
41289
  {
41157
41290
  description:
41158
41291
  'Device type for noise sensors.\n ',
@@ -41996,6 +42129,11 @@ export default {
41996
42129
  ],
41997
42130
  type: 'string',
41998
42131
  },
42132
+ {
42133
+ description: 'Device type for keys.\n ',
42134
+ enum: ['keynest_key'],
42135
+ type: 'string',
42136
+ },
41999
42137
  {
42000
42138
  description: 'Device type for noise sensors.\n ',
42001
42139
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
@@ -42062,6 +42200,11 @@ export default {
42062
42200
  ],
42063
42201
  type: 'string',
42064
42202
  },
42203
+ {
42204
+ description: 'Device type for keys.\n ',
42205
+ enum: ['keynest_key'],
42206
+ type: 'string',
42207
+ },
42065
42208
  {
42066
42209
  description: 'Device type for noise sensors.\n ',
42067
42210
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
@@ -42415,6 +42558,11 @@ export default {
42415
42558
  ],
42416
42559
  type: 'string',
42417
42560
  },
42561
+ {
42562
+ description: 'Device type for keys.\n ',
42563
+ enum: ['keynest_key'],
42564
+ type: 'string',
42565
+ },
42418
42566
  {
42419
42567
  description:
42420
42568
  'Device type for noise sensors.\n ',
@@ -42479,6 +42627,11 @@ export default {
42479
42627
  ],
42480
42628
  type: 'string',
42481
42629
  },
42630
+ {
42631
+ description: 'Device type for keys.\n ',
42632
+ enum: ['keynest_key'],
42633
+ type: 'string',
42634
+ },
42482
42635
  {
42483
42636
  description:
42484
42637
  'Device type for noise sensors.\n ',