@seamapi/types 1.501.0 → 1.503.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 (33) hide show
  1. package/dist/connect.cjs +18 -133
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +179 -1358
  4. package/dist/index.cjs +18 -133
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +3 -0
  7. package/lib/seam/connect/models/access-codes/managed-access-code.js +4 -0
  8. package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
  9. package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +3 -0
  10. package/lib/seam/connect/models/access-codes/unmanaged-access-code.js +1 -0
  11. package/lib/seam/connect/models/access-codes/unmanaged-access-code.js.map +1 -1
  12. package/lib/seam/connect/models/acs/acs-credential.d.ts +8 -8
  13. package/lib/seam/connect/models/acs/metadata/assa-abloy-vostio.d.ts +2 -2
  14. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +28 -28
  15. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +12 -12
  16. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +16 -16
  17. package/lib/seam/connect/models/batch.d.ts +171 -1196
  18. package/lib/seam/connect/models/devices/device-metadata.d.ts +5 -100
  19. package/lib/seam/connect/models/devices/device-metadata.js +1 -62
  20. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  21. package/lib/seam/connect/models/devices/device.d.ts +7 -140
  22. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +5 -100
  23. package/lib/seam/connect/models/phones/phone-session.d.ts +14 -14
  24. package/lib/seam/connect/openapi.d.ts +10 -91
  25. package/lib/seam/connect/openapi.js +12 -112
  26. package/lib/seam/connect/openapi.js.map +1 -1
  27. package/lib/seam/connect/route-types.d.ts +43 -663
  28. package/package.json +1 -1
  29. package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +6 -0
  30. package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +1 -0
  31. package/src/lib/seam/connect/models/devices/device-metadata.ts +1 -62
  32. package/src/lib/seam/connect/openapi.ts +14 -124
  33. package/src/lib/seam/connect/route-types.ts +43 -663
package/src/lib/seam/connect/route-types.ts CHANGED
@@ -1482,6 +1482,8 @@ export type Routes = {
1482
1482
 
1483
1483
  In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
1484
1484
  access_code: {
1485
+ /** Unique identifier for the Seam workspace associated with the access code. */
1486
+ workspace_id: string
1485
1487
  /** Unique identifier for a group of access codes that share the same code. */
1486
1488
  common_code_key: string | null
1487
1489
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -2091,6 +2093,8 @@ export type Routes = {
2091
2093
  formData: {}
2092
2094
  jsonResponse: {
2093
2095
  access_codes: {
2096
+ /** Unique identifier for the Seam workspace associated with the access code. */
2097
+ workspace_id: string
2094
2098
  /** Unique identifier for a group of access codes that share the same code. */
2095
2099
  common_code_key: string | null
2096
2100
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -4135,6 +4139,8 @@ export type Routes = {
4135
4139
 
4136
4140
  In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
4137
4141
  access_code: {
4142
+ /** Unique identifier for the Seam workspace associated with the access code. */
4143
+ workspace_id: string
4138
4144
  /** Unique identifier for a group of access codes that share the same code. */
4139
4145
  common_code_key: string | null
4140
4146
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -4717,6 +4723,8 @@ export type Routes = {
4717
4723
  formData: {}
4718
4724
  jsonResponse: {
4719
4725
  access_codes: {
4726
+ /** Unique identifier for the Seam workspace associated with the access code. */
4727
+ workspace_id: string
4720
4728
  /** Unique identifier for a group of access codes that share the same code. */
4721
4729
  common_code_key: string | null
4722
4730
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -5306,6 +5314,8 @@ export type Routes = {
5306
5314
 
5307
5315
  In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
5308
5316
  backup_access_code: {
5317
+ /** Unique identifier for the Seam workspace associated with the access code. */
5318
+ workspace_id: string
5309
5319
  /** Unique identifier for a group of access codes that share the same code. */
5310
5320
  common_code_key: string | null
5311
5321
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -5873,6 +5883,8 @@ export type Routes = {
5873
5883
 
5874
5884
  In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
5875
5885
  access_code: {
5886
+ /** Unique identifier for the Seam workspace associated with the access code. */
5887
+ workspace_id: string
5876
5888
  /** Unique identifier for a group of access codes that share the same code. */
5877
5889
  common_code_key: string | null
5878
5890
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -6479,6 +6491,8 @@ export type Routes = {
6479
6491
 
6480
6492
  - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) */
6481
6493
  access_code: {
6494
+ /** Unique identifier for the Seam workspace associated with the access code. */
6495
+ workspace_id: string
6482
6496
  /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
6483
6497
  type: 'time_bound' | 'ongoing'
6484
6498
  /** Unique identifier for the access code. */
@@ -8510,6 +8524,8 @@ export type Routes = {
8510
8524
 
8511
8525
  - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) */
8512
8526
  access_code: {
8527
+ /** Unique identifier for the Seam workspace associated with the access code. */
8528
+ workspace_id: string
8513
8529
  /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
8514
8530
  type: 'time_bound' | 'ongoing'
8515
8531
  /** Unique identifier for the access code. */
@@ -9071,6 +9087,8 @@ export type Routes = {
9071
9087
  formData: {}
9072
9088
  jsonResponse: {
9073
9089
  access_codes: {
9090
+ /** Unique identifier for the Seam workspace associated with the access code. */
9091
+ workspace_id: string
9074
9092
  /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
9075
9093
  type: 'time_bound' | 'ongoing'
9076
9094
  /** Unique identifier for the access code. */
@@ -12059,46 +12077,8 @@ export type Routes = {
12059
12077
  /** Metadata for a KeyNest device. */
12060
12078
  keynest_metadata?:
12061
12079
  | {
12062
- /** Key ID for a KeyNest device. */
12063
- key_id: string
12064
12080
  /** Device name for a KeyNest device. */
12065
- device_name: string
12066
- /** Property ID for a KeyNest device. */
12067
- property_id: string | null
12068
- /** Property postcode for a KeyNest device. */
12069
- property_postcode: string | null
12070
- /** Key notes for a KeyNest device. */
12071
- key_notes: string | null
12072
- /** Subscription plan for a KeyNest device. */
12073
- subscription_plan: string
12074
- /** Status type for a KeyNest device. */
12075
- status_type: string
12076
- /** Current or last store ID for a KeyNest device. */
12077
- current_or_last_store_id: number
12078
- /** Last movement timestamp for a KeyNest device. */
12079
- last_movement: string
12080
- /** Address for a KeyNest device. */
12081
- address: string | null
12082
- /** Current status for a KeyNest device. */
12083
- current_status: string | null
12084
- /** Current user name for a KeyNest device. */
12085
- current_user_name: string | null
12086
- /** Current user email for a KeyNest device. */
12087
- current_user_email: string | null
12088
- /** Current user phone number for a KeyNest device. */
12089
- current_user_phone_number: string | null
12090
- /** Current user company for a KeyNest device. */
12091
- current_user_company: string | null
12092
- /** Handover method for a KeyNest device. */
12093
- handover_method: string | null
12094
- /** KeyNest app user for a KeyNest device. */
12095
- keynest_app_user: string | null
12096
- /** Default office ID for a KeyNest device. */
12097
- default_office_id: number
12098
- /** Fob ID for a KeyNest device. */
12099
- fob_id: number
12100
- /** Whether the KeyNest device has a photo. */
12101
- has_photo: boolean
12081
+ device_name?: string | undefined
12102
12082
  }
12103
12083
  | undefined
12104
12084
  }) &
@@ -15838,46 +15818,8 @@ export type Routes = {
15838
15818
  /** Metadata for a KeyNest device. */
15839
15819
  keynest_metadata?:
15840
15820
  | {
15841
- /** Key ID for a KeyNest device. */
15842
- key_id: string
15843
15821
  /** Device name for a KeyNest device. */
15844
- device_name: string
15845
- /** Property ID for a KeyNest device. */
15846
- property_id: string | null
15847
- /** Property postcode for a KeyNest device. */
15848
- property_postcode: string | null
15849
- /** Key notes for a KeyNest device. */
15850
- key_notes: string | null
15851
- /** Subscription plan for a KeyNest device. */
15852
- subscription_plan: string
15853
- /** Status type for a KeyNest device. */
15854
- status_type: string
15855
- /** Current or last store ID for a KeyNest device. */
15856
- current_or_last_store_id: number
15857
- /** Last movement timestamp for a KeyNest device. */
15858
- last_movement: string
15859
- /** Address for a KeyNest device. */
15860
- address: string | null
15861
- /** Current status for a KeyNest device. */
15862
- current_status: string | null
15863
- /** Current user name for a KeyNest device. */
15864
- current_user_name: string | null
15865
- /** Current user email for a KeyNest device. */
15866
- current_user_email: string | null
15867
- /** Current user phone number for a KeyNest device. */
15868
- current_user_phone_number: string | null
15869
- /** Current user company for a KeyNest device. */
15870
- current_user_company: string | null
15871
- /** Handover method for a KeyNest device. */
15872
- handover_method: string | null
15873
- /** KeyNest app user for a KeyNest device. */
15874
- keynest_app_user: string | null
15875
- /** Default office ID for a KeyNest device. */
15876
- default_office_id: number
15877
- /** Fob ID for a KeyNest device. */
15878
- fob_id: number
15879
- /** Whether the KeyNest device has a photo. */
15880
- has_photo: boolean
15822
+ device_name?: string | undefined
15881
15823
  }
15882
15824
  | undefined
15883
15825
  }) &
@@ -22208,6 +22150,8 @@ export type Routes = {
22208
22150
  | undefined
22209
22151
  access_codes?:
22210
22152
  | {
22153
+ /** Unique identifier for the Seam workspace associated with the access code. */
22154
+ workspace_id: string
22211
22155
  /** Unique identifier for a group of access codes that share the same code. */
22212
22156
  common_code_key: string | null
22213
22157
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -22770,6 +22714,8 @@ export type Routes = {
22770
22714
  | undefined
22771
22715
  unmanaged_access_codes?:
22772
22716
  | {
22717
+ /** Unique identifier for the Seam workspace associated with the access code. */
22718
+ workspace_id: string
22773
22719
  /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
22774
22720
  type: 'time_bound' | 'ongoing'
22775
22721
  /** Unique identifier for the access code. */
@@ -37170,46 +37116,8 @@ export type Routes = {
37170
37116
  /** Metadata for a KeyNest device. */
37171
37117
  keynest_metadata?:
37172
37118
  | {
37173
- /** Key ID for a KeyNest device. */
37174
- key_id: string
37175
37119
  /** Device name for a KeyNest device. */
37176
- device_name: string
37177
- /** Property ID for a KeyNest device. */
37178
- property_id: string | null
37179
- /** Property postcode for a KeyNest device. */
37180
- property_postcode: string | null
37181
- /** Key notes for a KeyNest device. */
37182
- key_notes: string | null
37183
- /** Subscription plan for a KeyNest device. */
37184
- subscription_plan: string
37185
- /** Status type for a KeyNest device. */
37186
- status_type: string
37187
- /** Current or last store ID for a KeyNest device. */
37188
- current_or_last_store_id: number
37189
- /** Last movement timestamp for a KeyNest device. */
37190
- last_movement: string
37191
- /** Address for a KeyNest device. */
37192
- address: string | null
37193
- /** Current status for a KeyNest device. */
37194
- current_status: string | null
37195
- /** Current user name for a KeyNest device. */
37196
- current_user_name: string | null
37197
- /** Current user email for a KeyNest device. */
37198
- current_user_email: string | null
37199
- /** Current user phone number for a KeyNest device. */
37200
- current_user_phone_number: string | null
37201
- /** Current user company for a KeyNest device. */
37202
- current_user_company: string | null
37203
- /** Handover method for a KeyNest device. */
37204
- handover_method: string | null
37205
- /** KeyNest app user for a KeyNest device. */
37206
- keynest_app_user: string | null
37207
- /** Default office ID for a KeyNest device. */
37208
- default_office_id: number
37209
- /** Fob ID for a KeyNest device. */
37210
- fob_id: number
37211
- /** Whether the KeyNest device has a photo. */
37212
- has_photo: boolean
37120
+ device_name?: string | undefined
37213
37121
  }
37214
37122
  | undefined
37215
37123
  }) &
@@ -38894,46 +38802,8 @@ export type Routes = {
38894
38802
  /** Metadata for a KeyNest device. */
38895
38803
  keynest_metadata?:
38896
38804
  | {
38897
- /** Key ID for a KeyNest device. */
38898
- key_id: string
38899
38805
  /** Device name for a KeyNest device. */
38900
- device_name: string
38901
- /** Property ID for a KeyNest device. */
38902
- property_id: string | null
38903
- /** Property postcode for a KeyNest device. */
38904
- property_postcode: string | null
38905
- /** Key notes for a KeyNest device. */
38906
- key_notes: string | null
38907
- /** Subscription plan for a KeyNest device. */
38908
- subscription_plan: string
38909
- /** Status type for a KeyNest device. */
38910
- status_type: string
38911
- /** Current or last store ID for a KeyNest device. */
38912
- current_or_last_store_id: number
38913
- /** Last movement timestamp for a KeyNest device. */
38914
- last_movement: string
38915
- /** Address for a KeyNest device. */
38916
- address: string | null
38917
- /** Current status for a KeyNest device. */
38918
- current_status: string | null
38919
- /** Current user name for a KeyNest device. */
38920
- current_user_name: string | null
38921
- /** Current user email for a KeyNest device. */
38922
- current_user_email: string | null
38923
- /** Current user phone number for a KeyNest device. */
38924
- current_user_phone_number: string | null
38925
- /** Current user company for a KeyNest device. */
38926
- current_user_company: string | null
38927
- /** Handover method for a KeyNest device. */
38928
- handover_method: string | null
38929
- /** KeyNest app user for a KeyNest device. */
38930
- keynest_app_user: string | null
38931
- /** Default office ID for a KeyNest device. */
38932
- default_office_id: number
38933
- /** Fob ID for a KeyNest device. */
38934
- fob_id: number
38935
- /** Whether the KeyNest device has a photo. */
38936
- has_photo: boolean
38806
+ device_name?: string | undefined
38937
38807
  }
38938
38808
  | undefined
38939
38809
  }) &
@@ -46469,46 +46339,8 @@ export type Routes = {
46469
46339
  /** Metadata for a KeyNest device. */
46470
46340
  keynest_metadata?:
46471
46341
  | {
46472
- /** Key ID for a KeyNest device. */
46473
- key_id: string
46474
46342
  /** Device name for a KeyNest device. */
46475
- device_name: string
46476
- /** Property ID for a KeyNest device. */
46477
- property_id: string | null
46478
- /** Property postcode for a KeyNest device. */
46479
- property_postcode: string | null
46480
- /** Key notes for a KeyNest device. */
46481
- key_notes: string | null
46482
- /** Subscription plan for a KeyNest device. */
46483
- subscription_plan: string
46484
- /** Status type for a KeyNest device. */
46485
- status_type: string
46486
- /** Current or last store ID for a KeyNest device. */
46487
- current_or_last_store_id: number
46488
- /** Last movement timestamp for a KeyNest device. */
46489
- last_movement: string
46490
- /** Address for a KeyNest device. */
46491
- address: string | null
46492
- /** Current status for a KeyNest device. */
46493
- current_status: string | null
46494
- /** Current user name for a KeyNest device. */
46495
- current_user_name: string | null
46496
- /** Current user email for a KeyNest device. */
46497
- current_user_email: string | null
46498
- /** Current user phone number for a KeyNest device. */
46499
- current_user_phone_number: string | null
46500
- /** Current user company for a KeyNest device. */
46501
- current_user_company: string | null
46502
- /** Handover method for a KeyNest device. */
46503
- handover_method: string | null
46504
- /** KeyNest app user for a KeyNest device. */
46505
- keynest_app_user: string | null
46506
- /** Default office ID for a KeyNest device. */
46507
- default_office_id: number
46508
- /** Fob ID for a KeyNest device. */
46509
- fob_id: number
46510
- /** Whether the KeyNest device has a photo. */
46511
- has_photo: boolean
46343
+ device_name?: string | undefined
46512
46344
  }
46513
46345
  | undefined
46514
46346
  }) &
@@ -47978,46 +47810,8 @@ export type Routes = {
47978
47810
  /** Metadata for a KeyNest device. */
47979
47811
  keynest_metadata?:
47980
47812
  | {
47981
- /** Key ID for a KeyNest device. */
47982
- key_id: string
47983
47813
  /** Device name for a KeyNest device. */
47984
- device_name: string
47985
- /** Property ID for a KeyNest device. */
47986
- property_id: string | null
47987
- /** Property postcode for a KeyNest device. */
47988
- property_postcode: string | null
47989
- /** Key notes for a KeyNest device. */
47990
- key_notes: string | null
47991
- /** Subscription plan for a KeyNest device. */
47992
- subscription_plan: string
47993
- /** Status type for a KeyNest device. */
47994
- status_type: string
47995
- /** Current or last store ID for a KeyNest device. */
47996
- current_or_last_store_id: number
47997
- /** Last movement timestamp for a KeyNest device. */
47998
- last_movement: string
47999
- /** Address for a KeyNest device. */
48000
- address: string | null
48001
- /** Current status for a KeyNest device. */
48002
- current_status: string | null
48003
- /** Current user name for a KeyNest device. */
48004
- current_user_name: string | null
48005
- /** Current user email for a KeyNest device. */
48006
- current_user_email: string | null
48007
- /** Current user phone number for a KeyNest device. */
48008
- current_user_phone_number: string | null
48009
- /** Current user company for a KeyNest device. */
48010
- current_user_company: string | null
48011
- /** Handover method for a KeyNest device. */
48012
- handover_method: string | null
48013
- /** KeyNest app user for a KeyNest device. */
48014
- keynest_app_user: string | null
48015
- /** Default office ID for a KeyNest device. */
48016
- default_office_id: number
48017
- /** Fob ID for a KeyNest device. */
48018
- fob_id: number
48019
- /** Whether the KeyNest device has a photo. */
48020
- has_photo: boolean
47814
+ device_name?: string | undefined
48021
47815
  }
48022
47816
  | undefined
48023
47817
  }) &
@@ -49666,46 +49460,8 @@ export type Routes = {
49666
49460
  /** Metadata for a KeyNest device. */
49667
49461
  keynest_metadata?:
49668
49462
  | {
49669
- /** Key ID for a KeyNest device. */
49670
- key_id: string
49671
49463
  /** Device name for a KeyNest device. */
49672
- device_name: string
49673
- /** Property ID for a KeyNest device. */
49674
- property_id: string | null
49675
- /** Property postcode for a KeyNest device. */
49676
- property_postcode: string | null
49677
- /** Key notes for a KeyNest device. */
49678
- key_notes: string | null
49679
- /** Subscription plan for a KeyNest device. */
49680
- subscription_plan: string
49681
- /** Status type for a KeyNest device. */
49682
- status_type: string
49683
- /** Current or last store ID for a KeyNest device. */
49684
- current_or_last_store_id: number
49685
- /** Last movement timestamp for a KeyNest device. */
49686
- last_movement: string
49687
- /** Address for a KeyNest device. */
49688
- address: string | null
49689
- /** Current status for a KeyNest device. */
49690
- current_status: string | null
49691
- /** Current user name for a KeyNest device. */
49692
- current_user_name: string | null
49693
- /** Current user email for a KeyNest device. */
49694
- current_user_email: string | null
49695
- /** Current user phone number for a KeyNest device. */
49696
- current_user_phone_number: string | null
49697
- /** Current user company for a KeyNest device. */
49698
- current_user_company: string | null
49699
- /** Handover method for a KeyNest device. */
49700
- handover_method: string | null
49701
- /** KeyNest app user for a KeyNest device. */
49702
- keynest_app_user: string | null
49703
- /** Default office ID for a KeyNest device. */
49704
- default_office_id: number
49705
- /** Fob ID for a KeyNest device. */
49706
- fob_id: number
49707
- /** Whether the KeyNest device has a photo. */
49708
- has_photo: boolean
49464
+ device_name?: string | undefined
49709
49465
  }
49710
49466
  | undefined
49711
49467
  }) &
@@ -51174,46 +50930,8 @@ export type Routes = {
51174
50930
  /** Metadata for a KeyNest device. */
51175
50931
  keynest_metadata?:
51176
50932
  | {
51177
- /** Key ID for a KeyNest device. */
51178
- key_id: string
51179
50933
  /** Device name for a KeyNest device. */
51180
- device_name: string
51181
- /** Property ID for a KeyNest device. */
51182
- property_id: string | null
51183
- /** Property postcode for a KeyNest device. */
51184
- property_postcode: string | null
51185
- /** Key notes for a KeyNest device. */
51186
- key_notes: string | null
51187
- /** Subscription plan for a KeyNest device. */
51188
- subscription_plan: string
51189
- /** Status type for a KeyNest device. */
51190
- status_type: string
51191
- /** Current or last store ID for a KeyNest device. */
51192
- current_or_last_store_id: number
51193
- /** Last movement timestamp for a KeyNest device. */
51194
- last_movement: string
51195
- /** Address for a KeyNest device. */
51196
- address: string | null
51197
- /** Current status for a KeyNest device. */
51198
- current_status: string | null
51199
- /** Current user name for a KeyNest device. */
51200
- current_user_name: string | null
51201
- /** Current user email for a KeyNest device. */
51202
- current_user_email: string | null
51203
- /** Current user phone number for a KeyNest device. */
51204
- current_user_phone_number: string | null
51205
- /** Current user company for a KeyNest device. */
51206
- current_user_company: string | null
51207
- /** Handover method for a KeyNest device. */
51208
- handover_method: string | null
51209
- /** KeyNest app user for a KeyNest device. */
51210
- keynest_app_user: string | null
51211
- /** Default office ID for a KeyNest device. */
51212
- default_office_id: number
51213
- /** Fob ID for a KeyNest device. */
51214
- fob_id: number
51215
- /** Whether the KeyNest device has a photo. */
51216
- has_photo: boolean
50934
+ device_name?: string | undefined
51217
50935
  }
51218
50936
  | undefined
51219
50937
  }) &
@@ -58533,46 +58251,8 @@ export type Routes = {
58533
58251
  /** Metadata for a KeyNest device. */
58534
58252
  keynest_metadata?:
58535
58253
  | {
58536
- /** Key ID for a KeyNest device. */
58537
- key_id: string
58538
58254
  /** Device name for a KeyNest device. */
58539
- device_name: string
58540
- /** Property ID for a KeyNest device. */
58541
- property_id: string | null
58542
- /** Property postcode for a KeyNest device. */
58543
- property_postcode: string | null
58544
- /** Key notes for a KeyNest device. */
58545
- key_notes: string | null
58546
- /** Subscription plan for a KeyNest device. */
58547
- subscription_plan: string
58548
- /** Status type for a KeyNest device. */
58549
- status_type: string
58550
- /** Current or last store ID for a KeyNest device. */
58551
- current_or_last_store_id: number
58552
- /** Last movement timestamp for a KeyNest device. */
58553
- last_movement: string
58554
- /** Address for a KeyNest device. */
58555
- address: string | null
58556
- /** Current status for a KeyNest device. */
58557
- current_status: string | null
58558
- /** Current user name for a KeyNest device. */
58559
- current_user_name: string | null
58560
- /** Current user email for a KeyNest device. */
58561
- current_user_email: string | null
58562
- /** Current user phone number for a KeyNest device. */
58563
- current_user_phone_number: string | null
58564
- /** Current user company for a KeyNest device. */
58565
- current_user_company: string | null
58566
- /** Handover method for a KeyNest device. */
58567
- handover_method: string | null
58568
- /** KeyNest app user for a KeyNest device. */
58569
- keynest_app_user: string | null
58570
- /** Default office ID for a KeyNest device. */
58571
- default_office_id: number
58572
- /** Fob ID for a KeyNest device. */
58573
- fob_id: number
58574
- /** Whether the KeyNest device has a photo. */
58575
- has_photo: boolean
58255
+ device_name?: string | undefined
58576
58256
  }
58577
58257
  | undefined
58578
58258
  }) &
@@ -60041,46 +59721,8 @@ export type Routes = {
60041
59721
  /** Metadata for a KeyNest device. */
60042
59722
  keynest_metadata?:
60043
59723
  | {
60044
- /** Key ID for a KeyNest device. */
60045
- key_id: string
60046
59724
  /** Device name for a KeyNest device. */
60047
- device_name: string
60048
- /** Property ID for a KeyNest device. */
60049
- property_id: string | null
60050
- /** Property postcode for a KeyNest device. */
60051
- property_postcode: string | null
60052
- /** Key notes for a KeyNest device. */
60053
- key_notes: string | null
60054
- /** Subscription plan for a KeyNest device. */
60055
- subscription_plan: string
60056
- /** Status type for a KeyNest device. */
60057
- status_type: string
60058
- /** Current or last store ID for a KeyNest device. */
60059
- current_or_last_store_id: number
60060
- /** Last movement timestamp for a KeyNest device. */
60061
- last_movement: string
60062
- /** Address for a KeyNest device. */
60063
- address: string | null
60064
- /** Current status for a KeyNest device. */
60065
- current_status: string | null
60066
- /** Current user name for a KeyNest device. */
60067
- current_user_name: string | null
60068
- /** Current user email for a KeyNest device. */
60069
- current_user_email: string | null
60070
- /** Current user phone number for a KeyNest device. */
60071
- current_user_phone_number: string | null
60072
- /** Current user company for a KeyNest device. */
60073
- current_user_company: string | null
60074
- /** Handover method for a KeyNest device. */
60075
- handover_method: string | null
60076
- /** KeyNest app user for a KeyNest device. */
60077
- keynest_app_user: string | null
60078
- /** Default office ID for a KeyNest device. */
60079
- default_office_id: number
60080
- /** Fob ID for a KeyNest device. */
60081
- fob_id: number
60082
- /** Whether the KeyNest device has a photo. */
60083
- has_photo: boolean
59725
+ device_name?: string | undefined
60084
59726
  }
60085
59727
  | undefined
60086
59728
  }) &
@@ -69994,46 +69636,8 @@ export type Routes = {
69994
69636
  /** Metadata for a KeyNest device. */
69995
69637
  keynest_metadata?:
69996
69638
  | {
69997
- /** Key ID for a KeyNest device. */
69998
- key_id: string
69999
69639
  /** Device name for a KeyNest device. */
70000
- device_name: string
70001
- /** Property ID for a KeyNest device. */
70002
- property_id: string | null
70003
- /** Property postcode for a KeyNest device. */
70004
- property_postcode: string | null
70005
- /** Key notes for a KeyNest device. */
70006
- key_notes: string | null
70007
- /** Subscription plan for a KeyNest device. */
70008
- subscription_plan: string
70009
- /** Status type for a KeyNest device. */
70010
- status_type: string
70011
- /** Current or last store ID for a KeyNest device. */
70012
- current_or_last_store_id: number
70013
- /** Last movement timestamp for a KeyNest device. */
70014
- last_movement: string
70015
- /** Address for a KeyNest device. */
70016
- address: string | null
70017
- /** Current status for a KeyNest device. */
70018
- current_status: string | null
70019
- /** Current user name for a KeyNest device. */
70020
- current_user_name: string | null
70021
- /** Current user email for a KeyNest device. */
70022
- current_user_email: string | null
70023
- /** Current user phone number for a KeyNest device. */
70024
- current_user_phone_number: string | null
70025
- /** Current user company for a KeyNest device. */
70026
- current_user_company: string | null
70027
- /** Handover method for a KeyNest device. */
70028
- handover_method: string | null
70029
- /** KeyNest app user for a KeyNest device. */
70030
- keynest_app_user: string | null
70031
- /** Default office ID for a KeyNest device. */
70032
- default_office_id: number
70033
- /** Fob ID for a KeyNest device. */
70034
- fob_id: number
70035
- /** Whether the KeyNest device has a photo. */
70036
- has_photo: boolean
69640
+ device_name?: string | undefined
70037
69641
  }
70038
69642
  | undefined
70039
69643
  }) &
@@ -76548,46 +76152,8 @@ export type Routes = {
76548
76152
  /** Metadata for a KeyNest device. */
76549
76153
  keynest_metadata?:
76550
76154
  | {
76551
- /** Key ID for a KeyNest device. */
76552
- key_id: string
76553
76155
  /** Device name for a KeyNest device. */
76554
- device_name: string
76555
- /** Property ID for a KeyNest device. */
76556
- property_id: string | null
76557
- /** Property postcode for a KeyNest device. */
76558
- property_postcode: string | null
76559
- /** Key notes for a KeyNest device. */
76560
- key_notes: string | null
76561
- /** Subscription plan for a KeyNest device. */
76562
- subscription_plan: string
76563
- /** Status type for a KeyNest device. */
76564
- status_type: string
76565
- /** Current or last store ID for a KeyNest device. */
76566
- current_or_last_store_id: number
76567
- /** Last movement timestamp for a KeyNest device. */
76568
- last_movement: string
76569
- /** Address for a KeyNest device. */
76570
- address: string | null
76571
- /** Current status for a KeyNest device. */
76572
- current_status: string | null
76573
- /** Current user name for a KeyNest device. */
76574
- current_user_name: string | null
76575
- /** Current user email for a KeyNest device. */
76576
- current_user_email: string | null
76577
- /** Current user phone number for a KeyNest device. */
76578
- current_user_phone_number: string | null
76579
- /** Current user company for a KeyNest device. */
76580
- current_user_company: string | null
76581
- /** Handover method for a KeyNest device. */
76582
- handover_method: string | null
76583
- /** KeyNest app user for a KeyNest device. */
76584
- keynest_app_user: string | null
76585
- /** Default office ID for a KeyNest device. */
76586
- default_office_id: number
76587
- /** Fob ID for a KeyNest device. */
76588
- fob_id: number
76589
- /** Whether the KeyNest device has a photo. */
76590
- has_photo: boolean
76156
+ device_name?: string | undefined
76591
76157
  }
76592
76158
  | undefined
76593
76159
  }) &
@@ -81066,46 +80632,8 @@ export type Routes = {
81066
80632
  /** Metadata for a KeyNest device. */
81067
80633
  keynest_metadata?:
81068
80634
  | {
81069
- /** Key ID for a KeyNest device. */
81070
- key_id: string
81071
80635
  /** Device name for a KeyNest device. */
81072
- device_name: string
81073
- /** Property ID for a KeyNest device. */
81074
- property_id: string | null
81075
- /** Property postcode for a KeyNest device. */
81076
- property_postcode: string | null
81077
- /** Key notes for a KeyNest device. */
81078
- key_notes: string | null
81079
- /** Subscription plan for a KeyNest device. */
81080
- subscription_plan: string
81081
- /** Status type for a KeyNest device. */
81082
- status_type: string
81083
- /** Current or last store ID for a KeyNest device. */
81084
- current_or_last_store_id: number
81085
- /** Last movement timestamp for a KeyNest device. */
81086
- last_movement: string
81087
- /** Address for a KeyNest device. */
81088
- address: string | null
81089
- /** Current status for a KeyNest device. */
81090
- current_status: string | null
81091
- /** Current user name for a KeyNest device. */
81092
- current_user_name: string | null
81093
- /** Current user email for a KeyNest device. */
81094
- current_user_email: string | null
81095
- /** Current user phone number for a KeyNest device. */
81096
- current_user_phone_number: string | null
81097
- /** Current user company for a KeyNest device. */
81098
- current_user_company: string | null
81099
- /** Handover method for a KeyNest device. */
81100
- handover_method: string | null
81101
- /** KeyNest app user for a KeyNest device. */
81102
- keynest_app_user: string | null
81103
- /** Default office ID for a KeyNest device. */
81104
- default_office_id: number
81105
- /** Fob ID for a KeyNest device. */
81106
- fob_id: number
81107
- /** Whether the KeyNest device has a photo. */
81108
- has_photo: boolean
80636
+ device_name?: string | undefined
81109
80637
  }
81110
80638
  | undefined
81111
80639
  }) &
@@ -82574,46 +82102,8 @@ export type Routes = {
82574
82102
  /** Metadata for a KeyNest device. */
82575
82103
  keynest_metadata?:
82576
82104
  | {
82577
- /** Key ID for a KeyNest device. */
82578
- key_id: string
82579
82105
  /** Device name for a KeyNest device. */
82580
- device_name: string
82581
- /** Property ID for a KeyNest device. */
82582
- property_id: string | null
82583
- /** Property postcode for a KeyNest device. */
82584
- property_postcode: string | null
82585
- /** Key notes for a KeyNest device. */
82586
- key_notes: string | null
82587
- /** Subscription plan for a KeyNest device. */
82588
- subscription_plan: string
82589
- /** Status type for a KeyNest device. */
82590
- status_type: string
82591
- /** Current or last store ID for a KeyNest device. */
82592
- current_or_last_store_id: number
82593
- /** Last movement timestamp for a KeyNest device. */
82594
- last_movement: string
82595
- /** Address for a KeyNest device. */
82596
- address: string | null
82597
- /** Current status for a KeyNest device. */
82598
- current_status: string | null
82599
- /** Current user name for a KeyNest device. */
82600
- current_user_name: string | null
82601
- /** Current user email for a KeyNest device. */
82602
- current_user_email: string | null
82603
- /** Current user phone number for a KeyNest device. */
82604
- current_user_phone_number: string | null
82605
- /** Current user company for a KeyNest device. */
82606
- current_user_company: string | null
82607
- /** Handover method for a KeyNest device. */
82608
- handover_method: string | null
82609
- /** KeyNest app user for a KeyNest device. */
82610
- keynest_app_user: string | null
82611
- /** Default office ID for a KeyNest device. */
82612
- default_office_id: number
82613
- /** Fob ID for a KeyNest device. */
82614
- fob_id: number
82615
- /** Whether the KeyNest device has a photo. */
82616
- has_photo: boolean
82106
+ device_name?: string | undefined
82617
82107
  }
82618
82108
  | undefined
82619
82109
  }) &
@@ -90799,46 +90289,8 @@ export type Routes = {
90799
90289
  /** Metadata for a KeyNest device. */
90800
90290
  keynest_metadata?:
90801
90291
  | {
90802
- /** Key ID for a KeyNest device. */
90803
- key_id: string
90804
90292
  /** Device name for a KeyNest device. */
90805
- device_name: string
90806
- /** Property ID for a KeyNest device. */
90807
- property_id: string | null
90808
- /** Property postcode for a KeyNest device. */
90809
- property_postcode: string | null
90810
- /** Key notes for a KeyNest device. */
90811
- key_notes: string | null
90812
- /** Subscription plan for a KeyNest device. */
90813
- subscription_plan: string
90814
- /** Status type for a KeyNest device. */
90815
- status_type: string
90816
- /** Current or last store ID for a KeyNest device. */
90817
- current_or_last_store_id: number
90818
- /** Last movement timestamp for a KeyNest device. */
90819
- last_movement: string
90820
- /** Address for a KeyNest device. */
90821
- address: string | null
90822
- /** Current status for a KeyNest device. */
90823
- current_status: string | null
90824
- /** Current user name for a KeyNest device. */
90825
- current_user_name: string | null
90826
- /** Current user email for a KeyNest device. */
90827
- current_user_email: string | null
90828
- /** Current user phone number for a KeyNest device. */
90829
- current_user_phone_number: string | null
90830
- /** Current user company for a KeyNest device. */
90831
- current_user_company: string | null
90832
- /** Handover method for a KeyNest device. */
90833
- handover_method: string | null
90834
- /** KeyNest app user for a KeyNest device. */
90835
- keynest_app_user: string | null
90836
- /** Default office ID for a KeyNest device. */
90837
- default_office_id: number
90838
- /** Fob ID for a KeyNest device. */
90839
- fob_id: number
90840
- /** Whether the KeyNest device has a photo. */
90841
- has_photo: boolean
90293
+ device_name?: string | undefined
90842
90294
  }
90843
90295
  | undefined
90844
90296
  }) &
@@ -92309,46 +91761,8 @@ export type Routes = {
92309
91761
  /** Metadata for a KeyNest device. */
92310
91762
  keynest_metadata?:
92311
91763
  | {
92312
- /** Key ID for a KeyNest device. */
92313
- key_id: string
92314
91764
  /** Device name for a KeyNest device. */
92315
- device_name: string
92316
- /** Property ID for a KeyNest device. */
92317
- property_id: string | null
92318
- /** Property postcode for a KeyNest device. */
92319
- property_postcode: string | null
92320
- /** Key notes for a KeyNest device. */
92321
- key_notes: string | null
92322
- /** Subscription plan for a KeyNest device. */
92323
- subscription_plan: string
92324
- /** Status type for a KeyNest device. */
92325
- status_type: string
92326
- /** Current or last store ID for a KeyNest device. */
92327
- current_or_last_store_id: number
92328
- /** Last movement timestamp for a KeyNest device. */
92329
- last_movement: string
92330
- /** Address for a KeyNest device. */
92331
- address: string | null
92332
- /** Current status for a KeyNest device. */
92333
- current_status: string | null
92334
- /** Current user name for a KeyNest device. */
92335
- current_user_name: string | null
92336
- /** Current user email for a KeyNest device. */
92337
- current_user_email: string | null
92338
- /** Current user phone number for a KeyNest device. */
92339
- current_user_phone_number: string | null
92340
- /** Current user company for a KeyNest device. */
92341
- current_user_company: string | null
92342
- /** Handover method for a KeyNest device. */
92343
- handover_method: string | null
92344
- /** KeyNest app user for a KeyNest device. */
92345
- keynest_app_user: string | null
92346
- /** Default office ID for a KeyNest device. */
92347
- default_office_id: number
92348
- /** Fob ID for a KeyNest device. */
92349
- fob_id: number
92350
- /** Whether the KeyNest device has a photo. */
92351
- has_photo: boolean
91765
+ device_name?: string | undefined
92352
91766
  }
92353
91767
  | undefined
92354
91768
  }) &
@@ -94670,46 +94084,8 @@ export type Routes = {
94670
94084
  /** Metadata for a KeyNest device. */
94671
94085
  keynest_metadata?:
94672
94086
  | {
94673
- /** Key ID for a KeyNest device. */
94674
- key_id: string
94675
94087
  /** Device name for a KeyNest device. */
94676
- device_name: string
94677
- /** Property ID for a KeyNest device. */
94678
- property_id: string | null
94679
- /** Property postcode for a KeyNest device. */
94680
- property_postcode: string | null
94681
- /** Key notes for a KeyNest device. */
94682
- key_notes: string | null
94683
- /** Subscription plan for a KeyNest device. */
94684
- subscription_plan: string
94685
- /** Status type for a KeyNest device. */
94686
- status_type: string
94687
- /** Current or last store ID for a KeyNest device. */
94688
- current_or_last_store_id: number
94689
- /** Last movement timestamp for a KeyNest device. */
94690
- last_movement: string
94691
- /** Address for a KeyNest device. */
94692
- address: string | null
94693
- /** Current status for a KeyNest device. */
94694
- current_status: string | null
94695
- /** Current user name for a KeyNest device. */
94696
- current_user_name: string | null
94697
- /** Current user email for a KeyNest device. */
94698
- current_user_email: string | null
94699
- /** Current user phone number for a KeyNest device. */
94700
- current_user_phone_number: string | null
94701
- /** Current user company for a KeyNest device. */
94702
- current_user_company: string | null
94703
- /** Handover method for a KeyNest device. */
94704
- handover_method: string | null
94705
- /** KeyNest app user for a KeyNest device. */
94706
- keynest_app_user: string | null
94707
- /** Default office ID for a KeyNest device. */
94708
- default_office_id: number
94709
- /** Fob ID for a KeyNest device. */
94710
- fob_id: number
94711
- /** Whether the KeyNest device has a photo. */
94712
- has_photo: boolean
94088
+ device_name?: string | undefined
94713
94089
  }
94714
94090
  | undefined
94715
94091
  }) &
@@ -101040,6 +100416,8 @@ export type Routes = {
101040
100416
  | undefined
101041
100417
  access_codes?:
101042
100418
  | {
100419
+ /** Unique identifier for the Seam workspace associated with the access code. */
100420
+ workspace_id: string
101043
100421
  /** Unique identifier for a group of access codes that share the same code. */
101044
100422
  common_code_key: string | null
101045
100423
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -101602,6 +100980,8 @@ export type Routes = {
101602
100980
  | undefined
101603
100981
  unmanaged_access_codes?:
101604
100982
  | {
100983
+ /** Unique identifier for the Seam workspace associated with the access code. */
100984
+ workspace_id: string
101605
100985
  /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
101606
100986
  type: 'time_bound' | 'ongoing'
101607
100987
  /** Unique identifier for the access code. */