@seamapi/types 1.460.0 → 1.461.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.
- package/dist/connect.cjs +441 -120
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1135 -352
- package/dist/index.cjs +441 -120
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +2338 -276
- 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/phones/phone-session.d.ts +167 -0
- 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 +341 -33
- package/lib/seam/connect/openapi.js +429 -113
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +650 -175
- 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/phones/phone-session.ts +5 -0
- package/src/lib/seam/connect/openapi.ts +456 -113
- package/src/lib/seam/connect/route-types.ts +820 -189
|
@@ -18179,8 +18179,168 @@ export default {
|
|
|
18179
18179
|
},
|
|
18180
18180
|
type: 'array',
|
|
18181
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' },
|
|
18182
18342
|
},
|
|
18183
|
-
required: ['provider_sessions'],
|
|
18343
|
+
required: ['provider_sessions', 'user_identity', 'workspace_id'],
|
|
18184
18344
|
type: 'object',
|
|
18185
18345
|
'x-route-path': '/seam/mobile_sdk/v1/phone_sessions',
|
|
18186
18346
|
'x-undocumented': 'Seam Mobile SDK only.',
|
|
@@ -25029,6 +25189,11 @@ export default {
|
|
|
25029
25189
|
items: { format: 'uuid', type: 'string' },
|
|
25030
25190
|
type: 'array',
|
|
25031
25191
|
},
|
|
25192
|
+
space_keys: {
|
|
25193
|
+
description: 'Set of keys of existing spaces to which access is being granted.',
|
|
25194
|
+
items: { type: 'string' },
|
|
25195
|
+
type: 'array',
|
|
25196
|
+
},
|
|
25032
25197
|
starts_at: {
|
|
25033
25198
|
description: 'Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
25034
25199
|
type: 'string',
|
|
@@ -25302,7 +25467,14 @@ export default {
|
|
|
25302
25467
|
required: false,
|
|
25303
25468
|
schema: {
|
|
25304
25469
|
items: {
|
|
25305
|
-
enum: [
|
|
25470
|
+
enum: [
|
|
25471
|
+
'spaces',
|
|
25472
|
+
'devices',
|
|
25473
|
+
'acs_entrances',
|
|
25474
|
+
'connected_accounts',
|
|
25475
|
+
'acs_systems',
|
|
25476
|
+
'user_identity',
|
|
25477
|
+
],
|
|
25306
25478
|
type: 'string',
|
|
25307
25479
|
},
|
|
25308
25480
|
type: 'array',
|
|
@@ -25314,7 +25486,14 @@ export default {
|
|
|
25314
25486
|
required: false,
|
|
25315
25487
|
schema: {
|
|
25316
25488
|
items: {
|
|
25317
|
-
enum: [
|
|
25489
|
+
enum: [
|
|
25490
|
+
'spaces',
|
|
25491
|
+
'devices',
|
|
25492
|
+
'acs_entrances',
|
|
25493
|
+
'connected_accounts',
|
|
25494
|
+
'acs_systems',
|
|
25495
|
+
'user_identity',
|
|
25496
|
+
],
|
|
25318
25497
|
type: 'string',
|
|
25319
25498
|
},
|
|
25320
25499
|
type: 'array',
|
|
@@ -25328,20 +25507,21 @@ export default {
|
|
|
25328
25507
|
schema: {
|
|
25329
25508
|
properties: {
|
|
25330
25509
|
batch: {
|
|
25331
|
-
description: 'Represents a resource batch.',
|
|
25332
25510
|
properties: {
|
|
25333
25511
|
acs_entrances: {
|
|
25334
25512
|
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
25335
25513
|
type: 'array',
|
|
25336
25514
|
},
|
|
25337
|
-
|
|
25338
|
-
|
|
25339
|
-
|
|
25340
|
-
|
|
25341
|
-
|
|
25342
|
-
|
|
25343
|
-
|
|
25344
|
-
|
|
25515
|
+
acs_systems: {
|
|
25516
|
+
items: { $ref: '#/components/schemas/acs_system' },
|
|
25517
|
+
type: 'array',
|
|
25518
|
+
},
|
|
25519
|
+
batch_type: { enum: ['access_grants'], type: 'string' },
|
|
25520
|
+
connected_accounts: {
|
|
25521
|
+
items: {
|
|
25522
|
+
$ref: '#/components/schemas/connected_account',
|
|
25523
|
+
},
|
|
25524
|
+
type: 'array',
|
|
25345
25525
|
},
|
|
25346
25526
|
devices: {
|
|
25347
25527
|
items: { $ref: '#/components/schemas/device' },
|
|
@@ -25355,14 +25535,9 @@ export default {
|
|
|
25355
25535
|
items: { $ref: '#/components/schemas/user_identity' },
|
|
25356
25536
|
type: 'array',
|
|
25357
25537
|
},
|
|
25358
|
-
workspaces: {
|
|
25359
|
-
items: { $ref: '#/components/schemas/workspace' },
|
|
25360
|
-
type: 'array',
|
|
25361
|
-
},
|
|
25362
25538
|
},
|
|
25363
25539
|
required: ['batch_type'],
|
|
25364
25540
|
type: 'object',
|
|
25365
|
-
'x-route-path': '/',
|
|
25366
25541
|
},
|
|
25367
25542
|
ok: { type: 'boolean' },
|
|
25368
25543
|
},
|
|
@@ -25406,14 +25581,28 @@ export default {
|
|
|
25406
25581
|
},
|
|
25407
25582
|
exclude: {
|
|
25408
25583
|
items: {
|
|
25409
|
-
enum: [
|
|
25584
|
+
enum: [
|
|
25585
|
+
'spaces',
|
|
25586
|
+
'devices',
|
|
25587
|
+
'acs_entrances',
|
|
25588
|
+
'connected_accounts',
|
|
25589
|
+
'acs_systems',
|
|
25590
|
+
'user_identity',
|
|
25591
|
+
],
|
|
25410
25592
|
type: 'string',
|
|
25411
25593
|
},
|
|
25412
25594
|
type: 'array',
|
|
25413
25595
|
},
|
|
25414
25596
|
include: {
|
|
25415
25597
|
items: {
|
|
25416
|
-
enum: [
|
|
25598
|
+
enum: [
|
|
25599
|
+
'spaces',
|
|
25600
|
+
'devices',
|
|
25601
|
+
'acs_entrances',
|
|
25602
|
+
'connected_accounts',
|
|
25603
|
+
'acs_systems',
|
|
25604
|
+
'user_identity',
|
|
25605
|
+
],
|
|
25417
25606
|
type: 'string',
|
|
25418
25607
|
},
|
|
25419
25608
|
type: 'array',
|
|
@@ -25432,20 +25621,21 @@ export default {
|
|
|
25432
25621
|
schema: {
|
|
25433
25622
|
properties: {
|
|
25434
25623
|
batch: {
|
|
25435
|
-
description: 'Represents a resource batch.',
|
|
25436
25624
|
properties: {
|
|
25437
25625
|
acs_entrances: {
|
|
25438
25626
|
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
25439
25627
|
type: 'array',
|
|
25440
25628
|
},
|
|
25441
|
-
|
|
25442
|
-
|
|
25443
|
-
|
|
25444
|
-
|
|
25445
|
-
|
|
25446
|
-
|
|
25447
|
-
|
|
25448
|
-
|
|
25629
|
+
acs_systems: {
|
|
25630
|
+
items: { $ref: '#/components/schemas/acs_system' },
|
|
25631
|
+
type: 'array',
|
|
25632
|
+
},
|
|
25633
|
+
batch_type: { enum: ['access_grants'], type: 'string' },
|
|
25634
|
+
connected_accounts: {
|
|
25635
|
+
items: {
|
|
25636
|
+
$ref: '#/components/schemas/connected_account',
|
|
25637
|
+
},
|
|
25638
|
+
type: 'array',
|
|
25449
25639
|
},
|
|
25450
25640
|
devices: {
|
|
25451
25641
|
items: { $ref: '#/components/schemas/device' },
|
|
@@ -25459,14 +25649,9 @@ export default {
|
|
|
25459
25649
|
items: { $ref: '#/components/schemas/user_identity' },
|
|
25460
25650
|
type: 'array',
|
|
25461
25651
|
},
|
|
25462
|
-
workspaces: {
|
|
25463
|
-
items: { $ref: '#/components/schemas/workspace' },
|
|
25464
|
-
type: 'array',
|
|
25465
|
-
},
|
|
25466
25652
|
},
|
|
25467
25653
|
required: ['batch_type'],
|
|
25468
25654
|
type: 'object',
|
|
25469
|
-
'x-route-path': '/',
|
|
25470
25655
|
},
|
|
25471
25656
|
ok: { type: 'boolean' },
|
|
25472
25657
|
},
|
|
@@ -34507,7 +34692,7 @@ export default {
|
|
|
34507
34692
|
type: 'array',
|
|
34508
34693
|
},
|
|
34509
34694
|
name: {
|
|
34510
|
-
description: 'Your
|
|
34695
|
+
description: 'Your name for this access grant resource.',
|
|
34511
34696
|
type: 'string',
|
|
34512
34697
|
},
|
|
34513
34698
|
property_keys: {
|
|
@@ -34551,7 +34736,7 @@ export default {
|
|
|
34551
34736
|
type: 'string',
|
|
34552
34737
|
},
|
|
34553
34738
|
},
|
|
34554
|
-
required: ['
|
|
34739
|
+
required: ['access_grant_key'],
|
|
34555
34740
|
type: 'object',
|
|
34556
34741
|
},
|
|
34557
34742
|
type: 'array',
|
|
@@ -34593,7 +34778,7 @@ export default {
|
|
|
34593
34778
|
type: 'array',
|
|
34594
34779
|
},
|
|
34595
34780
|
name: {
|
|
34596
|
-
description: 'Your
|
|
34781
|
+
description: 'Your name for this access grant resource.',
|
|
34597
34782
|
type: 'string',
|
|
34598
34783
|
},
|
|
34599
34784
|
property_keys: {
|
|
@@ -34637,7 +34822,7 @@ export default {
|
|
|
34637
34822
|
type: 'string',
|
|
34638
34823
|
},
|
|
34639
34824
|
},
|
|
34640
|
-
required: ['
|
|
34825
|
+
required: ['booking_key'],
|
|
34641
34826
|
type: 'object',
|
|
34642
34827
|
},
|
|
34643
34828
|
type: 'array',
|
|
@@ -34813,7 +34998,7 @@ export default {
|
|
|
34813
34998
|
type: 'array',
|
|
34814
34999
|
},
|
|
34815
35000
|
name: {
|
|
34816
|
-
description: 'Your
|
|
35001
|
+
description: 'Your name for this access grant resource.',
|
|
34817
35002
|
type: 'string',
|
|
34818
35003
|
},
|
|
34819
35004
|
property_keys: {
|
|
@@ -34861,7 +35046,7 @@ export default {
|
|
|
34861
35046
|
type: 'string',
|
|
34862
35047
|
},
|
|
34863
35048
|
},
|
|
34864
|
-
required: ['
|
|
35049
|
+
required: ['reservation_key'],
|
|
34865
35050
|
type: 'object',
|
|
34866
35051
|
},
|
|
34867
35052
|
type: 'array',
|
|
@@ -35115,7 +35300,7 @@ export default {
|
|
|
35115
35300
|
type: 'array',
|
|
35116
35301
|
},
|
|
35117
35302
|
name: {
|
|
35118
|
-
description: 'Your
|
|
35303
|
+
description: 'Your name for this access grant resource.',
|
|
35119
35304
|
type: 'string',
|
|
35120
35305
|
},
|
|
35121
35306
|
property_keys: {
|
|
@@ -35159,7 +35344,7 @@ export default {
|
|
|
35159
35344
|
type: 'string',
|
|
35160
35345
|
},
|
|
35161
35346
|
},
|
|
35162
|
-
required: ['
|
|
35347
|
+
required: ['access_grant_key'],
|
|
35163
35348
|
type: 'object',
|
|
35164
35349
|
},
|
|
35165
35350
|
type: 'array',
|
|
@@ -35201,7 +35386,7 @@ export default {
|
|
|
35201
35386
|
type: 'array',
|
|
35202
35387
|
},
|
|
35203
35388
|
name: {
|
|
35204
|
-
description: 'Your
|
|
35389
|
+
description: 'Your name for this access grant resource.',
|
|
35205
35390
|
type: 'string',
|
|
35206
35391
|
},
|
|
35207
35392
|
property_keys: {
|
|
@@ -35245,7 +35430,7 @@ export default {
|
|
|
35245
35430
|
type: 'string',
|
|
35246
35431
|
},
|
|
35247
35432
|
},
|
|
35248
|
-
required: ['
|
|
35433
|
+
required: ['booking_key'],
|
|
35249
35434
|
type: 'object',
|
|
35250
35435
|
},
|
|
35251
35436
|
type: 'array',
|
|
@@ -35421,7 +35606,7 @@ export default {
|
|
|
35421
35606
|
type: 'array',
|
|
35422
35607
|
},
|
|
35423
35608
|
name: {
|
|
35424
|
-
description: 'Your
|
|
35609
|
+
description: 'Your name for this access grant resource.',
|
|
35425
35610
|
type: 'string',
|
|
35426
35611
|
},
|
|
35427
35612
|
property_keys: {
|
|
@@ -35469,7 +35654,7 @@ export default {
|
|
|
35469
35654
|
type: 'string',
|
|
35470
35655
|
},
|
|
35471
35656
|
},
|
|
35472
|
-
required: ['
|
|
35657
|
+
required: ['reservation_key'],
|
|
35473
35658
|
type: 'object',
|
|
35474
35659
|
},
|
|
35475
35660
|
type: 'array',
|
|
@@ -36895,7 +37080,7 @@ export default {
|
|
|
36895
37080
|
},
|
|
36896
37081
|
'/devices/simulate/disconnect_from_hub': {
|
|
36897
37082
|
post: {
|
|
36898
|
-
description: 'Simulates taking the Wi
|
|
37083
|
+
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.',
|
|
36899
37084
|
operationId: 'devicesSimulateDisconnectFromHubPost',
|
|
36900
37085
|
requestBody: {
|
|
36901
37086
|
content: {
|
|
@@ -38949,6 +39134,111 @@ export default {
|
|
|
38949
39134
|
'x-title': 'List Events',
|
|
38950
39135
|
},
|
|
38951
39136
|
},
|
|
39137
|
+
'/instant_keys/list': {
|
|
39138
|
+
get: {
|
|
39139
|
+
description: 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
|
|
39140
|
+
operationId: 'instantKeysListGet',
|
|
39141
|
+
parameters: [
|
|
39142
|
+
{
|
|
39143
|
+
in: 'query',
|
|
39144
|
+
name: 'user_identity_id',
|
|
39145
|
+
schema: {
|
|
39146
|
+
description: 'ID of the user identity by which you want to filter the list of Instant Keys.',
|
|
39147
|
+
format: 'uuid',
|
|
39148
|
+
type: 'string',
|
|
39149
|
+
},
|
|
39150
|
+
},
|
|
39151
|
+
],
|
|
39152
|
+
responses: {
|
|
39153
|
+
200: {
|
|
39154
|
+
content: {
|
|
39155
|
+
'application/json': {
|
|
39156
|
+
schema: {
|
|
39157
|
+
properties: {
|
|
39158
|
+
instant_keys: {
|
|
39159
|
+
items: { $ref: '#/components/schemas/instant_key' },
|
|
39160
|
+
type: 'array',
|
|
39161
|
+
},
|
|
39162
|
+
ok: { type: 'boolean' },
|
|
39163
|
+
},
|
|
39164
|
+
required: ['instant_keys', 'ok'],
|
|
39165
|
+
type: 'object',
|
|
39166
|
+
},
|
|
39167
|
+
},
|
|
39168
|
+
},
|
|
39169
|
+
description: 'OK',
|
|
39170
|
+
},
|
|
39171
|
+
400: { description: 'Bad Request' },
|
|
39172
|
+
401: { description: 'Unauthorized' },
|
|
39173
|
+
},
|
|
39174
|
+
security: [
|
|
39175
|
+
{ api_key: [] },
|
|
39176
|
+
{ pat_with_workspace: [] },
|
|
39177
|
+
{ console_session_with_workspace: [] },
|
|
39178
|
+
],
|
|
39179
|
+
summary: '/instant_keys/list',
|
|
39180
|
+
tags: [],
|
|
39181
|
+
'x-fern-sdk-group-name': ['instant_keys'],
|
|
39182
|
+
'x-fern-sdk-method-name': 'list',
|
|
39183
|
+
'x-fern-sdk-return-value': 'instant_keys',
|
|
39184
|
+
'x-response-key': 'instant_keys',
|
|
39185
|
+
'x-title': 'List Instant Keys',
|
|
39186
|
+
},
|
|
39187
|
+
post: {
|
|
39188
|
+
description: 'Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).',
|
|
39189
|
+
operationId: 'instantKeysListPost',
|
|
39190
|
+
requestBody: {
|
|
39191
|
+
content: {
|
|
39192
|
+
'application/json': {
|
|
39193
|
+
schema: {
|
|
39194
|
+
properties: {
|
|
39195
|
+
user_identity_id: {
|
|
39196
|
+
description: 'ID of the user identity by which you want to filter the list of Instant Keys.',
|
|
39197
|
+
format: 'uuid',
|
|
39198
|
+
type: 'string',
|
|
39199
|
+
},
|
|
39200
|
+
},
|
|
39201
|
+
type: 'object',
|
|
39202
|
+
},
|
|
39203
|
+
},
|
|
39204
|
+
},
|
|
39205
|
+
},
|
|
39206
|
+
responses: {
|
|
39207
|
+
200: {
|
|
39208
|
+
content: {
|
|
39209
|
+
'application/json': {
|
|
39210
|
+
schema: {
|
|
39211
|
+
properties: {
|
|
39212
|
+
instant_keys: {
|
|
39213
|
+
items: { $ref: '#/components/schemas/instant_key' },
|
|
39214
|
+
type: 'array',
|
|
39215
|
+
},
|
|
39216
|
+
ok: { type: 'boolean' },
|
|
39217
|
+
},
|
|
39218
|
+
required: ['instant_keys', 'ok'],
|
|
39219
|
+
type: 'object',
|
|
39220
|
+
},
|
|
39221
|
+
},
|
|
39222
|
+
},
|
|
39223
|
+
description: 'OK',
|
|
39224
|
+
},
|
|
39225
|
+
400: { description: 'Bad Request' },
|
|
39226
|
+
401: { description: 'Unauthorized' },
|
|
39227
|
+
},
|
|
39228
|
+
security: [
|
|
39229
|
+
{ api_key: [] },
|
|
39230
|
+
{ pat_with_workspace: [] },
|
|
39231
|
+
{ console_session_with_workspace: [] },
|
|
39232
|
+
],
|
|
39233
|
+
summary: '/instant_keys/list',
|
|
39234
|
+
tags: [],
|
|
39235
|
+
'x-fern-sdk-group-name': ['instant_keys'],
|
|
39236
|
+
'x-fern-sdk-method-name': 'list',
|
|
39237
|
+
'x-fern-sdk-return-value': 'instant_keys',
|
|
39238
|
+
'x-response-key': 'instant_keys',
|
|
39239
|
+
'x-title': 'List Instant Keys',
|
|
39240
|
+
},
|
|
39241
|
+
},
|
|
38952
39242
|
'/locks/get': {
|
|
38953
39243
|
get: {
|
|
38954
39244
|
description: 'Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks). **Use `/devices/get` instead.**',
|
|
@@ -41944,10 +42234,10 @@ export default {
|
|
|
41944
42234
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
41945
42235
|
},
|
|
41946
42236
|
},
|
|
41947
|
-
'/seam/console/v1/
|
|
42237
|
+
'/seam/console/v1/get_resource_locator': {
|
|
41948
42238
|
get: {
|
|
41949
|
-
description: 'Returns the type of a resource given its UUID.',
|
|
41950
|
-
operationId: '
|
|
42239
|
+
description: 'Returns the type and system information of a resource given its UUID.',
|
|
42240
|
+
operationId: 'seamConsoleV1GetResourceLocatorGet',
|
|
41951
42241
|
parameters: [
|
|
41952
42242
|
{
|
|
41953
42243
|
in: 'query',
|
|
@@ -41963,9 +42253,17 @@ export default {
|
|
|
41963
42253
|
schema: {
|
|
41964
42254
|
properties: {
|
|
41965
42255
|
ok: { type: 'boolean' },
|
|
41966
|
-
|
|
42256
|
+
resource_locator: {
|
|
42257
|
+
properties: {
|
|
42258
|
+
acs_system_id: { format: 'uuid', type: 'string' },
|
|
42259
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
42260
|
+
resource_type: { type: 'string' },
|
|
42261
|
+
},
|
|
42262
|
+
required: ['resource_type'],
|
|
42263
|
+
type: 'object',
|
|
42264
|
+
},
|
|
41967
42265
|
},
|
|
41968
|
-
required: ['
|
|
42266
|
+
required: ['resource_locator', 'ok'],
|
|
41969
42267
|
type: 'object',
|
|
41970
42268
|
},
|
|
41971
42269
|
},
|
|
@@ -41981,18 +42279,18 @@ export default {
|
|
|
41981
42279
|
{ console_session_with_workspace: [] },
|
|
41982
42280
|
{ api_key: [] },
|
|
41983
42281
|
],
|
|
41984
|
-
summary: '/seam/console/v1/
|
|
42282
|
+
summary: '/seam/console/v1/get_resource_locator',
|
|
41985
42283
|
tags: [],
|
|
41986
42284
|
'x-fern-sdk-group-name': ['seam', 'console', 'v1'],
|
|
41987
|
-
'x-fern-sdk-method-name': '
|
|
41988
|
-
'x-fern-sdk-return-value': '
|
|
41989
|
-
'x-response-key': '
|
|
41990
|
-
'x-title': 'Get Resource
|
|
42285
|
+
'x-fern-sdk-method-name': 'get_resource_locator',
|
|
42286
|
+
'x-fern-sdk-return-value': 'resource_locator',
|
|
42287
|
+
'x-response-key': 'resource_locator',
|
|
42288
|
+
'x-title': 'Get Resource Locator',
|
|
41991
42289
|
'x-undocumented': 'Internal endpoint for Console',
|
|
41992
42290
|
},
|
|
41993
42291
|
post: {
|
|
41994
|
-
description: 'Returns the type of a resource given its UUID.',
|
|
41995
|
-
operationId: '
|
|
42292
|
+
description: 'Returns the type and system information of a resource given its UUID.',
|
|
42293
|
+
operationId: 'seamConsoleV1GetResourceLocatorPost',
|
|
41996
42294
|
parameters: [
|
|
41997
42295
|
{
|
|
41998
42296
|
in: 'query',
|
|
@@ -42008,9 +42306,17 @@ export default {
|
|
|
42008
42306
|
schema: {
|
|
42009
42307
|
properties: {
|
|
42010
42308
|
ok: { type: 'boolean' },
|
|
42011
|
-
|
|
42309
|
+
resource_locator: {
|
|
42310
|
+
properties: {
|
|
42311
|
+
acs_system_id: { format: 'uuid', type: 'string' },
|
|
42312
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
42313
|
+
resource_type: { type: 'string' },
|
|
42314
|
+
},
|
|
42315
|
+
required: ['resource_type'],
|
|
42316
|
+
type: 'object',
|
|
42317
|
+
},
|
|
42012
42318
|
},
|
|
42013
|
-
required: ['
|
|
42319
|
+
required: ['resource_locator', 'ok'],
|
|
42014
42320
|
type: 'object',
|
|
42015
42321
|
},
|
|
42016
42322
|
},
|
|
@@ -42026,13 +42332,13 @@ export default {
|
|
|
42026
42332
|
{ console_session_with_workspace: [] },
|
|
42027
42333
|
{ api_key: [] },
|
|
42028
42334
|
],
|
|
42029
|
-
summary: '/seam/console/v1/
|
|
42335
|
+
summary: '/seam/console/v1/get_resource_locator',
|
|
42030
42336
|
tags: [],
|
|
42031
42337
|
'x-fern-sdk-group-name': ['seam', 'console', 'v1'],
|
|
42032
|
-
'x-fern-sdk-method-name': '
|
|
42033
|
-
'x-fern-sdk-return-value': '
|
|
42034
|
-
'x-response-key': '
|
|
42035
|
-
'x-title': 'Get Resource
|
|
42338
|
+
'x-fern-sdk-method-name': 'get_resource_locator',
|
|
42339
|
+
'x-fern-sdk-return-value': 'resource_locator',
|
|
42340
|
+
'x-response-key': 'resource_locator',
|
|
42341
|
+
'x-title': 'Get Resource Locator',
|
|
42036
42342
|
'x-undocumented': 'Internal endpoint for Console',
|
|
42037
42343
|
},
|
|
42038
42344
|
},
|
|
@@ -42486,7 +42792,7 @@ export default {
|
|
|
42486
42792
|
type: 'string',
|
|
42487
42793
|
},
|
|
42488
42794
|
},
|
|
42489
|
-
required: ['rule'
|
|
42795
|
+
required: ['rule'],
|
|
42490
42796
|
type: 'object',
|
|
42491
42797
|
},
|
|
42492
42798
|
reservation_time_updated: {
|
|
@@ -42499,7 +42805,7 @@ export default {
|
|
|
42499
42805
|
type: 'string',
|
|
42500
42806
|
},
|
|
42501
42807
|
},
|
|
42502
|
-
required: ['rule'
|
|
42808
|
+
required: ['rule'],
|
|
42503
42809
|
type: 'object',
|
|
42504
42810
|
},
|
|
42505
42811
|
},
|
|
@@ -42586,7 +42892,7 @@ export default {
|
|
|
42586
42892
|
type: 'string',
|
|
42587
42893
|
},
|
|
42588
42894
|
},
|
|
42589
|
-
required: ['rule'
|
|
42895
|
+
required: ['rule'],
|
|
42590
42896
|
type: 'object',
|
|
42591
42897
|
},
|
|
42592
42898
|
reservation_time_updated: {
|
|
@@ -42599,7 +42905,7 @@ export default {
|
|
|
42599
42905
|
type: 'string',
|
|
42600
42906
|
},
|
|
42601
42907
|
},
|
|
42602
|
-
required: ['rule'
|
|
42908
|
+
required: ['rule'],
|
|
42603
42909
|
type: 'object',
|
|
42604
42910
|
},
|
|
42605
42911
|
},
|
|
@@ -42686,7 +42992,7 @@ export default {
|
|
|
42686
42992
|
type: 'string',
|
|
42687
42993
|
},
|
|
42688
42994
|
},
|
|
42689
|
-
required: ['rule'
|
|
42995
|
+
required: ['rule'],
|
|
42690
42996
|
type: 'object',
|
|
42691
42997
|
},
|
|
42692
42998
|
reservation_time_updated: {
|
|
@@ -42697,7 +43003,7 @@ export default {
|
|
|
42697
43003
|
type: 'string',
|
|
42698
43004
|
},
|
|
42699
43005
|
},
|
|
42700
|
-
required: ['rule'
|
|
43006
|
+
required: ['rule'],
|
|
42701
43007
|
type: 'object',
|
|
42702
43008
|
},
|
|
42703
43009
|
},
|
|
@@ -42792,7 +43098,7 @@ export default {
|
|
|
42792
43098
|
type: 'string',
|
|
42793
43099
|
},
|
|
42794
43100
|
},
|
|
42795
|
-
required: ['rule'
|
|
43101
|
+
required: ['rule'],
|
|
42796
43102
|
type: 'object',
|
|
42797
43103
|
},
|
|
42798
43104
|
reservation_time_updated: {
|
|
@@ -42803,7 +43109,7 @@ export default {
|
|
|
42803
43109
|
type: 'string',
|
|
42804
43110
|
},
|
|
42805
43111
|
},
|
|
42806
|
-
required: ['rule'
|
|
43112
|
+
required: ['rule'],
|
|
42807
43113
|
type: 'object',
|
|
42808
43114
|
},
|
|
42809
43115
|
},
|
|
@@ -44027,7 +44333,13 @@ export default {
|
|
|
44027
44333
|
required: false,
|
|
44028
44334
|
schema: {
|
|
44029
44335
|
items: {
|
|
44030
|
-
enum: [
|
|
44336
|
+
enum: [
|
|
44337
|
+
'spaces',
|
|
44338
|
+
'devices',
|
|
44339
|
+
'acs_entrances',
|
|
44340
|
+
'connected_accounts',
|
|
44341
|
+
'acs_systems',
|
|
44342
|
+
],
|
|
44031
44343
|
type: 'string',
|
|
44032
44344
|
},
|
|
44033
44345
|
type: 'array',
|
|
@@ -44039,7 +44351,13 @@ export default {
|
|
|
44039
44351
|
required: false,
|
|
44040
44352
|
schema: {
|
|
44041
44353
|
items: {
|
|
44042
|
-
enum: [
|
|
44354
|
+
enum: [
|
|
44355
|
+
'spaces',
|
|
44356
|
+
'devices',
|
|
44357
|
+
'acs_entrances',
|
|
44358
|
+
'connected_accounts',
|
|
44359
|
+
'acs_systems',
|
|
44360
|
+
],
|
|
44043
44361
|
type: 'string',
|
|
44044
44362
|
},
|
|
44045
44363
|
type: 'array',
|
|
@@ -44053,20 +44371,22 @@ export default {
|
|
|
44053
44371
|
schema: {
|
|
44054
44372
|
properties: {
|
|
44055
44373
|
batch: {
|
|
44056
|
-
description: '
|
|
44374
|
+
description: 'ID of the affected access system user.',
|
|
44057
44375
|
properties: {
|
|
44058
44376
|
acs_entrances: {
|
|
44059
44377
|
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
44060
44378
|
type: 'array',
|
|
44061
44379
|
},
|
|
44062
|
-
|
|
44063
|
-
|
|
44064
|
-
|
|
44065
|
-
|
|
44066
|
-
|
|
44067
|
-
|
|
44068
|
-
|
|
44069
|
-
|
|
44380
|
+
acs_systems: {
|
|
44381
|
+
items: { $ref: '#/components/schemas/acs_system' },
|
|
44382
|
+
type: 'array',
|
|
44383
|
+
},
|
|
44384
|
+
batch_type: { enum: ['spaces'], type: 'string' },
|
|
44385
|
+
connected_accounts: {
|
|
44386
|
+
items: {
|
|
44387
|
+
$ref: '#/components/schemas/connected_account',
|
|
44388
|
+
},
|
|
44389
|
+
type: 'array',
|
|
44070
44390
|
},
|
|
44071
44391
|
devices: {
|
|
44072
44392
|
items: { $ref: '#/components/schemas/device' },
|
|
@@ -44076,18 +44396,9 @@ export default {
|
|
|
44076
44396
|
items: { $ref: '#/components/schemas/space' },
|
|
44077
44397
|
type: 'array',
|
|
44078
44398
|
},
|
|
44079
|
-
user_identities: {
|
|
44080
|
-
items: { $ref: '#/components/schemas/user_identity' },
|
|
44081
|
-
type: 'array',
|
|
44082
|
-
},
|
|
44083
|
-
workspaces: {
|
|
44084
|
-
items: { $ref: '#/components/schemas/workspace' },
|
|
44085
|
-
type: 'array',
|
|
44086
|
-
},
|
|
44087
44399
|
},
|
|
44088
44400
|
required: ['batch_type'],
|
|
44089
44401
|
type: 'object',
|
|
44090
|
-
'x-route-path': '/',
|
|
44091
44402
|
},
|
|
44092
44403
|
ok: { type: 'boolean' },
|
|
44093
44404
|
},
|
|
@@ -44126,14 +44437,26 @@ export default {
|
|
|
44126
44437
|
properties: {
|
|
44127
44438
|
exclude: {
|
|
44128
44439
|
items: {
|
|
44129
|
-
enum: [
|
|
44440
|
+
enum: [
|
|
44441
|
+
'spaces',
|
|
44442
|
+
'devices',
|
|
44443
|
+
'acs_entrances',
|
|
44444
|
+
'connected_accounts',
|
|
44445
|
+
'acs_systems',
|
|
44446
|
+
],
|
|
44130
44447
|
type: 'string',
|
|
44131
44448
|
},
|
|
44132
44449
|
type: 'array',
|
|
44133
44450
|
},
|
|
44134
44451
|
include: {
|
|
44135
44452
|
items: {
|
|
44136
|
-
enum: [
|
|
44453
|
+
enum: [
|
|
44454
|
+
'spaces',
|
|
44455
|
+
'devices',
|
|
44456
|
+
'acs_entrances',
|
|
44457
|
+
'connected_accounts',
|
|
44458
|
+
'acs_systems',
|
|
44459
|
+
],
|
|
44137
44460
|
type: 'string',
|
|
44138
44461
|
},
|
|
44139
44462
|
type: 'array',
|
|
@@ -44157,20 +44480,22 @@ export default {
|
|
|
44157
44480
|
schema: {
|
|
44158
44481
|
properties: {
|
|
44159
44482
|
batch: {
|
|
44160
|
-
description: '
|
|
44483
|
+
description: 'ID of the affected access system user.',
|
|
44161
44484
|
properties: {
|
|
44162
44485
|
acs_entrances: {
|
|
44163
44486
|
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
44164
44487
|
type: 'array',
|
|
44165
44488
|
},
|
|
44166
|
-
|
|
44167
|
-
|
|
44168
|
-
|
|
44169
|
-
|
|
44170
|
-
|
|
44171
|
-
|
|
44172
|
-
|
|
44173
|
-
|
|
44489
|
+
acs_systems: {
|
|
44490
|
+
items: { $ref: '#/components/schemas/acs_system' },
|
|
44491
|
+
type: 'array',
|
|
44492
|
+
},
|
|
44493
|
+
batch_type: { enum: ['spaces'], type: 'string' },
|
|
44494
|
+
connected_accounts: {
|
|
44495
|
+
items: {
|
|
44496
|
+
$ref: '#/components/schemas/connected_account',
|
|
44497
|
+
},
|
|
44498
|
+
type: 'array',
|
|
44174
44499
|
},
|
|
44175
44500
|
devices: {
|
|
44176
44501
|
items: { $ref: '#/components/schemas/device' },
|
|
@@ -44180,18 +44505,9 @@ export default {
|
|
|
44180
44505
|
items: { $ref: '#/components/schemas/space' },
|
|
44181
44506
|
type: 'array',
|
|
44182
44507
|
},
|
|
44183
|
-
user_identities: {
|
|
44184
|
-
items: { $ref: '#/components/schemas/user_identity' },
|
|
44185
|
-
type: 'array',
|
|
44186
|
-
},
|
|
44187
|
-
workspaces: {
|
|
44188
|
-
items: { $ref: '#/components/schemas/workspace' },
|
|
44189
|
-
type: 'array',
|
|
44190
|
-
},
|
|
44191
44508
|
},
|
|
44192
44509
|
required: ['batch_type'],
|
|
44193
44510
|
type: 'object',
|
|
44194
|
-
'x-route-path': '/',
|
|
44195
44511
|
},
|
|
44196
44512
|
ok: { type: 'boolean' },
|
|
44197
44513
|
},
|