@seamapi/types 1.459.0 → 1.460.1

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 (41) hide show
  1. package/dist/connect.cjs +489 -127
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +2612 -713
  4. package/dist/index.cjs +489 -127
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-credential.d.ts +8 -8
  7. package/lib/seam/connect/models/acs/metadata/assa-abloy-vostio.d.ts +2 -2
  8. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +28 -28
  9. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +12 -12
  10. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +16 -16
  11. package/lib/seam/connect/models/batch.d.ts +3279 -237
  12. package/lib/seam/connect/models/batch.js +7 -0
  13. package/lib/seam/connect/models/batch.js.map +1 -1
  14. package/lib/seam/connect/models/customer/access-grant-resources.d.ts +18 -18
  15. package/lib/seam/connect/models/customer/access-grant-resources.js +2 -1
  16. package/lib/seam/connect/models/customer/access-grant-resources.js.map +1 -1
  17. package/lib/seam/connect/models/customer/customer-data.d.ts +15 -15
  18. package/lib/seam/connect/models/devices/device-metadata.d.ts +108 -0
  19. package/lib/seam/connect/models/devices/device-metadata.js +67 -0
  20. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  21. package/lib/seam/connect/models/devices/device-provider.d.ts +1 -0
  22. package/lib/seam/connect/models/devices/device-provider.js +1 -0
  23. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  24. package/lib/seam/connect/models/devices/device.d.ts +152 -0
  25. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +108 -0
  26. package/lib/seam/connect/models/phones/phone-session.d.ts +181 -14
  27. package/lib/seam/connect/models/phones/phone-session.js +3 -0
  28. package/lib/seam/connect/models/phones/phone-session.js.map +1 -1
  29. package/lib/seam/connect/openapi.d.ts +300 -33
  30. package/lib/seam/connect/openapi.js +447 -113
  31. package/lib/seam/connect/openapi.js.map +1 -1
  32. package/lib/seam/connect/route-types.d.ts +1354 -179
  33. package/package.json +1 -1
  34. package/src/lib/seam/connect/internal/schemas.ts +1 -0
  35. package/src/lib/seam/connect/models/batch.ts +7 -0
  36. package/src/lib/seam/connect/models/customer/access-grant-resources.ts +2 -1
  37. package/src/lib/seam/connect/models/devices/device-metadata.ts +68 -0
  38. package/src/lib/seam/connect/models/devices/device-provider.ts +1 -0
  39. package/src/lib/seam/connect/models/phones/phone-session.ts +5 -0
  40. package/src/lib/seam/connect/openapi.ts +481 -113
  41. package/src/lib/seam/connect/route-types.ts +1558 -189
@@ -10648,6 +10648,140 @@ export default {
10648
10648
  required: ['device_id', 'device_name'],
10649
10649
  type: 'object',
10650
10650
  },
10651
+ keynest_metadata: {
10652
+ description: 'Metadata for a KeyNest device.',
10653
+ properties: {
10654
+ address: {
10655
+ description: 'Address for a KeyNest device.',
10656
+ nullable: true,
10657
+ type: 'string',
10658
+ },
10659
+ current_or_last_store_id: {
10660
+ description:
10661
+ 'Current or last store ID for a KeyNest device.',
10662
+ format: 'float',
10663
+ type: 'number',
10664
+ },
10665
+ current_status: {
10666
+ description: 'Current status for a KeyNest device.',
10667
+ nullable: true,
10668
+ type: 'string',
10669
+ },
10670
+ current_user_company: {
10671
+ description:
10672
+ 'Current user company for a KeyNest device.',
10673
+ nullable: true,
10674
+ type: 'string',
10675
+ },
10676
+ current_user_email: {
10677
+ description:
10678
+ 'Current user email for a KeyNest device.',
10679
+ nullable: true,
10680
+ type: 'string',
10681
+ },
10682
+ current_user_name: {
10683
+ description:
10684
+ 'Current user name for a KeyNest device.',
10685
+ nullable: true,
10686
+ type: 'string',
10687
+ },
10688
+ current_user_phone_number: {
10689
+ description:
10690
+ 'Current user phone number for a KeyNest device.',
10691
+ nullable: true,
10692
+ type: 'string',
10693
+ },
10694
+ default_office_id: {
10695
+ description:
10696
+ 'Default office ID for a KeyNest device.',
10697
+ format: 'float',
10698
+ type: 'number',
10699
+ },
10700
+ device_name: {
10701
+ description: 'Device name for a KeyNest device.',
10702
+ type: 'string',
10703
+ },
10704
+ fob_id: {
10705
+ description: 'Fob ID for a KeyNest device.',
10706
+ format: 'float',
10707
+ type: 'number',
10708
+ },
10709
+ handover_method: {
10710
+ description:
10711
+ 'Handover method for a KeyNest device.',
10712
+ nullable: true,
10713
+ type: 'string',
10714
+ },
10715
+ has_photo: {
10716
+ description:
10717
+ 'Whether the KeyNest device has a photo.',
10718
+ type: 'boolean',
10719
+ },
10720
+ key_id: {
10721
+ description: 'Key ID for a KeyNest device.',
10722
+ type: 'string',
10723
+ },
10724
+ key_notes: {
10725
+ description: 'Key notes for a KeyNest device.',
10726
+ nullable: true,
10727
+ type: 'string',
10728
+ },
10729
+ keynest_app_user: {
10730
+ description:
10731
+ 'KeyNest app user for a KeyNest device.',
10732
+ nullable: true,
10733
+ type: 'string',
10734
+ },
10735
+ last_movement: {
10736
+ description:
10737
+ 'Last movement timestamp for a KeyNest device.',
10738
+ type: 'string',
10739
+ },
10740
+ property_id: {
10741
+ description: 'Property ID for a KeyNest device.',
10742
+ nullable: true,
10743
+ type: 'string',
10744
+ },
10745
+ property_postcode: {
10746
+ description:
10747
+ 'Property postcode for a KeyNest device.',
10748
+ nullable: true,
10749
+ type: 'string',
10750
+ },
10751
+ status_type: {
10752
+ description: 'Status type for a KeyNest device.',
10753
+ type: 'string',
10754
+ },
10755
+ subscription_plan: {
10756
+ description:
10757
+ 'Subscription plan for a KeyNest device.',
10758
+ type: 'string',
10759
+ },
10760
+ },
10761
+ required: [
10762
+ 'key_id',
10763
+ 'device_name',
10764
+ 'property_id',
10765
+ 'property_postcode',
10766
+ 'key_notes',
10767
+ 'subscription_plan',
10768
+ 'status_type',
10769
+ 'current_or_last_store_id',
10770
+ 'last_movement',
10771
+ 'address',
10772
+ 'current_status',
10773
+ 'current_user_name',
10774
+ 'current_user_email',
10775
+ 'current_user_phone_number',
10776
+ 'current_user_company',
10777
+ 'handover_method',
10778
+ 'keynest_app_user',
10779
+ 'default_office_id',
10780
+ 'fob_id',
10781
+ 'has_photo',
10782
+ ],
10783
+ type: 'object',
10784
+ },
10651
10785
  kwikset_metadata: {
10652
10786
  description: 'Metadata for a Kwikset device.',
10653
10787
  properties: {
@@ -12886,6 +13020,7 @@ export default {
12886
13020
  'salto_space',
12887
13021
  'sensi',
12888
13022
  'kwikset2',
13023
+ 'keynest',
12889
13024
  ],
12890
13025
  type: 'string',
12891
13026
  },
@@ -20079,8 +20214,188 @@ export default {
20079
20214
  },
20080
20215
  type: 'array',
20081
20216
  },
20217
+ user_identity: {
20218
+ description: 'User identity.',
20219
+ properties: {
20220
+ acs_user_ids: {
20221
+ description:
20222
+ 'Array of access system user IDs associated with the user identity.',
20223
+ items: { format: 'uuid', type: 'string' },
20224
+ type: 'array',
20225
+ },
20226
+ created_at: {
20227
+ description:
20228
+ 'Date and time at which the user identity was created.',
20229
+ format: 'date-time',
20230
+ type: 'string',
20231
+ },
20232
+ display_name: { minLength: 1, type: 'string' },
20233
+ email_address: {
20234
+ description: 'Unique email address for the user identity.',
20235
+ format: 'email',
20236
+ nullable: true,
20237
+ type: 'string',
20238
+ },
20239
+ errors: {
20240
+ description:
20241
+ 'Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
20242
+ items: {
20243
+ description: 'Errors associated with the user identity.',
20244
+ discriminator: { propertyName: 'error_code' },
20245
+ oneOf: [
20246
+ {
20247
+ description:
20248
+ 'Indicates that there is an issue with an access system user associated with this user identity.',
20249
+ properties: {
20250
+ acs_system_id: {
20251
+ description:
20252
+ 'ID of the access system that the user identity is associated with.',
20253
+ format: 'uuid',
20254
+ type: 'string',
20255
+ },
20256
+ acs_user_id: {
20257
+ description:
20258
+ 'ID of the access system user that has an issue.',
20259
+ format: 'uuid',
20260
+ type: 'string',
20261
+ },
20262
+ created_at: {
20263
+ description:
20264
+ 'Date and time at which Seam created the error.',
20265
+ format: 'date-time',
20266
+ type: 'string',
20267
+ },
20268
+ error_code: {
20269
+ description:
20270
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
20271
+ enum: ['issue_with_acs_user'],
20272
+ type: 'string',
20273
+ },
20274
+ message: {
20275
+ description:
20276
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
20277
+ type: 'string',
20278
+ },
20279
+ },
20280
+ required: [
20281
+ 'created_at',
20282
+ 'message',
20283
+ 'error_code',
20284
+ 'acs_user_id',
20285
+ 'acs_system_id',
20286
+ ],
20287
+ type: 'object',
20288
+ },
20289
+ ],
20290
+ },
20291
+ type: 'array',
20292
+ },
20293
+ full_name: { minLength: 1, nullable: true, type: 'string' },
20294
+ phone_number: {
20295
+ description:
20296
+ 'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
20297
+ nullable: true,
20298
+ type: 'string',
20299
+ },
20300
+ user_identity_id: {
20301
+ description: 'ID of the user identity.',
20302
+ format: 'uuid',
20303
+ type: 'string',
20304
+ },
20305
+ user_identity_key: {
20306
+ description: 'Unique key for the user identity.',
20307
+ minLength: 1,
20308
+ nullable: true,
20309
+ type: 'string',
20310
+ },
20311
+ warnings: {
20312
+ description:
20313
+ 'Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
20314
+ items: {
20315
+ description: 'Warnings associated with the user identity.',
20316
+ discriminator: { propertyName: 'warning_code' },
20317
+ oneOf: [
20318
+ {
20319
+ description:
20320
+ 'Indicates that the user identity is currently being deleted.',
20321
+ properties: {
20322
+ created_at: {
20323
+ description:
20324
+ 'Date and time at which Seam created the warning.',
20325
+ format: 'date-time',
20326
+ type: 'string',
20327
+ },
20328
+ message: {
20329
+ description:
20330
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
20331
+ type: 'string',
20332
+ },
20333
+ warning_code: {
20334
+ description:
20335
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
20336
+ enum: ['being_deleted'],
20337
+ type: 'string',
20338
+ },
20339
+ },
20340
+ required: ['created_at', 'message', 'warning_code'],
20341
+ type: 'object',
20342
+ },
20343
+ {
20344
+ description:
20345
+ "Indicates that the ACS user's profile does not match the user identity's profile",
20346
+ properties: {
20347
+ created_at: {
20348
+ description:
20349
+ 'Date and time at which Seam created the warning.',
20350
+ format: 'date-time',
20351
+ type: 'string',
20352
+ },
20353
+ message: {
20354
+ description:
20355
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
20356
+ type: 'string',
20357
+ },
20358
+ warning_code: {
20359
+ description:
20360
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
20361
+ enum: [
20362
+ 'acs_user_profile_does_not_match_user_identity',
20363
+ ],
20364
+ type: 'string',
20365
+ },
20366
+ },
20367
+ required: ['created_at', 'message', 'warning_code'],
20368
+ type: 'object',
20369
+ },
20370
+ ],
20371
+ },
20372
+ type: 'array',
20373
+ },
20374
+ workspace_id: {
20375
+ description:
20376
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
20377
+ format: 'uuid',
20378
+ type: 'string',
20379
+ },
20380
+ },
20381
+ required: [
20382
+ 'user_identity_id',
20383
+ 'user_identity_key',
20384
+ 'email_address',
20385
+ 'phone_number',
20386
+ 'display_name',
20387
+ 'full_name',
20388
+ 'created_at',
20389
+ 'workspace_id',
20390
+ 'errors',
20391
+ 'warnings',
20392
+ 'acs_user_ids',
20393
+ ],
20394
+ type: 'object',
20395
+ },
20396
+ workspace_id: { description: 'Workspace ID.', type: 'string' },
20082
20397
  },
20083
- required: ['provider_sessions'],
20398
+ required: ['provider_sessions', 'user_identity', 'workspace_id'],
20084
20399
  type: 'object',
20085
20400
  'x-route-path': '/seam/mobile_sdk/v1/phone_sessions',
20086
20401
  'x-undocumented': 'Seam Mobile SDK only.',
@@ -28015,7 +28330,14 @@ export default {
28015
28330
  required: false,
28016
28331
  schema: {
28017
28332
  items: {
28018
- enum: ['spaces', 'devices', 'acs_entrances'],
28333
+ enum: [
28334
+ 'spaces',
28335
+ 'devices',
28336
+ 'acs_entrances',
28337
+ 'connected_accounts',
28338
+ 'acs_systems',
28339
+ 'user_identity',
28340
+ ],
28019
28341
  type: 'string',
28020
28342
  },
28021
28343
  type: 'array',
@@ -28027,7 +28349,14 @@ export default {
28027
28349
  required: false,
28028
28350
  schema: {
28029
28351
  items: {
28030
- enum: ['spaces', 'devices', 'acs_entrances'],
28352
+ enum: [
28353
+ 'spaces',
28354
+ 'devices',
28355
+ 'acs_entrances',
28356
+ 'connected_accounts',
28357
+ 'acs_systems',
28358
+ 'user_identity',
28359
+ ],
28031
28360
  type: 'string',
28032
28361
  },
28033
28362
  type: 'array',
@@ -28041,20 +28370,21 @@ export default {
28041
28370
  schema: {
28042
28371
  properties: {
28043
28372
  batch: {
28044
- description: 'Represents a resource batch.',
28045
28373
  properties: {
28046
28374
  acs_entrances: {
28047
28375
  items: { $ref: '#/components/schemas/acs_entrance' },
28048
28376
  type: 'array',
28049
28377
  },
28050
- batch_type: {
28051
- enum: [
28052
- 'workspaces',
28053
- 'access_grants',
28054
- 'access_methods',
28055
- 'spaces',
28056
- ],
28057
- type: 'string',
28378
+ acs_systems: {
28379
+ items: { $ref: '#/components/schemas/acs_system' },
28380
+ type: 'array',
28381
+ },
28382
+ batch_type: { enum: ['access_grants'], type: 'string' },
28383
+ connected_accounts: {
28384
+ items: {
28385
+ $ref: '#/components/schemas/connected_account',
28386
+ },
28387
+ type: 'array',
28058
28388
  },
28059
28389
  devices: {
28060
28390
  items: { $ref: '#/components/schemas/device' },
@@ -28068,14 +28398,9 @@ export default {
28068
28398
  items: { $ref: '#/components/schemas/user_identity' },
28069
28399
  type: 'array',
28070
28400
  },
28071
- workspaces: {
28072
- items: { $ref: '#/components/schemas/workspace' },
28073
- type: 'array',
28074
- },
28075
28401
  },
28076
28402
  required: ['batch_type'],
28077
28403
  type: 'object',
28078
- 'x-route-path': '/',
28079
28404
  },
28080
28405
  ok: { type: 'boolean' },
28081
28406
  },
@@ -28121,14 +28446,28 @@ export default {
28121
28446
  },
28122
28447
  exclude: {
28123
28448
  items: {
28124
- enum: ['spaces', 'devices', 'acs_entrances'],
28449
+ enum: [
28450
+ 'spaces',
28451
+ 'devices',
28452
+ 'acs_entrances',
28453
+ 'connected_accounts',
28454
+ 'acs_systems',
28455
+ 'user_identity',
28456
+ ],
28125
28457
  type: 'string',
28126
28458
  },
28127
28459
  type: 'array',
28128
28460
  },
28129
28461
  include: {
28130
28462
  items: {
28131
- enum: ['spaces', 'devices', 'acs_entrances'],
28463
+ enum: [
28464
+ 'spaces',
28465
+ 'devices',
28466
+ 'acs_entrances',
28467
+ 'connected_accounts',
28468
+ 'acs_systems',
28469
+ 'user_identity',
28470
+ ],
28132
28471
  type: 'string',
28133
28472
  },
28134
28473
  type: 'array',
@@ -28147,20 +28486,21 @@ export default {
28147
28486
  schema: {
28148
28487
  properties: {
28149
28488
  batch: {
28150
- description: 'Represents a resource batch.',
28151
28489
  properties: {
28152
28490
  acs_entrances: {
28153
28491
  items: { $ref: '#/components/schemas/acs_entrance' },
28154
28492
  type: 'array',
28155
28493
  },
28156
- batch_type: {
28157
- enum: [
28158
- 'workspaces',
28159
- 'access_grants',
28160
- 'access_methods',
28161
- 'spaces',
28162
- ],
28163
- type: 'string',
28494
+ acs_systems: {
28495
+ items: { $ref: '#/components/schemas/acs_system' },
28496
+ type: 'array',
28497
+ },
28498
+ batch_type: { enum: ['access_grants'], type: 'string' },
28499
+ connected_accounts: {
28500
+ items: {
28501
+ $ref: '#/components/schemas/connected_account',
28502
+ },
28503
+ type: 'array',
28164
28504
  },
28165
28505
  devices: {
28166
28506
  items: { $ref: '#/components/schemas/device' },
@@ -28174,14 +28514,9 @@ export default {
28174
28514
  items: { $ref: '#/components/schemas/user_identity' },
28175
28515
  type: 'array',
28176
28516
  },
28177
- workspaces: {
28178
- items: { $ref: '#/components/schemas/workspace' },
28179
- type: 'array',
28180
- },
28181
28517
  },
28182
28518
  required: ['batch_type'],
28183
28519
  type: 'object',
28184
- 'x-route-path': '/',
28185
28520
  },
28186
28521
  ok: { type: 'boolean' },
28187
28522
  },
@@ -36541,6 +36876,7 @@ export default {
36541
36876
  'salto_space',
36542
36877
  'sensi',
36543
36878
  'kwikset2',
36879
+ 'keynest',
36544
36880
  'yale_access',
36545
36881
  'hid_cm',
36546
36882
  'google_nest',
@@ -37724,7 +38060,7 @@ export default {
37724
38060
  },
37725
38061
  name: {
37726
38062
  description:
37727
- 'Your display name for this access grant resource.',
38063
+ 'Your name for this access grant resource.',
37728
38064
  type: 'string',
37729
38065
  },
37730
38066
  property_keys: {
@@ -37777,7 +38113,7 @@ export default {
37777
38113
  type: 'string',
37778
38114
  },
37779
38115
  },
37780
- required: ['name', 'access_grant_key'],
38116
+ required: ['access_grant_key'],
37781
38117
  type: 'object',
37782
38118
  },
37783
38119
  type: 'array',
@@ -37827,7 +38163,7 @@ export default {
37827
38163
  },
37828
38164
  name: {
37829
38165
  description:
37830
- 'Your display name for this access grant resource.',
38166
+ 'Your name for this access grant resource.',
37831
38167
  type: 'string',
37832
38168
  },
37833
38169
  property_keys: {
@@ -37880,7 +38216,7 @@ export default {
37880
38216
  type: 'string',
37881
38217
  },
37882
38218
  },
37883
- required: ['name', 'booking_key'],
38219
+ required: ['booking_key'],
37884
38220
  type: 'object',
37885
38221
  },
37886
38222
  type: 'array',
@@ -38081,7 +38417,7 @@ export default {
38081
38417
  },
38082
38418
  name: {
38083
38419
  description:
38084
- 'Your display name for this access grant resource.',
38420
+ 'Your name for this access grant resource.',
38085
38421
  type: 'string',
38086
38422
  },
38087
38423
  property_keys: {
@@ -38139,7 +38475,7 @@ export default {
38139
38475
  type: 'string',
38140
38476
  },
38141
38477
  },
38142
- required: ['name', 'reservation_key'],
38478
+ required: ['reservation_key'],
38143
38479
  type: 'object',
38144
38480
  },
38145
38481
  type: 'array',
@@ -38425,7 +38761,7 @@ export default {
38425
38761
  },
38426
38762
  name: {
38427
38763
  description:
38428
- 'Your display name for this access grant resource.',
38764
+ 'Your name for this access grant resource.',
38429
38765
  type: 'string',
38430
38766
  },
38431
38767
  property_keys: {
@@ -38478,7 +38814,7 @@ export default {
38478
38814
  type: 'string',
38479
38815
  },
38480
38816
  },
38481
- required: ['name', 'access_grant_key'],
38817
+ required: ['access_grant_key'],
38482
38818
  type: 'object',
38483
38819
  },
38484
38820
  type: 'array',
@@ -38528,7 +38864,7 @@ export default {
38528
38864
  },
38529
38865
  name: {
38530
38866
  description:
38531
- 'Your display name for this access grant resource.',
38867
+ 'Your name for this access grant resource.',
38532
38868
  type: 'string',
38533
38869
  },
38534
38870
  property_keys: {
@@ -38581,7 +38917,7 @@ export default {
38581
38917
  type: 'string',
38582
38918
  },
38583
38919
  },
38584
- required: ['name', 'booking_key'],
38920
+ required: ['booking_key'],
38585
38921
  type: 'object',
38586
38922
  },
38587
38923
  type: 'array',
@@ -38779,7 +39115,7 @@ export default {
38779
39115
  },
38780
39116
  name: {
38781
39117
  description:
38782
- 'Your display name for this access grant resource.',
39118
+ 'Your name for this access grant resource.',
38783
39119
  type: 'string',
38784
39120
  },
38785
39121
  property_keys: {
@@ -38837,7 +39173,7 @@ export default {
38837
39173
  type: 'string',
38838
39174
  },
38839
39175
  },
38840
- required: ['name', 'reservation_key'],
39176
+ required: ['reservation_key'],
38841
39177
  type: 'object',
38842
39178
  },
38843
39179
  type: 'array',
@@ -39494,6 +39830,7 @@ export default {
39494
39830
  'tado',
39495
39831
  'sensi',
39496
39832
  'smartthings',
39833
+ 'keynest',
39497
39834
  ],
39498
39835
  type: 'string',
39499
39836
  },
@@ -39968,6 +40305,7 @@ export default {
39968
40305
  'tado',
39969
40306
  'sensi',
39970
40307
  'smartthings',
40308
+ 'keynest',
39971
40309
  ],
39972
40310
  type: 'string',
39973
40311
  },
@@ -40330,7 +40668,7 @@ export default {
40330
40668
  '/devices/simulate/disconnect_from_hub': {
40331
40669
  post: {
40332
40670
  description:
40333
- 'Simulates taking the Wi-Fi hub (bridge) offline for a device. \nOnly applicable for [sandbox workspaces](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) and August locks today, but designed so we can extend to other providers later. \nThis will set the `hub_disconnected` error on the device.',
40671
+ 'Simulates taking the WiFi hub (bridge) offline for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August and TTLock locks.\nThis will set the corresponding `hub_disconnected` or\n`ttlock_lock_not_paired_to_gateway` error on the device.',
40334
40672
  operationId: 'devicesSimulateDisconnectFromHubPost',
40335
40673
  requestBody: {
40336
40674
  content: {
@@ -40771,6 +41109,7 @@ export default {
40771
41109
  'tado',
40772
41110
  'sensi',
40773
41111
  'smartthings',
41112
+ 'keynest',
40774
41113
  ],
40775
41114
  type: 'string',
40776
41115
  },
@@ -41242,6 +41581,7 @@ export default {
41242
41581
  'tado',
41243
41582
  'sensi',
41244
41583
  'smartthings',
41584
+ 'keynest',
41245
41585
  ],
41246
41586
  type: 'string',
41247
41587
  },
@@ -45623,10 +45963,11 @@ export default {
45623
45963
  'x-undocumented': 'Seam Bridge Client only.',
45624
45964
  },
45625
45965
  },
45626
- '/seam/console/v1/get_resource_type': {
45966
+ '/seam/console/v1/get_resource_locator': {
45627
45967
  get: {
45628
- description: 'Returns the type of a resource given its UUID.',
45629
- operationId: 'seamConsoleV1GetResourceTypeGet',
45968
+ description:
45969
+ 'Returns the type and system information of a resource given its UUID.',
45970
+ operationId: 'seamConsoleV1GetResourceLocatorGet',
45630
45971
  parameters: [
45631
45972
  {
45632
45973
  in: 'query',
@@ -45642,9 +45983,17 @@ export default {
45642
45983
  schema: {
45643
45984
  properties: {
45644
45985
  ok: { type: 'boolean' },
45645
- resource_type: { type: 'string' },
45986
+ resource_locator: {
45987
+ properties: {
45988
+ acs_system_id: { format: 'uuid', type: 'string' },
45989
+ device_id: { format: 'uuid', type: 'string' },
45990
+ resource_type: { type: 'string' },
45991
+ },
45992
+ required: ['resource_type'],
45993
+ type: 'object',
45994
+ },
45646
45995
  },
45647
- required: ['resource_type', 'ok'],
45996
+ required: ['resource_locator', 'ok'],
45648
45997
  type: 'object',
45649
45998
  },
45650
45999
  },
@@ -45660,18 +46009,19 @@ export default {
45660
46009
  { console_session_with_workspace: [] },
45661
46010
  { api_key: [] },
45662
46011
  ],
45663
- summary: '/seam/console/v1/get_resource_type',
46012
+ summary: '/seam/console/v1/get_resource_locator',
45664
46013
  tags: [],
45665
46014
  'x-fern-sdk-group-name': ['seam', 'console', 'v1'],
45666
- 'x-fern-sdk-method-name': 'get_resource_type',
45667
- 'x-fern-sdk-return-value': 'resource_type',
45668
- 'x-response-key': 'resource_type',
45669
- 'x-title': 'Get Resource Type',
46015
+ 'x-fern-sdk-method-name': 'get_resource_locator',
46016
+ 'x-fern-sdk-return-value': 'resource_locator',
46017
+ 'x-response-key': 'resource_locator',
46018
+ 'x-title': 'Get Resource Locator',
45670
46019
  'x-undocumented': 'Internal endpoint for Console',
45671
46020
  },
45672
46021
  post: {
45673
- description: 'Returns the type of a resource given its UUID.',
45674
- operationId: 'seamConsoleV1GetResourceTypePost',
46022
+ description:
46023
+ 'Returns the type and system information of a resource given its UUID.',
46024
+ operationId: 'seamConsoleV1GetResourceLocatorPost',
45675
46025
  parameters: [
45676
46026
  {
45677
46027
  in: 'query',
@@ -45687,9 +46037,17 @@ export default {
45687
46037
  schema: {
45688
46038
  properties: {
45689
46039
  ok: { type: 'boolean' },
45690
- resource_type: { type: 'string' },
46040
+ resource_locator: {
46041
+ properties: {
46042
+ acs_system_id: { format: 'uuid', type: 'string' },
46043
+ device_id: { format: 'uuid', type: 'string' },
46044
+ resource_type: { type: 'string' },
46045
+ },
46046
+ required: ['resource_type'],
46047
+ type: 'object',
46048
+ },
45691
46049
  },
45692
- required: ['resource_type', 'ok'],
46050
+ required: ['resource_locator', 'ok'],
45693
46051
  type: 'object',
45694
46052
  },
45695
46053
  },
@@ -45705,13 +46063,13 @@ export default {
45705
46063
  { console_session_with_workspace: [] },
45706
46064
  { api_key: [] },
45707
46065
  ],
45708
- summary: '/seam/console/v1/get_resource_type',
46066
+ summary: '/seam/console/v1/get_resource_locator',
45709
46067
  tags: [],
45710
46068
  'x-fern-sdk-group-name': ['seam', 'console', 'v1'],
45711
- 'x-fern-sdk-method-name': 'get_resource_type',
45712
- 'x-fern-sdk-return-value': 'resource_type',
45713
- 'x-response-key': 'resource_type',
45714
- 'x-title': 'Get Resource Type',
46069
+ 'x-fern-sdk-method-name': 'get_resource_locator',
46070
+ 'x-fern-sdk-return-value': 'resource_locator',
46071
+ 'x-response-key': 'resource_locator',
46072
+ 'x-title': 'Get Resource Locator',
45715
46073
  'x-undocumented': 'Internal endpoint for Console',
45716
46074
  },
45717
46075
  },
@@ -46181,7 +46539,7 @@ export default {
46181
46539
  type: 'string',
46182
46540
  },
46183
46541
  },
46184
- required: ['rule', 'config'],
46542
+ required: ['rule'],
46185
46543
  type: 'object',
46186
46544
  },
46187
46545
  reservation_time_updated: {
@@ -46194,7 +46552,7 @@ export default {
46194
46552
  type: 'string',
46195
46553
  },
46196
46554
  },
46197
- required: ['rule', 'config'],
46555
+ required: ['rule'],
46198
46556
  type: 'object',
46199
46557
  },
46200
46558
  },
@@ -46282,7 +46640,7 @@ export default {
46282
46640
  type: 'string',
46283
46641
  },
46284
46642
  },
46285
- required: ['rule', 'config'],
46643
+ required: ['rule'],
46286
46644
  type: 'object',
46287
46645
  },
46288
46646
  reservation_time_updated: {
@@ -46295,7 +46653,7 @@ export default {
46295
46653
  type: 'string',
46296
46654
  },
46297
46655
  },
46298
- required: ['rule', 'config'],
46656
+ required: ['rule'],
46299
46657
  type: 'object',
46300
46658
  },
46301
46659
  },
@@ -46383,7 +46741,7 @@ export default {
46383
46741
  type: 'string',
46384
46742
  },
46385
46743
  },
46386
- required: ['rule', 'config'],
46744
+ required: ['rule'],
46387
46745
  type: 'object',
46388
46746
  },
46389
46747
  reservation_time_updated: {
@@ -46394,7 +46752,7 @@ export default {
46394
46752
  type: 'string',
46395
46753
  },
46396
46754
  },
46397
- required: ['rule', 'config'],
46755
+ required: ['rule'],
46398
46756
  type: 'object',
46399
46757
  },
46400
46758
  },
@@ -46490,7 +46848,7 @@ export default {
46490
46848
  type: 'string',
46491
46849
  },
46492
46850
  },
46493
- required: ['rule', 'config'],
46851
+ required: ['rule'],
46494
46852
  type: 'object',
46495
46853
  },
46496
46854
  reservation_time_updated: {
@@ -46501,7 +46859,7 @@ export default {
46501
46859
  type: 'string',
46502
46860
  },
46503
46861
  },
46504
- required: ['rule', 'config'],
46862
+ required: ['rule'],
46505
46863
  type: 'object',
46506
46864
  },
46507
46865
  },
@@ -47753,7 +48111,13 @@ export default {
47753
48111
  required: false,
47754
48112
  schema: {
47755
48113
  items: {
47756
- enum: ['spaces', 'devices', 'acs_entrances'],
48114
+ enum: [
48115
+ 'spaces',
48116
+ 'devices',
48117
+ 'acs_entrances',
48118
+ 'connected_accounts',
48119
+ 'acs_systems',
48120
+ ],
47757
48121
  type: 'string',
47758
48122
  },
47759
48123
  type: 'array',
@@ -47765,7 +48129,13 @@ export default {
47765
48129
  required: false,
47766
48130
  schema: {
47767
48131
  items: {
47768
- enum: ['spaces', 'devices', 'acs_entrances'],
48132
+ enum: [
48133
+ 'spaces',
48134
+ 'devices',
48135
+ 'acs_entrances',
48136
+ 'connected_accounts',
48137
+ 'acs_systems',
48138
+ ],
47769
48139
  type: 'string',
47770
48140
  },
47771
48141
  type: 'array',
@@ -47779,20 +48149,22 @@ export default {
47779
48149
  schema: {
47780
48150
  properties: {
47781
48151
  batch: {
47782
- description: 'Represents a resource batch.',
48152
+ description: 'ID of the affected access system user.',
47783
48153
  properties: {
47784
48154
  acs_entrances: {
47785
48155
  items: { $ref: '#/components/schemas/acs_entrance' },
47786
48156
  type: 'array',
47787
48157
  },
47788
- batch_type: {
47789
- enum: [
47790
- 'workspaces',
47791
- 'access_grants',
47792
- 'access_methods',
47793
- 'spaces',
47794
- ],
47795
- type: 'string',
48158
+ acs_systems: {
48159
+ items: { $ref: '#/components/schemas/acs_system' },
48160
+ type: 'array',
48161
+ },
48162
+ batch_type: { enum: ['spaces'], type: 'string' },
48163
+ connected_accounts: {
48164
+ items: {
48165
+ $ref: '#/components/schemas/connected_account',
48166
+ },
48167
+ type: 'array',
47796
48168
  },
47797
48169
  devices: {
47798
48170
  items: { $ref: '#/components/schemas/device' },
@@ -47802,18 +48174,9 @@ export default {
47802
48174
  items: { $ref: '#/components/schemas/space' },
47803
48175
  type: 'array',
47804
48176
  },
47805
- user_identities: {
47806
- items: { $ref: '#/components/schemas/user_identity' },
47807
- type: 'array',
47808
- },
47809
- workspaces: {
47810
- items: { $ref: '#/components/schemas/workspace' },
47811
- type: 'array',
47812
- },
47813
48177
  },
47814
48178
  required: ['batch_type'],
47815
48179
  type: 'object',
47816
- 'x-route-path': '/',
47817
48180
  },
47818
48181
  ok: { type: 'boolean' },
47819
48182
  },
@@ -47852,14 +48215,26 @@ export default {
47852
48215
  properties: {
47853
48216
  exclude: {
47854
48217
  items: {
47855
- enum: ['spaces', 'devices', 'acs_entrances'],
48218
+ enum: [
48219
+ 'spaces',
48220
+ 'devices',
48221
+ 'acs_entrances',
48222
+ 'connected_accounts',
48223
+ 'acs_systems',
48224
+ ],
47856
48225
  type: 'string',
47857
48226
  },
47858
48227
  type: 'array',
47859
48228
  },
47860
48229
  include: {
47861
48230
  items: {
47862
- enum: ['spaces', 'devices', 'acs_entrances'],
48231
+ enum: [
48232
+ 'spaces',
48233
+ 'devices',
48234
+ 'acs_entrances',
48235
+ 'connected_accounts',
48236
+ 'acs_systems',
48237
+ ],
47863
48238
  type: 'string',
47864
48239
  },
47865
48240
  type: 'array',
@@ -47884,20 +48259,22 @@ export default {
47884
48259
  schema: {
47885
48260
  properties: {
47886
48261
  batch: {
47887
- description: 'Represents a resource batch.',
48262
+ description: 'ID of the affected access system user.',
47888
48263
  properties: {
47889
48264
  acs_entrances: {
47890
48265
  items: { $ref: '#/components/schemas/acs_entrance' },
47891
48266
  type: 'array',
47892
48267
  },
47893
- batch_type: {
47894
- enum: [
47895
- 'workspaces',
47896
- 'access_grants',
47897
- 'access_methods',
47898
- 'spaces',
47899
- ],
47900
- type: 'string',
48268
+ acs_systems: {
48269
+ items: { $ref: '#/components/schemas/acs_system' },
48270
+ type: 'array',
48271
+ },
48272
+ batch_type: { enum: ['spaces'], type: 'string' },
48273
+ connected_accounts: {
48274
+ items: {
48275
+ $ref: '#/components/schemas/connected_account',
48276
+ },
48277
+ type: 'array',
47901
48278
  },
47902
48279
  devices: {
47903
48280
  items: { $ref: '#/components/schemas/device' },
@@ -47907,18 +48284,9 @@ export default {
47907
48284
  items: { $ref: '#/components/schemas/space' },
47908
48285
  type: 'array',
47909
48286
  },
47910
- user_identities: {
47911
- items: { $ref: '#/components/schemas/user_identity' },
47912
- type: 'array',
47913
- },
47914
- workspaces: {
47915
- items: { $ref: '#/components/schemas/workspace' },
47916
- type: 'array',
47917
- },
47918
48287
  },
47919
48288
  required: ['batch_type'],
47920
48289
  type: 'object',
47921
- 'x-route-path': '/',
47922
48290
  },
47923
48291
  ok: { type: 'boolean' },
47924
48292
  },