@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.
- package/dist/connect.cjs +489 -127
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +2612 -713
- package/dist/index.cjs +489 -127
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential.d.ts +8 -8
- package/lib/seam/connect/models/acs/metadata/assa-abloy-vostio.d.ts +2 -2
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +28 -28
- package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +12 -12
- package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +16 -16
- package/lib/seam/connect/models/batch.d.ts +3279 -237
- package/lib/seam/connect/models/batch.js +7 -0
- package/lib/seam/connect/models/batch.js.map +1 -1
- package/lib/seam/connect/models/customer/access-grant-resources.d.ts +18 -18
- package/lib/seam/connect/models/customer/access-grant-resources.js +2 -1
- package/lib/seam/connect/models/customer/access-grant-resources.js.map +1 -1
- package/lib/seam/connect/models/customer/customer-data.d.ts +15 -15
- package/lib/seam/connect/models/devices/device-metadata.d.ts +108 -0
- package/lib/seam/connect/models/devices/device-metadata.js +67 -0
- package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +1 -0
- package/lib/seam/connect/models/devices/device-provider.js +1 -0
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +152 -0
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +108 -0
- package/lib/seam/connect/models/phones/phone-session.d.ts +181 -14
- package/lib/seam/connect/models/phones/phone-session.js +3 -0
- package/lib/seam/connect/models/phones/phone-session.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +300 -33
- package/lib/seam/connect/openapi.js +447 -113
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1354 -179
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/models/batch.ts +7 -0
- package/src/lib/seam/connect/models/customer/access-grant-resources.ts +2 -1
- package/src/lib/seam/connect/models/devices/device-metadata.ts +68 -0
- package/src/lib/seam/connect/models/devices/device-provider.ts +1 -0
- package/src/lib/seam/connect/models/phones/phone-session.ts +5 -0
- package/src/lib/seam/connect/openapi.ts +481 -113
- package/src/lib/seam/connect/route-types.ts +1558 -189
|
@@ -9419,6 +9419,128 @@ export default {
|
|
|
9419
9419
|
required: ['device_id', 'device_name'],
|
|
9420
9420
|
type: 'object',
|
|
9421
9421
|
},
|
|
9422
|
+
keynest_metadata: {
|
|
9423
|
+
description: 'Metadata for a KeyNest device.',
|
|
9424
|
+
properties: {
|
|
9425
|
+
address: {
|
|
9426
|
+
description: 'Address for a KeyNest device.',
|
|
9427
|
+
nullable: true,
|
|
9428
|
+
type: 'string',
|
|
9429
|
+
},
|
|
9430
|
+
current_or_last_store_id: {
|
|
9431
|
+
description: 'Current or last store ID for a KeyNest device.',
|
|
9432
|
+
format: 'float',
|
|
9433
|
+
type: 'number',
|
|
9434
|
+
},
|
|
9435
|
+
current_status: {
|
|
9436
|
+
description: 'Current status for a KeyNest device.',
|
|
9437
|
+
nullable: true,
|
|
9438
|
+
type: 'string',
|
|
9439
|
+
},
|
|
9440
|
+
current_user_company: {
|
|
9441
|
+
description: 'Current user company for a KeyNest device.',
|
|
9442
|
+
nullable: true,
|
|
9443
|
+
type: 'string',
|
|
9444
|
+
},
|
|
9445
|
+
current_user_email: {
|
|
9446
|
+
description: 'Current user email for a KeyNest device.',
|
|
9447
|
+
nullable: true,
|
|
9448
|
+
type: 'string',
|
|
9449
|
+
},
|
|
9450
|
+
current_user_name: {
|
|
9451
|
+
description: 'Current user name for a KeyNest device.',
|
|
9452
|
+
nullable: true,
|
|
9453
|
+
type: 'string',
|
|
9454
|
+
},
|
|
9455
|
+
current_user_phone_number: {
|
|
9456
|
+
description: 'Current user phone number for a KeyNest device.',
|
|
9457
|
+
nullable: true,
|
|
9458
|
+
type: 'string',
|
|
9459
|
+
},
|
|
9460
|
+
default_office_id: {
|
|
9461
|
+
description: 'Default office ID for a KeyNest device.',
|
|
9462
|
+
format: 'float',
|
|
9463
|
+
type: 'number',
|
|
9464
|
+
},
|
|
9465
|
+
device_name: {
|
|
9466
|
+
description: 'Device name for a KeyNest device.',
|
|
9467
|
+
type: 'string',
|
|
9468
|
+
},
|
|
9469
|
+
fob_id: {
|
|
9470
|
+
description: 'Fob ID for a KeyNest device.',
|
|
9471
|
+
format: 'float',
|
|
9472
|
+
type: 'number',
|
|
9473
|
+
},
|
|
9474
|
+
handover_method: {
|
|
9475
|
+
description: 'Handover method for a KeyNest device.',
|
|
9476
|
+
nullable: true,
|
|
9477
|
+
type: 'string',
|
|
9478
|
+
},
|
|
9479
|
+
has_photo: {
|
|
9480
|
+
description: 'Whether the KeyNest device has a photo.',
|
|
9481
|
+
type: 'boolean',
|
|
9482
|
+
},
|
|
9483
|
+
key_id: {
|
|
9484
|
+
description: 'Key ID for a KeyNest device.',
|
|
9485
|
+
type: 'string',
|
|
9486
|
+
},
|
|
9487
|
+
key_notes: {
|
|
9488
|
+
description: 'Key notes for a KeyNest device.',
|
|
9489
|
+
nullable: true,
|
|
9490
|
+
type: 'string',
|
|
9491
|
+
},
|
|
9492
|
+
keynest_app_user: {
|
|
9493
|
+
description: 'KeyNest app user for a KeyNest device.',
|
|
9494
|
+
nullable: true,
|
|
9495
|
+
type: 'string',
|
|
9496
|
+
},
|
|
9497
|
+
last_movement: {
|
|
9498
|
+
description: 'Last movement timestamp for a KeyNest device.',
|
|
9499
|
+
type: 'string',
|
|
9500
|
+
},
|
|
9501
|
+
property_id: {
|
|
9502
|
+
description: 'Property ID for a KeyNest device.',
|
|
9503
|
+
nullable: true,
|
|
9504
|
+
type: 'string',
|
|
9505
|
+
},
|
|
9506
|
+
property_postcode: {
|
|
9507
|
+
description: 'Property postcode for a KeyNest device.',
|
|
9508
|
+
nullable: true,
|
|
9509
|
+
type: 'string',
|
|
9510
|
+
},
|
|
9511
|
+
status_type: {
|
|
9512
|
+
description: 'Status type for a KeyNest device.',
|
|
9513
|
+
type: 'string',
|
|
9514
|
+
},
|
|
9515
|
+
subscription_plan: {
|
|
9516
|
+
description: 'Subscription plan for a KeyNest device.',
|
|
9517
|
+
type: 'string',
|
|
9518
|
+
},
|
|
9519
|
+
},
|
|
9520
|
+
required: [
|
|
9521
|
+
'key_id',
|
|
9522
|
+
'device_name',
|
|
9523
|
+
'property_id',
|
|
9524
|
+
'property_postcode',
|
|
9525
|
+
'key_notes',
|
|
9526
|
+
'subscription_plan',
|
|
9527
|
+
'status_type',
|
|
9528
|
+
'current_or_last_store_id',
|
|
9529
|
+
'last_movement',
|
|
9530
|
+
'address',
|
|
9531
|
+
'current_status',
|
|
9532
|
+
'current_user_name',
|
|
9533
|
+
'current_user_email',
|
|
9534
|
+
'current_user_phone_number',
|
|
9535
|
+
'current_user_company',
|
|
9536
|
+
'handover_method',
|
|
9537
|
+
'keynest_app_user',
|
|
9538
|
+
'default_office_id',
|
|
9539
|
+
'fob_id',
|
|
9540
|
+
'has_photo',
|
|
9541
|
+
],
|
|
9542
|
+
type: 'object',
|
|
9543
|
+
},
|
|
9422
9544
|
kwikset_metadata: {
|
|
9423
9545
|
description: 'Metadata for a Kwikset device.',
|
|
9424
9546
|
properties: {
|
|
@@ -11411,6 +11533,7 @@ export default {
|
|
|
11411
11533
|
'salto_space',
|
|
11412
11534
|
'sensi',
|
|
11413
11535
|
'kwikset2',
|
|
11536
|
+
'keynest',
|
|
11414
11537
|
],
|
|
11415
11538
|
type: 'string',
|
|
11416
11539
|
},
|
|
@@ -18056,8 +18179,168 @@ export default {
|
|
|
18056
18179
|
},
|
|
18057
18180
|
type: 'array',
|
|
18058
18181
|
},
|
|
18182
|
+
user_identity: {
|
|
18183
|
+
description: 'User identity.',
|
|
18184
|
+
properties: {
|
|
18185
|
+
acs_user_ids: {
|
|
18186
|
+
description: 'Array of access system user IDs associated with the user identity.',
|
|
18187
|
+
items: { format: 'uuid', type: 'string' },
|
|
18188
|
+
type: 'array',
|
|
18189
|
+
},
|
|
18190
|
+
created_at: {
|
|
18191
|
+
description: 'Date and time at which the user identity was created.',
|
|
18192
|
+
format: 'date-time',
|
|
18193
|
+
type: 'string',
|
|
18194
|
+
},
|
|
18195
|
+
display_name: { minLength: 1, type: 'string' },
|
|
18196
|
+
email_address: {
|
|
18197
|
+
description: 'Unique email address for the user identity.',
|
|
18198
|
+
format: 'email',
|
|
18199
|
+
nullable: true,
|
|
18200
|
+
type: 'string',
|
|
18201
|
+
},
|
|
18202
|
+
errors: {
|
|
18203
|
+
description: '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.',
|
|
18204
|
+
items: {
|
|
18205
|
+
description: 'Errors associated with the user identity.',
|
|
18206
|
+
discriminator: { propertyName: 'error_code' },
|
|
18207
|
+
oneOf: [
|
|
18208
|
+
{
|
|
18209
|
+
description: 'Indicates that there is an issue with an access system user associated with this user identity.',
|
|
18210
|
+
properties: {
|
|
18211
|
+
acs_system_id: {
|
|
18212
|
+
description: 'ID of the access system that the user identity is associated with.',
|
|
18213
|
+
format: 'uuid',
|
|
18214
|
+
type: 'string',
|
|
18215
|
+
},
|
|
18216
|
+
acs_user_id: {
|
|
18217
|
+
description: 'ID of the access system user that has an issue.',
|
|
18218
|
+
format: 'uuid',
|
|
18219
|
+
type: 'string',
|
|
18220
|
+
},
|
|
18221
|
+
created_at: {
|
|
18222
|
+
description: 'Date and time at which Seam created the error.',
|
|
18223
|
+
format: 'date-time',
|
|
18224
|
+
type: 'string',
|
|
18225
|
+
},
|
|
18226
|
+
error_code: {
|
|
18227
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18228
|
+
enum: ['issue_with_acs_user'],
|
|
18229
|
+
type: 'string',
|
|
18230
|
+
},
|
|
18231
|
+
message: {
|
|
18232
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18233
|
+
type: 'string',
|
|
18234
|
+
},
|
|
18235
|
+
},
|
|
18236
|
+
required: [
|
|
18237
|
+
'created_at',
|
|
18238
|
+
'message',
|
|
18239
|
+
'error_code',
|
|
18240
|
+
'acs_user_id',
|
|
18241
|
+
'acs_system_id',
|
|
18242
|
+
],
|
|
18243
|
+
type: 'object',
|
|
18244
|
+
},
|
|
18245
|
+
],
|
|
18246
|
+
},
|
|
18247
|
+
type: 'array',
|
|
18248
|
+
},
|
|
18249
|
+
full_name: { minLength: 1, nullable: true, type: 'string' },
|
|
18250
|
+
phone_number: {
|
|
18251
|
+
description: 'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
|
|
18252
|
+
nullable: true,
|
|
18253
|
+
type: 'string',
|
|
18254
|
+
},
|
|
18255
|
+
user_identity_id: {
|
|
18256
|
+
description: 'ID of the user identity.',
|
|
18257
|
+
format: 'uuid',
|
|
18258
|
+
type: 'string',
|
|
18259
|
+
},
|
|
18260
|
+
user_identity_key: {
|
|
18261
|
+
description: 'Unique key for the user identity.',
|
|
18262
|
+
minLength: 1,
|
|
18263
|
+
nullable: true,
|
|
18264
|
+
type: 'string',
|
|
18265
|
+
},
|
|
18266
|
+
warnings: {
|
|
18267
|
+
description: '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.',
|
|
18268
|
+
items: {
|
|
18269
|
+
description: 'Warnings associated with the user identity.',
|
|
18270
|
+
discriminator: { propertyName: 'warning_code' },
|
|
18271
|
+
oneOf: [
|
|
18272
|
+
{
|
|
18273
|
+
description: 'Indicates that the user identity is currently being deleted.',
|
|
18274
|
+
properties: {
|
|
18275
|
+
created_at: {
|
|
18276
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18277
|
+
format: 'date-time',
|
|
18278
|
+
type: 'string',
|
|
18279
|
+
},
|
|
18280
|
+
message: {
|
|
18281
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18282
|
+
type: 'string',
|
|
18283
|
+
},
|
|
18284
|
+
warning_code: {
|
|
18285
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18286
|
+
enum: ['being_deleted'],
|
|
18287
|
+
type: 'string',
|
|
18288
|
+
},
|
|
18289
|
+
},
|
|
18290
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18291
|
+
type: 'object',
|
|
18292
|
+
},
|
|
18293
|
+
{
|
|
18294
|
+
description: "Indicates that the ACS user's profile does not match the user identity's profile",
|
|
18295
|
+
properties: {
|
|
18296
|
+
created_at: {
|
|
18297
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18298
|
+
format: 'date-time',
|
|
18299
|
+
type: 'string',
|
|
18300
|
+
},
|
|
18301
|
+
message: {
|
|
18302
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18303
|
+
type: 'string',
|
|
18304
|
+
},
|
|
18305
|
+
warning_code: {
|
|
18306
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18307
|
+
enum: [
|
|
18308
|
+
'acs_user_profile_does_not_match_user_identity',
|
|
18309
|
+
],
|
|
18310
|
+
type: 'string',
|
|
18311
|
+
},
|
|
18312
|
+
},
|
|
18313
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18314
|
+
type: 'object',
|
|
18315
|
+
},
|
|
18316
|
+
],
|
|
18317
|
+
},
|
|
18318
|
+
type: 'array',
|
|
18319
|
+
},
|
|
18320
|
+
workspace_id: {
|
|
18321
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
|
|
18322
|
+
format: 'uuid',
|
|
18323
|
+
type: 'string',
|
|
18324
|
+
},
|
|
18325
|
+
},
|
|
18326
|
+
required: [
|
|
18327
|
+
'user_identity_id',
|
|
18328
|
+
'user_identity_key',
|
|
18329
|
+
'email_address',
|
|
18330
|
+
'phone_number',
|
|
18331
|
+
'display_name',
|
|
18332
|
+
'full_name',
|
|
18333
|
+
'created_at',
|
|
18334
|
+
'workspace_id',
|
|
18335
|
+
'errors',
|
|
18336
|
+
'warnings',
|
|
18337
|
+
'acs_user_ids',
|
|
18338
|
+
],
|
|
18339
|
+
type: 'object',
|
|
18340
|
+
},
|
|
18341
|
+
workspace_id: { description: 'Workspace ID.', type: 'string' },
|
|
18059
18342
|
},
|
|
18060
|
-
required: ['provider_sessions'],
|
|
18343
|
+
required: ['provider_sessions', 'user_identity', 'workspace_id'],
|
|
18061
18344
|
type: 'object',
|
|
18062
18345
|
'x-route-path': '/seam/mobile_sdk/v1/phone_sessions',
|
|
18063
18346
|
'x-undocumented': 'Seam Mobile SDK only.',
|
|
@@ -25179,7 +25462,14 @@ export default {
|
|
|
25179
25462
|
required: false,
|
|
25180
25463
|
schema: {
|
|
25181
25464
|
items: {
|
|
25182
|
-
enum: [
|
|
25465
|
+
enum: [
|
|
25466
|
+
'spaces',
|
|
25467
|
+
'devices',
|
|
25468
|
+
'acs_entrances',
|
|
25469
|
+
'connected_accounts',
|
|
25470
|
+
'acs_systems',
|
|
25471
|
+
'user_identity',
|
|
25472
|
+
],
|
|
25183
25473
|
type: 'string',
|
|
25184
25474
|
},
|
|
25185
25475
|
type: 'array',
|
|
@@ -25191,7 +25481,14 @@ export default {
|
|
|
25191
25481
|
required: false,
|
|
25192
25482
|
schema: {
|
|
25193
25483
|
items: {
|
|
25194
|
-
enum: [
|
|
25484
|
+
enum: [
|
|
25485
|
+
'spaces',
|
|
25486
|
+
'devices',
|
|
25487
|
+
'acs_entrances',
|
|
25488
|
+
'connected_accounts',
|
|
25489
|
+
'acs_systems',
|
|
25490
|
+
'user_identity',
|
|
25491
|
+
],
|
|
25195
25492
|
type: 'string',
|
|
25196
25493
|
},
|
|
25197
25494
|
type: 'array',
|
|
@@ -25205,20 +25502,21 @@ export default {
|
|
|
25205
25502
|
schema: {
|
|
25206
25503
|
properties: {
|
|
25207
25504
|
batch: {
|
|
25208
|
-
description: 'Represents a resource batch.',
|
|
25209
25505
|
properties: {
|
|
25210
25506
|
acs_entrances: {
|
|
25211
25507
|
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
25212
25508
|
type: 'array',
|
|
25213
25509
|
},
|
|
25214
|
-
|
|
25215
|
-
|
|
25216
|
-
|
|
25217
|
-
|
|
25218
|
-
|
|
25219
|
-
|
|
25220
|
-
|
|
25221
|
-
|
|
25510
|
+
acs_systems: {
|
|
25511
|
+
items: { $ref: '#/components/schemas/acs_system' },
|
|
25512
|
+
type: 'array',
|
|
25513
|
+
},
|
|
25514
|
+
batch_type: { enum: ['access_grants'], type: 'string' },
|
|
25515
|
+
connected_accounts: {
|
|
25516
|
+
items: {
|
|
25517
|
+
$ref: '#/components/schemas/connected_account',
|
|
25518
|
+
},
|
|
25519
|
+
type: 'array',
|
|
25222
25520
|
},
|
|
25223
25521
|
devices: {
|
|
25224
25522
|
items: { $ref: '#/components/schemas/device' },
|
|
@@ -25232,14 +25530,9 @@ export default {
|
|
|
25232
25530
|
items: { $ref: '#/components/schemas/user_identity' },
|
|
25233
25531
|
type: 'array',
|
|
25234
25532
|
},
|
|
25235
|
-
workspaces: {
|
|
25236
|
-
items: { $ref: '#/components/schemas/workspace' },
|
|
25237
|
-
type: 'array',
|
|
25238
|
-
},
|
|
25239
25533
|
},
|
|
25240
25534
|
required: ['batch_type'],
|
|
25241
25535
|
type: 'object',
|
|
25242
|
-
'x-route-path': '/',
|
|
25243
25536
|
},
|
|
25244
25537
|
ok: { type: 'boolean' },
|
|
25245
25538
|
},
|
|
@@ -25283,14 +25576,28 @@ export default {
|
|
|
25283
25576
|
},
|
|
25284
25577
|
exclude: {
|
|
25285
25578
|
items: {
|
|
25286
|
-
enum: [
|
|
25579
|
+
enum: [
|
|
25580
|
+
'spaces',
|
|
25581
|
+
'devices',
|
|
25582
|
+
'acs_entrances',
|
|
25583
|
+
'connected_accounts',
|
|
25584
|
+
'acs_systems',
|
|
25585
|
+
'user_identity',
|
|
25586
|
+
],
|
|
25287
25587
|
type: 'string',
|
|
25288
25588
|
},
|
|
25289
25589
|
type: 'array',
|
|
25290
25590
|
},
|
|
25291
25591
|
include: {
|
|
25292
25592
|
items: {
|
|
25293
|
-
enum: [
|
|
25593
|
+
enum: [
|
|
25594
|
+
'spaces',
|
|
25595
|
+
'devices',
|
|
25596
|
+
'acs_entrances',
|
|
25597
|
+
'connected_accounts',
|
|
25598
|
+
'acs_systems',
|
|
25599
|
+
'user_identity',
|
|
25600
|
+
],
|
|
25294
25601
|
type: 'string',
|
|
25295
25602
|
},
|
|
25296
25603
|
type: 'array',
|
|
@@ -25309,20 +25616,21 @@ export default {
|
|
|
25309
25616
|
schema: {
|
|
25310
25617
|
properties: {
|
|
25311
25618
|
batch: {
|
|
25312
|
-
description: 'Represents a resource batch.',
|
|
25313
25619
|
properties: {
|
|
25314
25620
|
acs_entrances: {
|
|
25315
25621
|
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
25316
25622
|
type: 'array',
|
|
25317
25623
|
},
|
|
25318
|
-
|
|
25319
|
-
|
|
25320
|
-
|
|
25321
|
-
|
|
25322
|
-
|
|
25323
|
-
|
|
25324
|
-
|
|
25325
|
-
|
|
25624
|
+
acs_systems: {
|
|
25625
|
+
items: { $ref: '#/components/schemas/acs_system' },
|
|
25626
|
+
type: 'array',
|
|
25627
|
+
},
|
|
25628
|
+
batch_type: { enum: ['access_grants'], type: 'string' },
|
|
25629
|
+
connected_accounts: {
|
|
25630
|
+
items: {
|
|
25631
|
+
$ref: '#/components/schemas/connected_account',
|
|
25632
|
+
},
|
|
25633
|
+
type: 'array',
|
|
25326
25634
|
},
|
|
25327
25635
|
devices: {
|
|
25328
25636
|
items: { $ref: '#/components/schemas/device' },
|
|
@@ -25336,14 +25644,9 @@ export default {
|
|
|
25336
25644
|
items: { $ref: '#/components/schemas/user_identity' },
|
|
25337
25645
|
type: 'array',
|
|
25338
25646
|
},
|
|
25339
|
-
workspaces: {
|
|
25340
|
-
items: { $ref: '#/components/schemas/workspace' },
|
|
25341
|
-
type: 'array',
|
|
25342
|
-
},
|
|
25343
25647
|
},
|
|
25344
25648
|
required: ['batch_type'],
|
|
25345
25649
|
type: 'object',
|
|
25346
|
-
'x-route-path': '/',
|
|
25347
25650
|
},
|
|
25348
25651
|
ok: { type: 'boolean' },
|
|
25349
25652
|
},
|
|
@@ -33268,6 +33571,7 @@ export default {
|
|
|
33268
33571
|
'salto_space',
|
|
33269
33572
|
'sensi',
|
|
33270
33573
|
'kwikset2',
|
|
33574
|
+
'keynest',
|
|
33271
33575
|
'yale_access',
|
|
33272
33576
|
'hid_cm',
|
|
33273
33577
|
'google_nest',
|
|
@@ -34383,7 +34687,7 @@ export default {
|
|
|
34383
34687
|
type: 'array',
|
|
34384
34688
|
},
|
|
34385
34689
|
name: {
|
|
34386
|
-
description: 'Your
|
|
34690
|
+
description: 'Your name for this access grant resource.',
|
|
34387
34691
|
type: 'string',
|
|
34388
34692
|
},
|
|
34389
34693
|
property_keys: {
|
|
@@ -34427,7 +34731,7 @@ export default {
|
|
|
34427
34731
|
type: 'string',
|
|
34428
34732
|
},
|
|
34429
34733
|
},
|
|
34430
|
-
required: ['
|
|
34734
|
+
required: ['access_grant_key'],
|
|
34431
34735
|
type: 'object',
|
|
34432
34736
|
},
|
|
34433
34737
|
type: 'array',
|
|
@@ -34469,7 +34773,7 @@ export default {
|
|
|
34469
34773
|
type: 'array',
|
|
34470
34774
|
},
|
|
34471
34775
|
name: {
|
|
34472
|
-
description: 'Your
|
|
34776
|
+
description: 'Your name for this access grant resource.',
|
|
34473
34777
|
type: 'string',
|
|
34474
34778
|
},
|
|
34475
34779
|
property_keys: {
|
|
@@ -34513,7 +34817,7 @@ export default {
|
|
|
34513
34817
|
type: 'string',
|
|
34514
34818
|
},
|
|
34515
34819
|
},
|
|
34516
|
-
required: ['
|
|
34820
|
+
required: ['booking_key'],
|
|
34517
34821
|
type: 'object',
|
|
34518
34822
|
},
|
|
34519
34823
|
type: 'array',
|
|
@@ -34689,7 +34993,7 @@ export default {
|
|
|
34689
34993
|
type: 'array',
|
|
34690
34994
|
},
|
|
34691
34995
|
name: {
|
|
34692
|
-
description: 'Your
|
|
34996
|
+
description: 'Your name for this access grant resource.',
|
|
34693
34997
|
type: 'string',
|
|
34694
34998
|
},
|
|
34695
34999
|
property_keys: {
|
|
@@ -34737,7 +35041,7 @@ export default {
|
|
|
34737
35041
|
type: 'string',
|
|
34738
35042
|
},
|
|
34739
35043
|
},
|
|
34740
|
-
required: ['
|
|
35044
|
+
required: ['reservation_key'],
|
|
34741
35045
|
type: 'object',
|
|
34742
35046
|
},
|
|
34743
35047
|
type: 'array',
|
|
@@ -34991,7 +35295,7 @@ export default {
|
|
|
34991
35295
|
type: 'array',
|
|
34992
35296
|
},
|
|
34993
35297
|
name: {
|
|
34994
|
-
description: 'Your
|
|
35298
|
+
description: 'Your name for this access grant resource.',
|
|
34995
35299
|
type: 'string',
|
|
34996
35300
|
},
|
|
34997
35301
|
property_keys: {
|
|
@@ -35035,7 +35339,7 @@ export default {
|
|
|
35035
35339
|
type: 'string',
|
|
35036
35340
|
},
|
|
35037
35341
|
},
|
|
35038
|
-
required: ['
|
|
35342
|
+
required: ['access_grant_key'],
|
|
35039
35343
|
type: 'object',
|
|
35040
35344
|
},
|
|
35041
35345
|
type: 'array',
|
|
@@ -35077,7 +35381,7 @@ export default {
|
|
|
35077
35381
|
type: 'array',
|
|
35078
35382
|
},
|
|
35079
35383
|
name: {
|
|
35080
|
-
description: 'Your
|
|
35384
|
+
description: 'Your name for this access grant resource.',
|
|
35081
35385
|
type: 'string',
|
|
35082
35386
|
},
|
|
35083
35387
|
property_keys: {
|
|
@@ -35121,7 +35425,7 @@ export default {
|
|
|
35121
35425
|
type: 'string',
|
|
35122
35426
|
},
|
|
35123
35427
|
},
|
|
35124
|
-
required: ['
|
|
35428
|
+
required: ['booking_key'],
|
|
35125
35429
|
type: 'object',
|
|
35126
35430
|
},
|
|
35127
35431
|
type: 'array',
|
|
@@ -35297,7 +35601,7 @@ export default {
|
|
|
35297
35601
|
type: 'array',
|
|
35298
35602
|
},
|
|
35299
35603
|
name: {
|
|
35300
|
-
description: 'Your
|
|
35604
|
+
description: 'Your name for this access grant resource.',
|
|
35301
35605
|
type: 'string',
|
|
35302
35606
|
},
|
|
35303
35607
|
property_keys: {
|
|
@@ -35345,7 +35649,7 @@ export default {
|
|
|
35345
35649
|
type: 'string',
|
|
35346
35650
|
},
|
|
35347
35651
|
},
|
|
35348
|
-
required: ['
|
|
35652
|
+
required: ['reservation_key'],
|
|
35349
35653
|
type: 'object',
|
|
35350
35654
|
},
|
|
35351
35655
|
type: 'array',
|
|
@@ -35972,6 +36276,7 @@ export default {
|
|
|
35972
36276
|
'tado',
|
|
35973
36277
|
'sensi',
|
|
35974
36278
|
'smartthings',
|
|
36279
|
+
'keynest',
|
|
35975
36280
|
],
|
|
35976
36281
|
type: 'string',
|
|
35977
36282
|
},
|
|
@@ -36421,6 +36726,7 @@ export default {
|
|
|
36421
36726
|
'tado',
|
|
36422
36727
|
'sensi',
|
|
36423
36728
|
'smartthings',
|
|
36729
|
+
'keynest',
|
|
36424
36730
|
],
|
|
36425
36731
|
type: 'string',
|
|
36426
36732
|
},
|
|
@@ -36769,7 +37075,7 @@ export default {
|
|
|
36769
37075
|
},
|
|
36770
37076
|
'/devices/simulate/disconnect_from_hub': {
|
|
36771
37077
|
post: {
|
|
36772
|
-
description: 'Simulates taking the Wi
|
|
37078
|
+
description: 'Simulates taking the Wi‑Fi 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.',
|
|
36773
37079
|
operationId: 'devicesSimulateDisconnectFromHubPost',
|
|
36774
37080
|
requestBody: {
|
|
36775
37081
|
content: {
|
|
@@ -37198,6 +37504,7 @@ export default {
|
|
|
37198
37504
|
'tado',
|
|
37199
37505
|
'sensi',
|
|
37200
37506
|
'smartthings',
|
|
37507
|
+
'keynest',
|
|
37201
37508
|
],
|
|
37202
37509
|
type: 'string',
|
|
37203
37510
|
},
|
|
@@ -37644,6 +37951,7 @@ export default {
|
|
|
37644
37951
|
'tado',
|
|
37645
37952
|
'sensi',
|
|
37646
37953
|
'smartthings',
|
|
37954
|
+
'keynest',
|
|
37647
37955
|
],
|
|
37648
37956
|
type: 'string',
|
|
37649
37957
|
},
|
|
@@ -41816,10 +42124,10 @@ export default {
|
|
|
41816
42124
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
41817
42125
|
},
|
|
41818
42126
|
},
|
|
41819
|
-
'/seam/console/v1/
|
|
42127
|
+
'/seam/console/v1/get_resource_locator': {
|
|
41820
42128
|
get: {
|
|
41821
|
-
description: 'Returns the type of a resource given its UUID.',
|
|
41822
|
-
operationId: '
|
|
42129
|
+
description: 'Returns the type and system information of a resource given its UUID.',
|
|
42130
|
+
operationId: 'seamConsoleV1GetResourceLocatorGet',
|
|
41823
42131
|
parameters: [
|
|
41824
42132
|
{
|
|
41825
42133
|
in: 'query',
|
|
@@ -41835,9 +42143,17 @@ export default {
|
|
|
41835
42143
|
schema: {
|
|
41836
42144
|
properties: {
|
|
41837
42145
|
ok: { type: 'boolean' },
|
|
41838
|
-
|
|
42146
|
+
resource_locator: {
|
|
42147
|
+
properties: {
|
|
42148
|
+
acs_system_id: { format: 'uuid', type: 'string' },
|
|
42149
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
42150
|
+
resource_type: { type: 'string' },
|
|
42151
|
+
},
|
|
42152
|
+
required: ['resource_type'],
|
|
42153
|
+
type: 'object',
|
|
42154
|
+
},
|
|
41839
42155
|
},
|
|
41840
|
-
required: ['
|
|
42156
|
+
required: ['resource_locator', 'ok'],
|
|
41841
42157
|
type: 'object',
|
|
41842
42158
|
},
|
|
41843
42159
|
},
|
|
@@ -41853,18 +42169,18 @@ export default {
|
|
|
41853
42169
|
{ console_session_with_workspace: [] },
|
|
41854
42170
|
{ api_key: [] },
|
|
41855
42171
|
],
|
|
41856
|
-
summary: '/seam/console/v1/
|
|
42172
|
+
summary: '/seam/console/v1/get_resource_locator',
|
|
41857
42173
|
tags: [],
|
|
41858
42174
|
'x-fern-sdk-group-name': ['seam', 'console', 'v1'],
|
|
41859
|
-
'x-fern-sdk-method-name': '
|
|
41860
|
-
'x-fern-sdk-return-value': '
|
|
41861
|
-
'x-response-key': '
|
|
41862
|
-
'x-title': 'Get Resource
|
|
42175
|
+
'x-fern-sdk-method-name': 'get_resource_locator',
|
|
42176
|
+
'x-fern-sdk-return-value': 'resource_locator',
|
|
42177
|
+
'x-response-key': 'resource_locator',
|
|
42178
|
+
'x-title': 'Get Resource Locator',
|
|
41863
42179
|
'x-undocumented': 'Internal endpoint for Console',
|
|
41864
42180
|
},
|
|
41865
42181
|
post: {
|
|
41866
|
-
description: 'Returns the type of a resource given its UUID.',
|
|
41867
|
-
operationId: '
|
|
42182
|
+
description: 'Returns the type and system information of a resource given its UUID.',
|
|
42183
|
+
operationId: 'seamConsoleV1GetResourceLocatorPost',
|
|
41868
42184
|
parameters: [
|
|
41869
42185
|
{
|
|
41870
42186
|
in: 'query',
|
|
@@ -41880,9 +42196,17 @@ export default {
|
|
|
41880
42196
|
schema: {
|
|
41881
42197
|
properties: {
|
|
41882
42198
|
ok: { type: 'boolean' },
|
|
41883
|
-
|
|
42199
|
+
resource_locator: {
|
|
42200
|
+
properties: {
|
|
42201
|
+
acs_system_id: { format: 'uuid', type: 'string' },
|
|
42202
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
42203
|
+
resource_type: { type: 'string' },
|
|
42204
|
+
},
|
|
42205
|
+
required: ['resource_type'],
|
|
42206
|
+
type: 'object',
|
|
42207
|
+
},
|
|
41884
42208
|
},
|
|
41885
|
-
required: ['
|
|
42209
|
+
required: ['resource_locator', 'ok'],
|
|
41886
42210
|
type: 'object',
|
|
41887
42211
|
},
|
|
41888
42212
|
},
|
|
@@ -41898,13 +42222,13 @@ export default {
|
|
|
41898
42222
|
{ console_session_with_workspace: [] },
|
|
41899
42223
|
{ api_key: [] },
|
|
41900
42224
|
],
|
|
41901
|
-
summary: '/seam/console/v1/
|
|
42225
|
+
summary: '/seam/console/v1/get_resource_locator',
|
|
41902
42226
|
tags: [],
|
|
41903
42227
|
'x-fern-sdk-group-name': ['seam', 'console', 'v1'],
|
|
41904
|
-
'x-fern-sdk-method-name': '
|
|
41905
|
-
'x-fern-sdk-return-value': '
|
|
41906
|
-
'x-response-key': '
|
|
41907
|
-
'x-title': 'Get Resource
|
|
42228
|
+
'x-fern-sdk-method-name': 'get_resource_locator',
|
|
42229
|
+
'x-fern-sdk-return-value': 'resource_locator',
|
|
42230
|
+
'x-response-key': 'resource_locator',
|
|
42231
|
+
'x-title': 'Get Resource Locator',
|
|
41908
42232
|
'x-undocumented': 'Internal endpoint for Console',
|
|
41909
42233
|
},
|
|
41910
42234
|
},
|
|
@@ -42358,7 +42682,7 @@ export default {
|
|
|
42358
42682
|
type: 'string',
|
|
42359
42683
|
},
|
|
42360
42684
|
},
|
|
42361
|
-
required: ['rule'
|
|
42685
|
+
required: ['rule'],
|
|
42362
42686
|
type: 'object',
|
|
42363
42687
|
},
|
|
42364
42688
|
reservation_time_updated: {
|
|
@@ -42371,7 +42695,7 @@ export default {
|
|
|
42371
42695
|
type: 'string',
|
|
42372
42696
|
},
|
|
42373
42697
|
},
|
|
42374
|
-
required: ['rule'
|
|
42698
|
+
required: ['rule'],
|
|
42375
42699
|
type: 'object',
|
|
42376
42700
|
},
|
|
42377
42701
|
},
|
|
@@ -42458,7 +42782,7 @@ export default {
|
|
|
42458
42782
|
type: 'string',
|
|
42459
42783
|
},
|
|
42460
42784
|
},
|
|
42461
|
-
required: ['rule'
|
|
42785
|
+
required: ['rule'],
|
|
42462
42786
|
type: 'object',
|
|
42463
42787
|
},
|
|
42464
42788
|
reservation_time_updated: {
|
|
@@ -42471,7 +42795,7 @@ export default {
|
|
|
42471
42795
|
type: 'string',
|
|
42472
42796
|
},
|
|
42473
42797
|
},
|
|
42474
|
-
required: ['rule'
|
|
42798
|
+
required: ['rule'],
|
|
42475
42799
|
type: 'object',
|
|
42476
42800
|
},
|
|
42477
42801
|
},
|
|
@@ -42558,7 +42882,7 @@ export default {
|
|
|
42558
42882
|
type: 'string',
|
|
42559
42883
|
},
|
|
42560
42884
|
},
|
|
42561
|
-
required: ['rule'
|
|
42885
|
+
required: ['rule'],
|
|
42562
42886
|
type: 'object',
|
|
42563
42887
|
},
|
|
42564
42888
|
reservation_time_updated: {
|
|
@@ -42569,7 +42893,7 @@ export default {
|
|
|
42569
42893
|
type: 'string',
|
|
42570
42894
|
},
|
|
42571
42895
|
},
|
|
42572
|
-
required: ['rule'
|
|
42896
|
+
required: ['rule'],
|
|
42573
42897
|
type: 'object',
|
|
42574
42898
|
},
|
|
42575
42899
|
},
|
|
@@ -42664,7 +42988,7 @@ export default {
|
|
|
42664
42988
|
type: 'string',
|
|
42665
42989
|
},
|
|
42666
42990
|
},
|
|
42667
|
-
required: ['rule'
|
|
42991
|
+
required: ['rule'],
|
|
42668
42992
|
type: 'object',
|
|
42669
42993
|
},
|
|
42670
42994
|
reservation_time_updated: {
|
|
@@ -42675,7 +42999,7 @@ export default {
|
|
|
42675
42999
|
type: 'string',
|
|
42676
43000
|
},
|
|
42677
43001
|
},
|
|
42678
|
-
required: ['rule'
|
|
43002
|
+
required: ['rule'],
|
|
42679
43003
|
type: 'object',
|
|
42680
43004
|
},
|
|
42681
43005
|
},
|
|
@@ -43899,7 +44223,13 @@ export default {
|
|
|
43899
44223
|
required: false,
|
|
43900
44224
|
schema: {
|
|
43901
44225
|
items: {
|
|
43902
|
-
enum: [
|
|
44226
|
+
enum: [
|
|
44227
|
+
'spaces',
|
|
44228
|
+
'devices',
|
|
44229
|
+
'acs_entrances',
|
|
44230
|
+
'connected_accounts',
|
|
44231
|
+
'acs_systems',
|
|
44232
|
+
],
|
|
43903
44233
|
type: 'string',
|
|
43904
44234
|
},
|
|
43905
44235
|
type: 'array',
|
|
@@ -43911,7 +44241,13 @@ export default {
|
|
|
43911
44241
|
required: false,
|
|
43912
44242
|
schema: {
|
|
43913
44243
|
items: {
|
|
43914
|
-
enum: [
|
|
44244
|
+
enum: [
|
|
44245
|
+
'spaces',
|
|
44246
|
+
'devices',
|
|
44247
|
+
'acs_entrances',
|
|
44248
|
+
'connected_accounts',
|
|
44249
|
+
'acs_systems',
|
|
44250
|
+
],
|
|
43915
44251
|
type: 'string',
|
|
43916
44252
|
},
|
|
43917
44253
|
type: 'array',
|
|
@@ -43925,20 +44261,22 @@ export default {
|
|
|
43925
44261
|
schema: {
|
|
43926
44262
|
properties: {
|
|
43927
44263
|
batch: {
|
|
43928
|
-
description: '
|
|
44264
|
+
description: 'ID of the affected access system user.',
|
|
43929
44265
|
properties: {
|
|
43930
44266
|
acs_entrances: {
|
|
43931
44267
|
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
43932
44268
|
type: 'array',
|
|
43933
44269
|
},
|
|
43934
|
-
|
|
43935
|
-
|
|
43936
|
-
|
|
43937
|
-
|
|
43938
|
-
|
|
43939
|
-
|
|
43940
|
-
|
|
43941
|
-
|
|
44270
|
+
acs_systems: {
|
|
44271
|
+
items: { $ref: '#/components/schemas/acs_system' },
|
|
44272
|
+
type: 'array',
|
|
44273
|
+
},
|
|
44274
|
+
batch_type: { enum: ['spaces'], type: 'string' },
|
|
44275
|
+
connected_accounts: {
|
|
44276
|
+
items: {
|
|
44277
|
+
$ref: '#/components/schemas/connected_account',
|
|
44278
|
+
},
|
|
44279
|
+
type: 'array',
|
|
43942
44280
|
},
|
|
43943
44281
|
devices: {
|
|
43944
44282
|
items: { $ref: '#/components/schemas/device' },
|
|
@@ -43948,18 +44286,9 @@ export default {
|
|
|
43948
44286
|
items: { $ref: '#/components/schemas/space' },
|
|
43949
44287
|
type: 'array',
|
|
43950
44288
|
},
|
|
43951
|
-
user_identities: {
|
|
43952
|
-
items: { $ref: '#/components/schemas/user_identity' },
|
|
43953
|
-
type: 'array',
|
|
43954
|
-
},
|
|
43955
|
-
workspaces: {
|
|
43956
|
-
items: { $ref: '#/components/schemas/workspace' },
|
|
43957
|
-
type: 'array',
|
|
43958
|
-
},
|
|
43959
44289
|
},
|
|
43960
44290
|
required: ['batch_type'],
|
|
43961
44291
|
type: 'object',
|
|
43962
|
-
'x-route-path': '/',
|
|
43963
44292
|
},
|
|
43964
44293
|
ok: { type: 'boolean' },
|
|
43965
44294
|
},
|
|
@@ -43998,14 +44327,26 @@ export default {
|
|
|
43998
44327
|
properties: {
|
|
43999
44328
|
exclude: {
|
|
44000
44329
|
items: {
|
|
44001
|
-
enum: [
|
|
44330
|
+
enum: [
|
|
44331
|
+
'spaces',
|
|
44332
|
+
'devices',
|
|
44333
|
+
'acs_entrances',
|
|
44334
|
+
'connected_accounts',
|
|
44335
|
+
'acs_systems',
|
|
44336
|
+
],
|
|
44002
44337
|
type: 'string',
|
|
44003
44338
|
},
|
|
44004
44339
|
type: 'array',
|
|
44005
44340
|
},
|
|
44006
44341
|
include: {
|
|
44007
44342
|
items: {
|
|
44008
|
-
enum: [
|
|
44343
|
+
enum: [
|
|
44344
|
+
'spaces',
|
|
44345
|
+
'devices',
|
|
44346
|
+
'acs_entrances',
|
|
44347
|
+
'connected_accounts',
|
|
44348
|
+
'acs_systems',
|
|
44349
|
+
],
|
|
44009
44350
|
type: 'string',
|
|
44010
44351
|
},
|
|
44011
44352
|
type: 'array',
|
|
@@ -44029,20 +44370,22 @@ export default {
|
|
|
44029
44370
|
schema: {
|
|
44030
44371
|
properties: {
|
|
44031
44372
|
batch: {
|
|
44032
|
-
description: '
|
|
44373
|
+
description: 'ID of the affected access system user.',
|
|
44033
44374
|
properties: {
|
|
44034
44375
|
acs_entrances: {
|
|
44035
44376
|
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
44036
44377
|
type: 'array',
|
|
44037
44378
|
},
|
|
44038
|
-
|
|
44039
|
-
|
|
44040
|
-
|
|
44041
|
-
|
|
44042
|
-
|
|
44043
|
-
|
|
44044
|
-
|
|
44045
|
-
|
|
44379
|
+
acs_systems: {
|
|
44380
|
+
items: { $ref: '#/components/schemas/acs_system' },
|
|
44381
|
+
type: 'array',
|
|
44382
|
+
},
|
|
44383
|
+
batch_type: { enum: ['spaces'], type: 'string' },
|
|
44384
|
+
connected_accounts: {
|
|
44385
|
+
items: {
|
|
44386
|
+
$ref: '#/components/schemas/connected_account',
|
|
44387
|
+
},
|
|
44388
|
+
type: 'array',
|
|
44046
44389
|
},
|
|
44047
44390
|
devices: {
|
|
44048
44391
|
items: { $ref: '#/components/schemas/device' },
|
|
@@ -44052,18 +44395,9 @@ export default {
|
|
|
44052
44395
|
items: { $ref: '#/components/schemas/space' },
|
|
44053
44396
|
type: 'array',
|
|
44054
44397
|
},
|
|
44055
|
-
user_identities: {
|
|
44056
|
-
items: { $ref: '#/components/schemas/user_identity' },
|
|
44057
|
-
type: 'array',
|
|
44058
|
-
},
|
|
44059
|
-
workspaces: {
|
|
44060
|
-
items: { $ref: '#/components/schemas/workspace' },
|
|
44061
|
-
type: 'array',
|
|
44062
|
-
},
|
|
44063
44398
|
},
|
|
44064
44399
|
required: ['batch_type'],
|
|
44065
44400
|
type: 'object',
|
|
44066
|
-
'x-route-path': '/',
|
|
44067
44401
|
},
|
|
44068
44402
|
ok: { type: 'boolean' },
|
|
44069
44403
|
},
|