@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/lib/seam/connect/route-types.d.ts CHANGED
@@ -1301,6 +1301,8 @@ export type Routes = {
1301
1301
 
1302
1302
  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. */
1303
1303
  access_code: {
1304
+ /** Unique identifier for the Seam workspace associated with the access code. */
1305
+ workspace_id: string;
1304
1306
  /** Unique identifier for a group of access codes that share the same code. */
1305
1307
  common_code_key: string | null;
1306
1308
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -1855,6 +1857,8 @@ export type Routes = {
1855
1857
  formData: {};
1856
1858
  jsonResponse: {
1857
1859
  access_codes: {
1860
+ /** Unique identifier for the Seam workspace associated with the access code. */
1861
+ workspace_id: string;
1858
1862
  /** Unique identifier for a group of access codes that share the same code. */
1859
1863
  common_code_key: string | null;
1860
1864
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -3663,6 +3667,8 @@ export type Routes = {
3663
3667
 
3664
3668
  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. */
3665
3669
  access_code: {
3670
+ /** Unique identifier for the Seam workspace associated with the access code. */
3671
+ workspace_id: string;
3666
3672
  /** Unique identifier for a group of access codes that share the same code. */
3667
3673
  common_code_key: string | null;
3668
3674
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -4190,6 +4196,8 @@ export type Routes = {
4190
4196
  formData: {};
4191
4197
  jsonResponse: {
4192
4198
  access_codes: {
4199
+ /** Unique identifier for the Seam workspace associated with the access code. */
4200
+ workspace_id: string;
4193
4201
  /** Unique identifier for a group of access codes that share the same code. */
4194
4202
  common_code_key: string | null;
4195
4203
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -4724,6 +4732,8 @@ export type Routes = {
4724
4732
 
4725
4733
  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. */
4726
4734
  backup_access_code: {
4735
+ /** Unique identifier for the Seam workspace associated with the access code. */
4736
+ workspace_id: string;
4727
4737
  /** Unique identifier for a group of access codes that share the same code. */
4728
4738
  common_code_key: string | null;
4729
4739
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -5236,6 +5246,8 @@ export type Routes = {
5236
5246
 
5237
5247
  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. */
5238
5248
  access_code: {
5249
+ /** Unique identifier for the Seam workspace associated with the access code. */
5250
+ workspace_id: string;
5239
5251
  /** Unique identifier for a group of access codes that share the same code. */
5240
5252
  common_code_key: string | null;
5241
5253
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -5787,6 +5799,8 @@ export type Routes = {
5787
5799
 
5788
5800
  - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) */
5789
5801
  access_code: {
5802
+ /** Unique identifier for the Seam workspace associated with the access code. */
5803
+ workspace_id: string;
5790
5804
  /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
5791
5805
  type: 'time_bound' | 'ongoing';
5792
5806
  /** Unique identifier for the access code. */
@@ -7582,6 +7596,8 @@ export type Routes = {
7582
7596
 
7583
7597
  - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) */
7584
7598
  access_code: {
7599
+ /** Unique identifier for the Seam workspace associated with the access code. */
7600
+ workspace_id: string;
7585
7601
  /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
7586
7602
  type: 'time_bound' | 'ongoing';
7587
7603
  /** Unique identifier for the access code. */
@@ -8088,6 +8104,8 @@ export type Routes = {
8088
8104
  formData: {};
8089
8105
  jsonResponse: {
8090
8106
  access_codes: {
8107
+ /** Unique identifier for the Seam workspace associated with the access code. */
8108
+ workspace_id: string;
8091
8109
  /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
8092
8110
  type: 'time_bound' | 'ongoing';
8093
8111
  /** Unique identifier for the access code. */
@@ -10679,46 +10697,8 @@ export type Routes = {
10679
10697
  } | undefined;
10680
10698
  /** Metadata for a KeyNest device. */
10681
10699
  keynest_metadata?: {
10682
- /** Key ID for a KeyNest device. */
10683
- key_id: string;
10684
10700
  /** Device name for a KeyNest device. */
10685
- device_name: string;
10686
- /** Property ID for a KeyNest device. */
10687
- property_id: string | null;
10688
- /** Property postcode for a KeyNest device. */
10689
- property_postcode: string | null;
10690
- /** Key notes for a KeyNest device. */
10691
- key_notes: string | null;
10692
- /** Subscription plan for a KeyNest device. */
10693
- subscription_plan: string;
10694
- /** Status type for a KeyNest device. */
10695
- status_type: string;
10696
- /** Current or last store ID for a KeyNest device. */
10697
- current_or_last_store_id: number;
10698
- /** Last movement timestamp for a KeyNest device. */
10699
- last_movement: string;
10700
- /** Address for a KeyNest device. */
10701
- address: string | null;
10702
- /** Current status for a KeyNest device. */
10703
- current_status: string | null;
10704
- /** Current user name for a KeyNest device. */
10705
- current_user_name: string | null;
10706
- /** Current user email for a KeyNest device. */
10707
- current_user_email: string | null;
10708
- /** Current user phone number for a KeyNest device. */
10709
- current_user_phone_number: string | null;
10710
- /** Current user company for a KeyNest device. */
10711
- current_user_company: string | null;
10712
- /** Handover method for a KeyNest device. */
10713
- handover_method: string | null;
10714
- /** KeyNest app user for a KeyNest device. */
10715
- keynest_app_user: string | null;
10716
- /** Default office ID for a KeyNest device. */
10717
- default_office_id: number;
10718
- /** Fob ID for a KeyNest device. */
10719
- fob_id: number;
10720
- /** Whether the KeyNest device has a photo. */
10721
- has_photo: boolean;
10701
+ device_name?: string | undefined;
10722
10702
  } | undefined;
10723
10703
  }) & ({
10724
10704
  /** */
@@ -13827,46 +13807,8 @@ export type Routes = {
13827
13807
  } | undefined;
13828
13808
  /** Metadata for a KeyNest device. */
13829
13809
  keynest_metadata?: {
13830
- /** Key ID for a KeyNest device. */
13831
- key_id: string;
13832
13810
  /** Device name for a KeyNest device. */
13833
- device_name: string;
13834
- /** Property ID for a KeyNest device. */
13835
- property_id: string | null;
13836
- /** Property postcode for a KeyNest device. */
13837
- property_postcode: string | null;
13838
- /** Key notes for a KeyNest device. */
13839
- key_notes: string | null;
13840
- /** Subscription plan for a KeyNest device. */
13841
- subscription_plan: string;
13842
- /** Status type for a KeyNest device. */
13843
- status_type: string;
13844
- /** Current or last store ID for a KeyNest device. */
13845
- current_or_last_store_id: number;
13846
- /** Last movement timestamp for a KeyNest device. */
13847
- last_movement: string;
13848
- /** Address for a KeyNest device. */
13849
- address: string | null;
13850
- /** Current status for a KeyNest device. */
13851
- current_status: string | null;
13852
- /** Current user name for a KeyNest device. */
13853
- current_user_name: string | null;
13854
- /** Current user email for a KeyNest device. */
13855
- current_user_email: string | null;
13856
- /** Current user phone number for a KeyNest device. */
13857
- current_user_phone_number: string | null;
13858
- /** Current user company for a KeyNest device. */
13859
- current_user_company: string | null;
13860
- /** Handover method for a KeyNest device. */
13861
- handover_method: string | null;
13862
- /** KeyNest app user for a KeyNest device. */
13863
- keynest_app_user: string | null;
13864
- /** Default office ID for a KeyNest device. */
13865
- default_office_id: number;
13866
- /** Fob ID for a KeyNest device. */
13867
- fob_id: number;
13868
- /** Whether the KeyNest device has a photo. */
13869
- has_photo: boolean;
13811
+ device_name?: string | undefined;
13870
13812
  } | undefined;
13871
13813
  }) & ({
13872
13814
  /** */
@@ -19106,6 +19048,8 @@ export type Routes = {
19106
19048
  } | undefined;
19107
19049
  }[] | undefined;
19108
19050
  access_codes?: {
19051
+ /** Unique identifier for the Seam workspace associated with the access code. */
19052
+ workspace_id: string;
19109
19053
  /** Unique identifier for a group of access codes that share the same code. */
19110
19054
  common_code_key: string | null;
19111
19055
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -19611,6 +19555,8 @@ export type Routes = {
19611
19555
  is_offline_access_code: boolean;
19612
19556
  }[] | undefined;
19613
19557
  unmanaged_access_codes?: {
19558
+ /** Unique identifier for the Seam workspace associated with the access code. */
19559
+ workspace_id: string;
19614
19560
  /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
19615
19561
  type: 'time_bound' | 'ongoing';
19616
19562
  /** Unique identifier for the access code. */
@@ -32067,46 +32013,8 @@ export type Routes = {
32067
32013
  } | undefined;
32068
32014
  /** Metadata for a KeyNest device. */
32069
32015
  keynest_metadata?: {
32070
- /** Key ID for a KeyNest device. */
32071
- key_id: string;
32072
32016
  /** Device name for a KeyNest device. */
32073
- device_name: string;
32074
- /** Property ID for a KeyNest device. */
32075
- property_id: string | null;
32076
- /** Property postcode for a KeyNest device. */
32077
- property_postcode: string | null;
32078
- /** Key notes for a KeyNest device. */
32079
- key_notes: string | null;
32080
- /** Subscription plan for a KeyNest device. */
32081
- subscription_plan: string;
32082
- /** Status type for a KeyNest device. */
32083
- status_type: string;
32084
- /** Current or last store ID for a KeyNest device. */
32085
- current_or_last_store_id: number;
32086
- /** Last movement timestamp for a KeyNest device. */
32087
- last_movement: string;
32088
- /** Address for a KeyNest device. */
32089
- address: string | null;
32090
- /** Current status for a KeyNest device. */
32091
- current_status: string | null;
32092
- /** Current user name for a KeyNest device. */
32093
- current_user_name: string | null;
32094
- /** Current user email for a KeyNest device. */
32095
- current_user_email: string | null;
32096
- /** Current user phone number for a KeyNest device. */
32097
- current_user_phone_number: string | null;
32098
- /** Current user company for a KeyNest device. */
32099
- current_user_company: string | null;
32100
- /** Handover method for a KeyNest device. */
32101
- handover_method: string | null;
32102
- /** KeyNest app user for a KeyNest device. */
32103
- keynest_app_user: string | null;
32104
- /** Default office ID for a KeyNest device. */
32105
- default_office_id: number;
32106
- /** Fob ID for a KeyNest device. */
32107
- fob_id: number;
32108
- /** Whether the KeyNest device has a photo. */
32109
- has_photo: boolean;
32017
+ device_name?: string | undefined;
32110
32018
  } | undefined;
32111
32019
  }) & ({
32112
32020
  /** */
@@ -33323,46 +33231,8 @@ export type Routes = {
33323
33231
  } | undefined;
33324
33232
  /** Metadata for a KeyNest device. */
33325
33233
  keynest_metadata?: {
33326
- /** Key ID for a KeyNest device. */
33327
- key_id: string;
33328
33234
  /** Device name for a KeyNest device. */
33329
- device_name: string;
33330
- /** Property ID for a KeyNest device. */
33331
- property_id: string | null;
33332
- /** Property postcode for a KeyNest device. */
33333
- property_postcode: string | null;
33334
- /** Key notes for a KeyNest device. */
33335
- key_notes: string | null;
33336
- /** Subscription plan for a KeyNest device. */
33337
- subscription_plan: string;
33338
- /** Status type for a KeyNest device. */
33339
- status_type: string;
33340
- /** Current or last store ID for a KeyNest device. */
33341
- current_or_last_store_id: number;
33342
- /** Last movement timestamp for a KeyNest device. */
33343
- last_movement: string;
33344
- /** Address for a KeyNest device. */
33345
- address: string | null;
33346
- /** Current status for a KeyNest device. */
33347
- current_status: string | null;
33348
- /** Current user name for a KeyNest device. */
33349
- current_user_name: string | null;
33350
- /** Current user email for a KeyNest device. */
33351
- current_user_email: string | null;
33352
- /** Current user phone number for a KeyNest device. */
33353
- current_user_phone_number: string | null;
33354
- /** Current user company for a KeyNest device. */
33355
- current_user_company: string | null;
33356
- /** Handover method for a KeyNest device. */
33357
- handover_method: string | null;
33358
- /** KeyNest app user for a KeyNest device. */
33359
- keynest_app_user: string | null;
33360
- /** Default office ID for a KeyNest device. */
33361
- default_office_id: number;
33362
- /** Fob ID for a KeyNest device. */
33363
- fob_id: number;
33364
- /** Whether the KeyNest device has a photo. */
33365
- has_photo: boolean;
33235
+ device_name?: string | undefined;
33366
33236
  } | undefined;
33367
33237
  }) & ({
33368
33238
  /** */
@@ -39339,46 +39209,8 @@ export type Routes = {
39339
39209
  } | undefined;
39340
39210
  /** Metadata for a KeyNest device. */
39341
39211
  keynest_metadata?: {
39342
- /** Key ID for a KeyNest device. */
39343
- key_id: string;
39344
39212
  /** Device name for a KeyNest device. */
39345
- device_name: string;
39346
- /** Property ID for a KeyNest device. */
39347
- property_id: string | null;
39348
- /** Property postcode for a KeyNest device. */
39349
- property_postcode: string | null;
39350
- /** Key notes for a KeyNest device. */
39351
- key_notes: string | null;
39352
- /** Subscription plan for a KeyNest device. */
39353
- subscription_plan: string;
39354
- /** Status type for a KeyNest device. */
39355
- status_type: string;
39356
- /** Current or last store ID for a KeyNest device. */
39357
- current_or_last_store_id: number;
39358
- /** Last movement timestamp for a KeyNest device. */
39359
- last_movement: string;
39360
- /** Address for a KeyNest device. */
39361
- address: string | null;
39362
- /** Current status for a KeyNest device. */
39363
- current_status: string | null;
39364
- /** Current user name for a KeyNest device. */
39365
- current_user_name: string | null;
39366
- /** Current user email for a KeyNest device. */
39367
- current_user_email: string | null;
39368
- /** Current user phone number for a KeyNest device. */
39369
- current_user_phone_number: string | null;
39370
- /** Current user company for a KeyNest device. */
39371
- current_user_company: string | null;
39372
- /** Handover method for a KeyNest device. */
39373
- handover_method: string | null;
39374
- /** KeyNest app user for a KeyNest device. */
39375
- keynest_app_user: string | null;
39376
- /** Default office ID for a KeyNest device. */
39377
- default_office_id: number;
39378
- /** Fob ID for a KeyNest device. */
39379
- fob_id: number;
39380
- /** Whether the KeyNest device has a photo. */
39381
- has_photo: boolean;
39213
+ device_name?: string | undefined;
39382
39214
  } | undefined;
39383
39215
  }) & ({
39384
39216
  /** */
@@ -40545,46 +40377,8 @@ export type Routes = {
40545
40377
  } | undefined;
40546
40378
  /** Metadata for a KeyNest device. */
40547
40379
  keynest_metadata?: {
40548
- /** Key ID for a KeyNest device. */
40549
- key_id: string;
40550
40380
  /** Device name for a KeyNest device. */
40551
- device_name: string;
40552
- /** Property ID for a KeyNest device. */
40553
- property_id: string | null;
40554
- /** Property postcode for a KeyNest device. */
40555
- property_postcode: string | null;
40556
- /** Key notes for a KeyNest device. */
40557
- key_notes: string | null;
40558
- /** Subscription plan for a KeyNest device. */
40559
- subscription_plan: string;
40560
- /** Status type for a KeyNest device. */
40561
- status_type: string;
40562
- /** Current or last store ID for a KeyNest device. */
40563
- current_or_last_store_id: number;
40564
- /** Last movement timestamp for a KeyNest device. */
40565
- last_movement: string;
40566
- /** Address for a KeyNest device. */
40567
- address: string | null;
40568
- /** Current status for a KeyNest device. */
40569
- current_status: string | null;
40570
- /** Current user name for a KeyNest device. */
40571
- current_user_name: string | null;
40572
- /** Current user email for a KeyNest device. */
40573
- current_user_email: string | null;
40574
- /** Current user phone number for a KeyNest device. */
40575
- current_user_phone_number: string | null;
40576
- /** Current user company for a KeyNest device. */
40577
- current_user_company: string | null;
40578
- /** Handover method for a KeyNest device. */
40579
- handover_method: string | null;
40580
- /** KeyNest app user for a KeyNest device. */
40581
- keynest_app_user: string | null;
40582
- /** Default office ID for a KeyNest device. */
40583
- default_office_id: number;
40584
- /** Fob ID for a KeyNest device. */
40585
- fob_id: number;
40586
- /** Whether the KeyNest device has a photo. */
40587
- has_photo: boolean;
40381
+ device_name?: string | undefined;
40588
40382
  } | undefined;
40589
40383
  }) & ({
40590
40384
  /** */
@@ -41801,46 +41595,8 @@ export type Routes = {
41801
41595
  } | undefined;
41802
41596
  /** Metadata for a KeyNest device. */
41803
41597
  keynest_metadata?: {
41804
- /** Key ID for a KeyNest device. */
41805
- key_id: string;
41806
41598
  /** Device name for a KeyNest device. */
41807
- device_name: string;
41808
- /** Property ID for a KeyNest device. */
41809
- property_id: string | null;
41810
- /** Property postcode for a KeyNest device. */
41811
- property_postcode: string | null;
41812
- /** Key notes for a KeyNest device. */
41813
- key_notes: string | null;
41814
- /** Subscription plan for a KeyNest device. */
41815
- subscription_plan: string;
41816
- /** Status type for a KeyNest device. */
41817
- status_type: string;
41818
- /** Current or last store ID for a KeyNest device. */
41819
- current_or_last_store_id: number;
41820
- /** Last movement timestamp for a KeyNest device. */
41821
- last_movement: string;
41822
- /** Address for a KeyNest device. */
41823
- address: string | null;
41824
- /** Current status for a KeyNest device. */
41825
- current_status: string | null;
41826
- /** Current user name for a KeyNest device. */
41827
- current_user_name: string | null;
41828
- /** Current user email for a KeyNest device. */
41829
- current_user_email: string | null;
41830
- /** Current user phone number for a KeyNest device. */
41831
- current_user_phone_number: string | null;
41832
- /** Current user company for a KeyNest device. */
41833
- current_user_company: string | null;
41834
- /** Handover method for a KeyNest device. */
41835
- handover_method: string | null;
41836
- /** KeyNest app user for a KeyNest device. */
41837
- keynest_app_user: string | null;
41838
- /** Default office ID for a KeyNest device. */
41839
- default_office_id: number;
41840
- /** Fob ID for a KeyNest device. */
41841
- fob_id: number;
41842
- /** Whether the KeyNest device has a photo. */
41843
- has_photo: boolean;
41599
+ device_name?: string | undefined;
41844
41600
  } | undefined;
41845
41601
  }) & ({
41846
41602
  /** */
@@ -43006,46 +42762,8 @@ export type Routes = {
43006
42762
  } | undefined;
43007
42763
  /** Metadata for a KeyNest device. */
43008
42764
  keynest_metadata?: {
43009
- /** Key ID for a KeyNest device. */
43010
- key_id: string;
43011
42765
  /** Device name for a KeyNest device. */
43012
- device_name: string;
43013
- /** Property ID for a KeyNest device. */
43014
- property_id: string | null;
43015
- /** Property postcode for a KeyNest device. */
43016
- property_postcode: string | null;
43017
- /** Key notes for a KeyNest device. */
43018
- key_notes: string | null;
43019
- /** Subscription plan for a KeyNest device. */
43020
- subscription_plan: string;
43021
- /** Status type for a KeyNest device. */
43022
- status_type: string;
43023
- /** Current or last store ID for a KeyNest device. */
43024
- current_or_last_store_id: number;
43025
- /** Last movement timestamp for a KeyNest device. */
43026
- last_movement: string;
43027
- /** Address for a KeyNest device. */
43028
- address: string | null;
43029
- /** Current status for a KeyNest device. */
43030
- current_status: string | null;
43031
- /** Current user name for a KeyNest device. */
43032
- current_user_name: string | null;
43033
- /** Current user email for a KeyNest device. */
43034
- current_user_email: string | null;
43035
- /** Current user phone number for a KeyNest device. */
43036
- current_user_phone_number: string | null;
43037
- /** Current user company for a KeyNest device. */
43038
- current_user_company: string | null;
43039
- /** Handover method for a KeyNest device. */
43040
- handover_method: string | null;
43041
- /** KeyNest app user for a KeyNest device. */
43042
- keynest_app_user: string | null;
43043
- /** Default office ID for a KeyNest device. */
43044
- default_office_id: number;
43045
- /** Fob ID for a KeyNest device. */
43046
- fob_id: number;
43047
- /** Whether the KeyNest device has a photo. */
43048
- has_photo: boolean;
42766
+ device_name?: string | undefined;
43049
42767
  } | undefined;
43050
42768
  }) & ({
43051
42769
  /** */
@@ -49300,46 +49018,8 @@ export type Routes = {
49300
49018
  } | undefined;
49301
49019
  /** Metadata for a KeyNest device. */
49302
49020
  keynest_metadata?: {
49303
- /** Key ID for a KeyNest device. */
49304
- key_id: string;
49305
49021
  /** Device name for a KeyNest device. */
49306
- device_name: string;
49307
- /** Property ID for a KeyNest device. */
49308
- property_id: string | null;
49309
- /** Property postcode for a KeyNest device. */
49310
- property_postcode: string | null;
49311
- /** Key notes for a KeyNest device. */
49312
- key_notes: string | null;
49313
- /** Subscription plan for a KeyNest device. */
49314
- subscription_plan: string;
49315
- /** Status type for a KeyNest device. */
49316
- status_type: string;
49317
- /** Current or last store ID for a KeyNest device. */
49318
- current_or_last_store_id: number;
49319
- /** Last movement timestamp for a KeyNest device. */
49320
- last_movement: string;
49321
- /** Address for a KeyNest device. */
49322
- address: string | null;
49323
- /** Current status for a KeyNest device. */
49324
- current_status: string | null;
49325
- /** Current user name for a KeyNest device. */
49326
- current_user_name: string | null;
49327
- /** Current user email for a KeyNest device. */
49328
- current_user_email: string | null;
49329
- /** Current user phone number for a KeyNest device. */
49330
- current_user_phone_number: string | null;
49331
- /** Current user company for a KeyNest device. */
49332
- current_user_company: string | null;
49333
- /** Handover method for a KeyNest device. */
49334
- handover_method: string | null;
49335
- /** KeyNest app user for a KeyNest device. */
49336
- keynest_app_user: string | null;
49337
- /** Default office ID for a KeyNest device. */
49338
- default_office_id: number;
49339
- /** Fob ID for a KeyNest device. */
49340
- fob_id: number;
49341
- /** Whether the KeyNest device has a photo. */
49342
- has_photo: boolean;
49022
+ device_name?: string | undefined;
49343
49023
  } | undefined;
49344
49024
  }) & ({
49345
49025
  /** */
@@ -50505,46 +50185,8 @@ export type Routes = {
50505
50185
  } | undefined;
50506
50186
  /** Metadata for a KeyNest device. */
50507
50187
  keynest_metadata?: {
50508
- /** Key ID for a KeyNest device. */
50509
- key_id: string;
50510
50188
  /** Device name for a KeyNest device. */
50511
- device_name: string;
50512
- /** Property ID for a KeyNest device. */
50513
- property_id: string | null;
50514
- /** Property postcode for a KeyNest device. */
50515
- property_postcode: string | null;
50516
- /** Key notes for a KeyNest device. */
50517
- key_notes: string | null;
50518
- /** Subscription plan for a KeyNest device. */
50519
- subscription_plan: string;
50520
- /** Status type for a KeyNest device. */
50521
- status_type: string;
50522
- /** Current or last store ID for a KeyNest device. */
50523
- current_or_last_store_id: number;
50524
- /** Last movement timestamp for a KeyNest device. */
50525
- last_movement: string;
50526
- /** Address for a KeyNest device. */
50527
- address: string | null;
50528
- /** Current status for a KeyNest device. */
50529
- current_status: string | null;
50530
- /** Current user name for a KeyNest device. */
50531
- current_user_name: string | null;
50532
- /** Current user email for a KeyNest device. */
50533
- current_user_email: string | null;
50534
- /** Current user phone number for a KeyNest device. */
50535
- current_user_phone_number: string | null;
50536
- /** Current user company for a KeyNest device. */
50537
- current_user_company: string | null;
50538
- /** Handover method for a KeyNest device. */
50539
- handover_method: string | null;
50540
- /** KeyNest app user for a KeyNest device. */
50541
- keynest_app_user: string | null;
50542
- /** Default office ID for a KeyNest device. */
50543
- default_office_id: number;
50544
- /** Fob ID for a KeyNest device. */
50545
- fob_id: number;
50546
- /** Whether the KeyNest device has a photo. */
50547
- has_photo: boolean;
50189
+ device_name?: string | undefined;
50548
50190
  } | undefined;
50549
50191
  }) & ({
50550
50192
  /** */
@@ -58904,46 +58546,8 @@ export type Routes = {
58904
58546
  } | undefined;
58905
58547
  /** Metadata for a KeyNest device. */
58906
58548
  keynest_metadata?: {
58907
- /** Key ID for a KeyNest device. */
58908
- key_id: string;
58909
58549
  /** Device name for a KeyNest device. */
58910
- device_name: string;
58911
- /** Property ID for a KeyNest device. */
58912
- property_id: string | null;
58913
- /** Property postcode for a KeyNest device. */
58914
- property_postcode: string | null;
58915
- /** Key notes for a KeyNest device. */
58916
- key_notes: string | null;
58917
- /** Subscription plan for a KeyNest device. */
58918
- subscription_plan: string;
58919
- /** Status type for a KeyNest device. */
58920
- status_type: string;
58921
- /** Current or last store ID for a KeyNest device. */
58922
- current_or_last_store_id: number;
58923
- /** Last movement timestamp for a KeyNest device. */
58924
- last_movement: string;
58925
- /** Address for a KeyNest device. */
58926
- address: string | null;
58927
- /** Current status for a KeyNest device. */
58928
- current_status: string | null;
58929
- /** Current user name for a KeyNest device. */
58930
- current_user_name: string | null;
58931
- /** Current user email for a KeyNest device. */
58932
- current_user_email: string | null;
58933
- /** Current user phone number for a KeyNest device. */
58934
- current_user_phone_number: string | null;
58935
- /** Current user company for a KeyNest device. */
58936
- current_user_company: string | null;
58937
- /** Handover method for a KeyNest device. */
58938
- handover_method: string | null;
58939
- /** KeyNest app user for a KeyNest device. */
58940
- keynest_app_user: string | null;
58941
- /** Default office ID for a KeyNest device. */
58942
- default_office_id: number;
58943
- /** Fob ID for a KeyNest device. */
58944
- fob_id: number;
58945
- /** Whether the KeyNest device has a photo. */
58946
- has_photo: boolean;
58550
+ device_name?: string | undefined;
58947
58551
  } | undefined;
58948
58552
  }) & ({
58949
58553
  /** */
@@ -64490,46 +64094,8 @@ export type Routes = {
64490
64094
  } | undefined;
64491
64095
  /** Metadata for a KeyNest device. */
64492
64096
  keynest_metadata?: {
64493
- /** Key ID for a KeyNest device. */
64494
- key_id: string;
64495
64097
  /** Device name for a KeyNest device. */
64496
- device_name: string;
64497
- /** Property ID for a KeyNest device. */
64498
- property_id: string | null;
64499
- /** Property postcode for a KeyNest device. */
64500
- property_postcode: string | null;
64501
- /** Key notes for a KeyNest device. */
64502
- key_notes: string | null;
64503
- /** Subscription plan for a KeyNest device. */
64504
- subscription_plan: string;
64505
- /** Status type for a KeyNest device. */
64506
- status_type: string;
64507
- /** Current or last store ID for a KeyNest device. */
64508
- current_or_last_store_id: number;
64509
- /** Last movement timestamp for a KeyNest device. */
64510
- last_movement: string;
64511
- /** Address for a KeyNest device. */
64512
- address: string | null;
64513
- /** Current status for a KeyNest device. */
64514
- current_status: string | null;
64515
- /** Current user name for a KeyNest device. */
64516
- current_user_name: string | null;
64517
- /** Current user email for a KeyNest device. */
64518
- current_user_email: string | null;
64519
- /** Current user phone number for a KeyNest device. */
64520
- current_user_phone_number: string | null;
64521
- /** Current user company for a KeyNest device. */
64522
- current_user_company: string | null;
64523
- /** Handover method for a KeyNest device. */
64524
- handover_method: string | null;
64525
- /** KeyNest app user for a KeyNest device. */
64526
- keynest_app_user: string | null;
64527
- /** Default office ID for a KeyNest device. */
64528
- default_office_id: number;
64529
- /** Fob ID for a KeyNest device. */
64530
- fob_id: number;
64531
- /** Whether the KeyNest device has a photo. */
64532
- has_photo: boolean;
64098
+ device_name?: string | undefined;
64533
64099
  } | undefined;
64534
64100
  }) & ({
64535
64101
  /** */
@@ -68278,46 +67844,8 @@ export type Routes = {
68278
67844
  } | undefined;
68279
67845
  /** Metadata for a KeyNest device. */
68280
67846
  keynest_metadata?: {
68281
- /** Key ID for a KeyNest device. */
68282
- key_id: string;
68283
67847
  /** Device name for a KeyNest device. */
68284
- device_name: string;
68285
- /** Property ID for a KeyNest device. */
68286
- property_id: string | null;
68287
- /** Property postcode for a KeyNest device. */
68288
- property_postcode: string | null;
68289
- /** Key notes for a KeyNest device. */
68290
- key_notes: string | null;
68291
- /** Subscription plan for a KeyNest device. */
68292
- subscription_plan: string;
68293
- /** Status type for a KeyNest device. */
68294
- status_type: string;
68295
- /** Current or last store ID for a KeyNest device. */
68296
- current_or_last_store_id: number;
68297
- /** Last movement timestamp for a KeyNest device. */
68298
- last_movement: string;
68299
- /** Address for a KeyNest device. */
68300
- address: string | null;
68301
- /** Current status for a KeyNest device. */
68302
- current_status: string | null;
68303
- /** Current user name for a KeyNest device. */
68304
- current_user_name: string | null;
68305
- /** Current user email for a KeyNest device. */
68306
- current_user_email: string | null;
68307
- /** Current user phone number for a KeyNest device. */
68308
- current_user_phone_number: string | null;
68309
- /** Current user company for a KeyNest device. */
68310
- current_user_company: string | null;
68311
- /** Handover method for a KeyNest device. */
68312
- handover_method: string | null;
68313
- /** KeyNest app user for a KeyNest device. */
68314
- keynest_app_user: string | null;
68315
- /** Default office ID for a KeyNest device. */
68316
- default_office_id: number;
68317
- /** Fob ID for a KeyNest device. */
68318
- fob_id: number;
68319
- /** Whether the KeyNest device has a photo. */
68320
- has_photo: boolean;
67848
+ device_name?: string | undefined;
68321
67849
  } | undefined;
68322
67850
  }) & ({
68323
67851
  /** */
@@ -69483,46 +69011,8 @@ export type Routes = {
69483
69011
  } | undefined;
69484
69012
  /** Metadata for a KeyNest device. */
69485
69013
  keynest_metadata?: {
69486
- /** Key ID for a KeyNest device. */
69487
- key_id: string;
69488
69014
  /** Device name for a KeyNest device. */
69489
- device_name: string;
69490
- /** Property ID for a KeyNest device. */
69491
- property_id: string | null;
69492
- /** Property postcode for a KeyNest device. */
69493
- property_postcode: string | null;
69494
- /** Key notes for a KeyNest device. */
69495
- key_notes: string | null;
69496
- /** Subscription plan for a KeyNest device. */
69497
- subscription_plan: string;
69498
- /** Status type for a KeyNest device. */
69499
- status_type: string;
69500
- /** Current or last store ID for a KeyNest device. */
69501
- current_or_last_store_id: number;
69502
- /** Last movement timestamp for a KeyNest device. */
69503
- last_movement: string;
69504
- /** Address for a KeyNest device. */
69505
- address: string | null;
69506
- /** Current status for a KeyNest device. */
69507
- current_status: string | null;
69508
- /** Current user name for a KeyNest device. */
69509
- current_user_name: string | null;
69510
- /** Current user email for a KeyNest device. */
69511
- current_user_email: string | null;
69512
- /** Current user phone number for a KeyNest device. */
69513
- current_user_phone_number: string | null;
69514
- /** Current user company for a KeyNest device. */
69515
- current_user_company: string | null;
69516
- /** Handover method for a KeyNest device. */
69517
- handover_method: string | null;
69518
- /** KeyNest app user for a KeyNest device. */
69519
- keynest_app_user: string | null;
69520
- /** Default office ID for a KeyNest device. */
69521
- default_office_id: number;
69522
- /** Fob ID for a KeyNest device. */
69523
- fob_id: number;
69524
- /** Whether the KeyNest device has a photo. */
69525
- has_photo: boolean;
69015
+ device_name?: string | undefined;
69526
69016
  } | undefined;
69527
69017
  }) & ({
69528
69018
  /** */
@@ -76629,46 +76119,8 @@ export type Routes = {
76629
76119
  } | undefined;
76630
76120
  /** Metadata for a KeyNest device. */
76631
76121
  keynest_metadata?: {
76632
- /** Key ID for a KeyNest device. */
76633
- key_id: string;
76634
76122
  /** Device name for a KeyNest device. */
76635
- device_name: string;
76636
- /** Property ID for a KeyNest device. */
76637
- property_id: string | null;
76638
- /** Property postcode for a KeyNest device. */
76639
- property_postcode: string | null;
76640
- /** Key notes for a KeyNest device. */
76641
- key_notes: string | null;
76642
- /** Subscription plan for a KeyNest device. */
76643
- subscription_plan: string;
76644
- /** Status type for a KeyNest device. */
76645
- status_type: string;
76646
- /** Current or last store ID for a KeyNest device. */
76647
- current_or_last_store_id: number;
76648
- /** Last movement timestamp for a KeyNest device. */
76649
- last_movement: string;
76650
- /** Address for a KeyNest device. */
76651
- address: string | null;
76652
- /** Current status for a KeyNest device. */
76653
- current_status: string | null;
76654
- /** Current user name for a KeyNest device. */
76655
- current_user_name: string | null;
76656
- /** Current user email for a KeyNest device. */
76657
- current_user_email: string | null;
76658
- /** Current user phone number for a KeyNest device. */
76659
- current_user_phone_number: string | null;
76660
- /** Current user company for a KeyNest device. */
76661
- current_user_company: string | null;
76662
- /** Handover method for a KeyNest device. */
76663
- handover_method: string | null;
76664
- /** KeyNest app user for a KeyNest device. */
76665
- keynest_app_user: string | null;
76666
- /** Default office ID for a KeyNest device. */
76667
- default_office_id: number;
76668
- /** Fob ID for a KeyNest device. */
76669
- fob_id: number;
76670
- /** Whether the KeyNest device has a photo. */
76671
- has_photo: boolean;
76123
+ device_name?: string | undefined;
76672
76124
  } | undefined;
76673
76125
  }) & ({
76674
76126
  /** */
@@ -77836,46 +77288,8 @@ export type Routes = {
77836
77288
  } | undefined;
77837
77289
  /** Metadata for a KeyNest device. */
77838
77290
  keynest_metadata?: {
77839
- /** Key ID for a KeyNest device. */
77840
- key_id: string;
77841
77291
  /** Device name for a KeyNest device. */
77842
- device_name: string;
77843
- /** Property ID for a KeyNest device. */
77844
- property_id: string | null;
77845
- /** Property postcode for a KeyNest device. */
77846
- property_postcode: string | null;
77847
- /** Key notes for a KeyNest device. */
77848
- key_notes: string | null;
77849
- /** Subscription plan for a KeyNest device. */
77850
- subscription_plan: string;
77851
- /** Status type for a KeyNest device. */
77852
- status_type: string;
77853
- /** Current or last store ID for a KeyNest device. */
77854
- current_or_last_store_id: number;
77855
- /** Last movement timestamp for a KeyNest device. */
77856
- last_movement: string;
77857
- /** Address for a KeyNest device. */
77858
- address: string | null;
77859
- /** Current status for a KeyNest device. */
77860
- current_status: string | null;
77861
- /** Current user name for a KeyNest device. */
77862
- current_user_name: string | null;
77863
- /** Current user email for a KeyNest device. */
77864
- current_user_email: string | null;
77865
- /** Current user phone number for a KeyNest device. */
77866
- current_user_phone_number: string | null;
77867
- /** Current user company for a KeyNest device. */
77868
- current_user_company: string | null;
77869
- /** Handover method for a KeyNest device. */
77870
- handover_method: string | null;
77871
- /** KeyNest app user for a KeyNest device. */
77872
- keynest_app_user: string | null;
77873
- /** Default office ID for a KeyNest device. */
77874
- default_office_id: number;
77875
- /** Fob ID for a KeyNest device. */
77876
- fob_id: number;
77877
- /** Whether the KeyNest device has a photo. */
77878
- has_photo: boolean;
77292
+ device_name?: string | undefined;
77879
77293
  } | undefined;
77880
77294
  }) & ({
77881
77295
  /** */
@@ -79802,46 +79216,8 @@ export type Routes = {
79802
79216
  } | undefined;
79803
79217
  /** Metadata for a KeyNest device. */
79804
79218
  keynest_metadata?: {
79805
- /** Key ID for a KeyNest device. */
79806
- key_id: string;
79807
79219
  /** Device name for a KeyNest device. */
79808
- device_name: string;
79809
- /** Property ID for a KeyNest device. */
79810
- property_id: string | null;
79811
- /** Property postcode for a KeyNest device. */
79812
- property_postcode: string | null;
79813
- /** Key notes for a KeyNest device. */
79814
- key_notes: string | null;
79815
- /** Subscription plan for a KeyNest device. */
79816
- subscription_plan: string;
79817
- /** Status type for a KeyNest device. */
79818
- status_type: string;
79819
- /** Current or last store ID for a KeyNest device. */
79820
- current_or_last_store_id: number;
79821
- /** Last movement timestamp for a KeyNest device. */
79822
- last_movement: string;
79823
- /** Address for a KeyNest device. */
79824
- address: string | null;
79825
- /** Current status for a KeyNest device. */
79826
- current_status: string | null;
79827
- /** Current user name for a KeyNest device. */
79828
- current_user_name: string | null;
79829
- /** Current user email for a KeyNest device. */
79830
- current_user_email: string | null;
79831
- /** Current user phone number for a KeyNest device. */
79832
- current_user_phone_number: string | null;
79833
- /** Current user company for a KeyNest device. */
79834
- current_user_company: string | null;
79835
- /** Handover method for a KeyNest device. */
79836
- handover_method: string | null;
79837
- /** KeyNest app user for a KeyNest device. */
79838
- keynest_app_user: string | null;
79839
- /** Default office ID for a KeyNest device. */
79840
- default_office_id: number;
79841
- /** Fob ID for a KeyNest device. */
79842
- fob_id: number;
79843
- /** Whether the KeyNest device has a photo. */
79844
- has_photo: boolean;
79220
+ device_name?: string | undefined;
79845
79221
  } | undefined;
79846
79222
  }) & ({
79847
79223
  /** */
@@ -85081,6 +84457,8 @@ export type Routes = {
85081
84457
  } | undefined;
85082
84458
  }[] | undefined;
85083
84459
  access_codes?: {
84460
+ /** Unique identifier for the Seam workspace associated with the access code. */
84461
+ workspace_id: string;
85084
84462
  /** Unique identifier for a group of access codes that share the same code. */
85085
84463
  common_code_key: string | null;
85086
84464
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -85586,6 +84964,8 @@ export type Routes = {
85586
84964
  is_offline_access_code: boolean;
85587
84965
  }[] | undefined;
85588
84966
  unmanaged_access_codes?: {
84967
+ /** Unique identifier for the Seam workspace associated with the access code. */
84968
+ workspace_id: string;
85589
84969
  /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
85590
84970
  type: 'time_bound' | 'ongoing';
85591
84971
  /** Unique identifier for the access code. */