@seamapi/types 1.384.0 → 1.385.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 +456 -137
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1668 -208
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +8 -5
- package/lib/seam/connect/models/access-grants/access-grant.js +3 -0
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/access-grants/requested-access-method.d.ts +3 -3
- package/lib/seam/connect/models/access-grants/requested-access-method.js +2 -2
- package/lib/seam/connect/models/access-grants/requested-access-method.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +156 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js +4 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/simulate-keypad-code-entry.d.ts +80 -0
- package/lib/seam/connect/models/action-attempts/simulate-keypad-code-entry.js +28 -0
- package/lib/seam/connect/models/action-attempts/simulate-keypad-code-entry.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/simulate-manual-lock-via-keypad.d.ts +80 -0
- package/lib/seam/connect/models/action-attempts/simulate-manual-lock-via-keypad.js +28 -0
- package/lib/seam/connect/models/action-attempts/simulate-manual-lock-via-keypad.js.map +1 -0
- package/lib/seam/connect/openapi.d.ts +266 -175
- package/lib/seam/connect/openapi.js +408 -132
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1246 -33
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +5 -0
- package/src/lib/seam/connect/models/access-grants/requested-access-method.ts +4 -2
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +4 -0
- package/src/lib/seam/connect/models/action-attempts/simulate-keypad-code-entry.ts +39 -0
- package/src/lib/seam/connect/models/action-attempts/simulate-manual-lock-via-keypad.ts +37 -0
- package/src/lib/seam/connect/openapi.ts +426 -136
- package/src/lib/seam/connect/route-types.ts +1372 -33
|
@@ -5206,6 +5206,194 @@ export default {
|
|
|
5206
5206
|
],
|
|
5207
5207
|
type: 'object',
|
|
5208
5208
|
},
|
|
5209
|
+
{
|
|
5210
|
+
description: 'Simulating keypad code entry.',
|
|
5211
|
+
properties: {
|
|
5212
|
+
action_attempt_id: {
|
|
5213
|
+
description: 'ID of the action attempt.',
|
|
5214
|
+
format: 'uuid',
|
|
5215
|
+
type: 'string',
|
|
5216
|
+
},
|
|
5217
|
+
action_type: {
|
|
5218
|
+
enum: ['SIMULATE_KEYPAD_CODE_ENTRY'],
|
|
5219
|
+
type: 'string',
|
|
5220
|
+
},
|
|
5221
|
+
error: {
|
|
5222
|
+
description: 'Errors associated with the action attempt. Null for pending action attempts.',
|
|
5223
|
+
nullable: true,
|
|
5224
|
+
},
|
|
5225
|
+
result: {
|
|
5226
|
+
description: 'Result of the action attempt. Null for pending action attempts.',
|
|
5227
|
+
nullable: true,
|
|
5228
|
+
},
|
|
5229
|
+
status: { enum: ['pending'], type: 'string' },
|
|
5230
|
+
},
|
|
5231
|
+
required: [
|
|
5232
|
+
'action_attempt_id',
|
|
5233
|
+
'status',
|
|
5234
|
+
'result',
|
|
5235
|
+
'error',
|
|
5236
|
+
'action_type',
|
|
5237
|
+
],
|
|
5238
|
+
type: 'object',
|
|
5239
|
+
},
|
|
5240
|
+
{
|
|
5241
|
+
description: 'Simulating keypad code entry succeeded.',
|
|
5242
|
+
properties: {
|
|
5243
|
+
action_attempt_id: {
|
|
5244
|
+
description: 'ID of the action attempt.',
|
|
5245
|
+
format: 'uuid',
|
|
5246
|
+
type: 'string',
|
|
5247
|
+
},
|
|
5248
|
+
action_type: {
|
|
5249
|
+
enum: ['SIMULATE_KEYPAD_CODE_ENTRY'],
|
|
5250
|
+
type: 'string',
|
|
5251
|
+
},
|
|
5252
|
+
error: {
|
|
5253
|
+
description: 'Errors associated with the action attempt. Null for successful action attempts.',
|
|
5254
|
+
nullable: true,
|
|
5255
|
+
},
|
|
5256
|
+
result: { properties: {}, type: 'object' },
|
|
5257
|
+
status: { enum: ['success'], type: 'string' },
|
|
5258
|
+
},
|
|
5259
|
+
required: [
|
|
5260
|
+
'action_attempt_id',
|
|
5261
|
+
'status',
|
|
5262
|
+
'error',
|
|
5263
|
+
'action_type',
|
|
5264
|
+
'result',
|
|
5265
|
+
],
|
|
5266
|
+
type: 'object',
|
|
5267
|
+
},
|
|
5268
|
+
{
|
|
5269
|
+
description: 'Simulating keypad code entry failed.',
|
|
5270
|
+
properties: {
|
|
5271
|
+
action_attempt_id: {
|
|
5272
|
+
description: 'ID of the action attempt.',
|
|
5273
|
+
format: 'uuid',
|
|
5274
|
+
type: 'string',
|
|
5275
|
+
},
|
|
5276
|
+
action_type: {
|
|
5277
|
+
enum: ['SIMULATE_KEYPAD_CODE_ENTRY'],
|
|
5278
|
+
type: 'string',
|
|
5279
|
+
},
|
|
5280
|
+
error: {
|
|
5281
|
+
properties: {
|
|
5282
|
+
message: { type: 'string' },
|
|
5283
|
+
type: { type: 'string' },
|
|
5284
|
+
},
|
|
5285
|
+
required: ['type', 'message'],
|
|
5286
|
+
type: 'object',
|
|
5287
|
+
},
|
|
5288
|
+
result: {
|
|
5289
|
+
description: 'Result of the action attempt. Null for failed action attempts.',
|
|
5290
|
+
nullable: true,
|
|
5291
|
+
},
|
|
5292
|
+
status: { enum: ['error'], type: 'string' },
|
|
5293
|
+
},
|
|
5294
|
+
required: [
|
|
5295
|
+
'action_attempt_id',
|
|
5296
|
+
'status',
|
|
5297
|
+
'result',
|
|
5298
|
+
'action_type',
|
|
5299
|
+
'error',
|
|
5300
|
+
],
|
|
5301
|
+
type: 'object',
|
|
5302
|
+
},
|
|
5303
|
+
{
|
|
5304
|
+
description: 'Simulating manual lock via keypad.',
|
|
5305
|
+
properties: {
|
|
5306
|
+
action_attempt_id: {
|
|
5307
|
+
description: 'ID of the action attempt.',
|
|
5308
|
+
format: 'uuid',
|
|
5309
|
+
type: 'string',
|
|
5310
|
+
},
|
|
5311
|
+
action_type: {
|
|
5312
|
+
enum: ['SIMULATE_MANUAL_LOCK_VIA_KEYPAD'],
|
|
5313
|
+
type: 'string',
|
|
5314
|
+
},
|
|
5315
|
+
error: {
|
|
5316
|
+
description: 'Errors associated with the action attempt. Null for pending action attempts.',
|
|
5317
|
+
nullable: true,
|
|
5318
|
+
},
|
|
5319
|
+
result: {
|
|
5320
|
+
description: 'Result of the action attempt. Null for pending action attempts.',
|
|
5321
|
+
nullable: true,
|
|
5322
|
+
},
|
|
5323
|
+
status: { enum: ['pending'], type: 'string' },
|
|
5324
|
+
},
|
|
5325
|
+
required: [
|
|
5326
|
+
'action_attempt_id',
|
|
5327
|
+
'status',
|
|
5328
|
+
'result',
|
|
5329
|
+
'error',
|
|
5330
|
+
'action_type',
|
|
5331
|
+
],
|
|
5332
|
+
type: 'object',
|
|
5333
|
+
},
|
|
5334
|
+
{
|
|
5335
|
+
description: 'Simulating manual lock via keypad succeeded.',
|
|
5336
|
+
properties: {
|
|
5337
|
+
action_attempt_id: {
|
|
5338
|
+
description: 'ID of the action attempt.',
|
|
5339
|
+
format: 'uuid',
|
|
5340
|
+
type: 'string',
|
|
5341
|
+
},
|
|
5342
|
+
action_type: {
|
|
5343
|
+
enum: ['SIMULATE_MANUAL_LOCK_VIA_KEYPAD'],
|
|
5344
|
+
type: 'string',
|
|
5345
|
+
},
|
|
5346
|
+
error: {
|
|
5347
|
+
description: 'Errors associated with the action attempt. Null for successful action attempts.',
|
|
5348
|
+
nullable: true,
|
|
5349
|
+
},
|
|
5350
|
+
result: { properties: {}, type: 'object' },
|
|
5351
|
+
status: { enum: ['success'], type: 'string' },
|
|
5352
|
+
},
|
|
5353
|
+
required: [
|
|
5354
|
+
'action_attempt_id',
|
|
5355
|
+
'status',
|
|
5356
|
+
'error',
|
|
5357
|
+
'action_type',
|
|
5358
|
+
'result',
|
|
5359
|
+
],
|
|
5360
|
+
type: 'object',
|
|
5361
|
+
},
|
|
5362
|
+
{
|
|
5363
|
+
description: 'Simulating manual lock via keypad failed.',
|
|
5364
|
+
properties: {
|
|
5365
|
+
action_attempt_id: {
|
|
5366
|
+
description: 'ID of the action attempt.',
|
|
5367
|
+
format: 'uuid',
|
|
5368
|
+
type: 'string',
|
|
5369
|
+
},
|
|
5370
|
+
action_type: {
|
|
5371
|
+
enum: ['SIMULATE_MANUAL_LOCK_VIA_KEYPAD'],
|
|
5372
|
+
type: 'string',
|
|
5373
|
+
},
|
|
5374
|
+
error: {
|
|
5375
|
+
properties: {
|
|
5376
|
+
message: { type: 'string' },
|
|
5377
|
+
type: { type: 'string' },
|
|
5378
|
+
},
|
|
5379
|
+
required: ['type', 'message'],
|
|
5380
|
+
type: 'object',
|
|
5381
|
+
},
|
|
5382
|
+
result: {
|
|
5383
|
+
description: 'Result of the action attempt. Null for failed action attempts.',
|
|
5384
|
+
nullable: true,
|
|
5385
|
+
},
|
|
5386
|
+
status: { enum: ['error'], type: 'string' },
|
|
5387
|
+
},
|
|
5388
|
+
required: [
|
|
5389
|
+
'action_attempt_id',
|
|
5390
|
+
'status',
|
|
5391
|
+
'result',
|
|
5392
|
+
'action_type',
|
|
5393
|
+
'error',
|
|
5394
|
+
],
|
|
5395
|
+
type: 'object',
|
|
5396
|
+
},
|
|
5209
5397
|
{
|
|
5210
5398
|
properties: {
|
|
5211
5399
|
action_attempt_id: {
|
|
@@ -22898,98 +23086,6 @@ export default {
|
|
|
22898
23086
|
'x-response-key': 'device_providers',
|
|
22899
23087
|
},
|
|
22900
23088
|
},
|
|
22901
|
-
'/devices/simulate/access_code_lock': {
|
|
22902
|
-
post: {
|
|
22903
|
-
operationId: 'devicesSimulateAccessCodeLockPost',
|
|
22904
|
-
requestBody: {
|
|
22905
|
-
content: {
|
|
22906
|
-
'application/json': {
|
|
22907
|
-
schema: {
|
|
22908
|
-
properties: {
|
|
22909
|
-
access_code_id: { format: 'uuid', type: 'string' },
|
|
22910
|
-
device_id: { format: 'uuid', type: 'string' },
|
|
22911
|
-
},
|
|
22912
|
-
required: ['device_id', 'access_code_id'],
|
|
22913
|
-
type: 'object',
|
|
22914
|
-
},
|
|
22915
|
-
},
|
|
22916
|
-
},
|
|
22917
|
-
},
|
|
22918
|
-
responses: {
|
|
22919
|
-
200: {
|
|
22920
|
-
content: {
|
|
22921
|
-
'application/json': {
|
|
22922
|
-
schema: {
|
|
22923
|
-
properties: { ok: { type: 'boolean' } },
|
|
22924
|
-
required: ['ok'],
|
|
22925
|
-
type: 'object',
|
|
22926
|
-
},
|
|
22927
|
-
},
|
|
22928
|
-
},
|
|
22929
|
-
description: 'OK',
|
|
22930
|
-
},
|
|
22931
|
-
400: { description: 'Bad Request' },
|
|
22932
|
-
401: { description: 'Unauthorized' },
|
|
22933
|
-
},
|
|
22934
|
-
security: [
|
|
22935
|
-
{ api_key: [] },
|
|
22936
|
-
{ pat_with_workspace: [] },
|
|
22937
|
-
{ console_session_with_workspace: [] },
|
|
22938
|
-
],
|
|
22939
|
-
summary: '/devices/simulate/access_code_lock',
|
|
22940
|
-
tags: ['/devices'],
|
|
22941
|
-
'x-fern-sdk-group-name': ['devices', 'simulate'],
|
|
22942
|
-
'x-fern-sdk-method-name': 'access_code_lock',
|
|
22943
|
-
'x-response-key': null,
|
|
22944
|
-
'x-undocumented': 'Unreleased.',
|
|
22945
|
-
},
|
|
22946
|
-
},
|
|
22947
|
-
'/devices/simulate/access_code_unlock': {
|
|
22948
|
-
post: {
|
|
22949
|
-
operationId: 'devicesSimulateAccessCodeUnlockPost',
|
|
22950
|
-
requestBody: {
|
|
22951
|
-
content: {
|
|
22952
|
-
'application/json': {
|
|
22953
|
-
schema: {
|
|
22954
|
-
properties: {
|
|
22955
|
-
access_code_id: { format: 'uuid', type: 'string' },
|
|
22956
|
-
device_id: { format: 'uuid', type: 'string' },
|
|
22957
|
-
},
|
|
22958
|
-
required: ['device_id', 'access_code_id'],
|
|
22959
|
-
type: 'object',
|
|
22960
|
-
},
|
|
22961
|
-
},
|
|
22962
|
-
},
|
|
22963
|
-
},
|
|
22964
|
-
responses: {
|
|
22965
|
-
200: {
|
|
22966
|
-
content: {
|
|
22967
|
-
'application/json': {
|
|
22968
|
-
schema: {
|
|
22969
|
-
properties: { ok: { type: 'boolean' } },
|
|
22970
|
-
required: ['ok'],
|
|
22971
|
-
type: 'object',
|
|
22972
|
-
},
|
|
22973
|
-
},
|
|
22974
|
-
},
|
|
22975
|
-
description: 'OK',
|
|
22976
|
-
},
|
|
22977
|
-
400: { description: 'Bad Request' },
|
|
22978
|
-
401: { description: 'Unauthorized' },
|
|
22979
|
-
},
|
|
22980
|
-
security: [
|
|
22981
|
-
{ api_key: [] },
|
|
22982
|
-
{ pat_with_workspace: [] },
|
|
22983
|
-
{ console_session_with_workspace: [] },
|
|
22984
|
-
],
|
|
22985
|
-
summary: '/devices/simulate/access_code_unlock',
|
|
22986
|
-
tags: ['/devices'],
|
|
22987
|
-
'x-fern-sdk-group-name': ['devices', 'simulate'],
|
|
22988
|
-
'x-fern-sdk-method-name': 'access_code_unlock',
|
|
22989
|
-
'x-response-key': null,
|
|
22990
|
-
'x-undocumented': 'Unreleased.',
|
|
22991
|
-
},
|
|
22992
|
-
},
|
|
22993
23089
|
'/devices/simulate/connect': {
|
|
22994
23090
|
post: {
|
|
22995
23091
|
operationId: 'devicesSimulateConnectPost',
|
|
@@ -24323,6 +24419,108 @@ export default {
|
|
|
24323
24419
|
'x-response-key': 'action_attempt',
|
|
24324
24420
|
},
|
|
24325
24421
|
},
|
|
24422
|
+
'/locks/simulate/keypad_code_entry': {
|
|
24423
|
+
post: {
|
|
24424
|
+
operationId: 'locksSimulateKeypadCodeEntryPost',
|
|
24425
|
+
requestBody: {
|
|
24426
|
+
content: {
|
|
24427
|
+
'application/json': {
|
|
24428
|
+
schema: {
|
|
24429
|
+
properties: {
|
|
24430
|
+
code: { type: 'string' },
|
|
24431
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
24432
|
+
},
|
|
24433
|
+
required: ['device_id', 'code'],
|
|
24434
|
+
type: 'object',
|
|
24435
|
+
},
|
|
24436
|
+
},
|
|
24437
|
+
},
|
|
24438
|
+
},
|
|
24439
|
+
responses: {
|
|
24440
|
+
200: {
|
|
24441
|
+
content: {
|
|
24442
|
+
'application/json': {
|
|
24443
|
+
schema: {
|
|
24444
|
+
properties: {
|
|
24445
|
+
action_attempt: {
|
|
24446
|
+
$ref: '#/components/schemas/access_code',
|
|
24447
|
+
},
|
|
24448
|
+
ok: { type: 'boolean' },
|
|
24449
|
+
},
|
|
24450
|
+
required: ['ok'],
|
|
24451
|
+
type: 'object',
|
|
24452
|
+
},
|
|
24453
|
+
},
|
|
24454
|
+
},
|
|
24455
|
+
description: 'OK',
|
|
24456
|
+
},
|
|
24457
|
+
400: { description: 'Bad Request' },
|
|
24458
|
+
401: { description: 'Unauthorized' },
|
|
24459
|
+
},
|
|
24460
|
+
security: [
|
|
24461
|
+
{ api_key: [] },
|
|
24462
|
+
{ pat_with_workspace: [] },
|
|
24463
|
+
{ console_session_with_workspace: [] },
|
|
24464
|
+
],
|
|
24465
|
+
summary: '/locks/simulate/keypad_code_entry',
|
|
24466
|
+
tags: ['/locks'],
|
|
24467
|
+
'x-action-attempt-type': 'SIMULATE_KEYPAD_CODE_ENTRY',
|
|
24468
|
+
'x-fern-sdk-group-name': ['locks', 'simulate'],
|
|
24469
|
+
'x-fern-sdk-method-name': 'keypad_code_entry',
|
|
24470
|
+
'x-fern-sdk-return-value': 'action_attempt',
|
|
24471
|
+
'x-response-key': 'action_attempt',
|
|
24472
|
+
'x-undocumented': 'Unreleased.',
|
|
24473
|
+
},
|
|
24474
|
+
},
|
|
24475
|
+
'/locks/simulate/manual_lock_via_keypad': {
|
|
24476
|
+
post: {
|
|
24477
|
+
operationId: 'locksSimulateManualLockViaKeypadPost',
|
|
24478
|
+
requestBody: {
|
|
24479
|
+
content: {
|
|
24480
|
+
'application/json': {
|
|
24481
|
+
schema: {
|
|
24482
|
+
properties: { device_id: { format: 'uuid', type: 'string' } },
|
|
24483
|
+
required: ['device_id'],
|
|
24484
|
+
type: 'object',
|
|
24485
|
+
},
|
|
24486
|
+
},
|
|
24487
|
+
},
|
|
24488
|
+
},
|
|
24489
|
+
responses: {
|
|
24490
|
+
200: {
|
|
24491
|
+
content: {
|
|
24492
|
+
'application/json': {
|
|
24493
|
+
schema: {
|
|
24494
|
+
properties: {
|
|
24495
|
+
action_attempt: {
|
|
24496
|
+
$ref: '#/components/schemas/access_code',
|
|
24497
|
+
},
|
|
24498
|
+
ok: { type: 'boolean' },
|
|
24499
|
+
},
|
|
24500
|
+
required: ['ok'],
|
|
24501
|
+
type: 'object',
|
|
24502
|
+
},
|
|
24503
|
+
},
|
|
24504
|
+
},
|
|
24505
|
+
description: 'OK',
|
|
24506
|
+
},
|
|
24507
|
+
400: { description: 'Bad Request' },
|
|
24508
|
+
401: { description: 'Unauthorized' },
|
|
24509
|
+
},
|
|
24510
|
+
security: [
|
|
24511
|
+
{ api_key: [] },
|
|
24512
|
+
{ pat_with_workspace: [] },
|
|
24513
|
+
{ console_session_with_workspace: [] },
|
|
24514
|
+
],
|
|
24515
|
+
summary: '/locks/simulate/manual_lock_via_keypad',
|
|
24516
|
+
tags: ['/locks'],
|
|
24517
|
+
'x-action-attempt-type': 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD',
|
|
24518
|
+
'x-fern-sdk-group-name': ['locks', 'simulate'],
|
|
24519
|
+
'x-fern-sdk-method-name': 'manual_lock_via_keypad',
|
|
24520
|
+
'x-response-key': null,
|
|
24521
|
+
'x-undocumented': 'Unreleased.',
|
|
24522
|
+
},
|
|
24523
|
+
},
|
|
24326
24524
|
'/locks/unlock_door': {
|
|
24327
24525
|
post: {
|
|
24328
24526
|
operationId: 'locksUnlockDoorPost',
|
|
@@ -26391,6 +26589,62 @@ export default {
|
|
|
26391
26589
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
26392
26590
|
},
|
|
26393
26591
|
},
|
|
26592
|
+
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
26593
|
+
post: {
|
|
26594
|
+
description: 'Exchanges a short code for a Client Session Token (CST).\nThis endpoint is used by mobile apps to securely retrieve a client session token \nusing a short code obtained from an instant key URL.',
|
|
26595
|
+
operationId: 'seamInstantKeyV1ClientSessionsExchangeShortCodePost',
|
|
26596
|
+
requestBody: {
|
|
26597
|
+
content: {
|
|
26598
|
+
'application/json': {
|
|
26599
|
+
schema: {
|
|
26600
|
+
properties: {
|
|
26601
|
+
short_code: {
|
|
26602
|
+
description: 'The short code to exchange for a client session token',
|
|
26603
|
+
type: 'string',
|
|
26604
|
+
},
|
|
26605
|
+
},
|
|
26606
|
+
required: ['short_code'],
|
|
26607
|
+
type: 'object',
|
|
26608
|
+
},
|
|
26609
|
+
},
|
|
26610
|
+
},
|
|
26611
|
+
},
|
|
26612
|
+
responses: {
|
|
26613
|
+
200: {
|
|
26614
|
+
content: {
|
|
26615
|
+
'application/json': {
|
|
26616
|
+
schema: {
|
|
26617
|
+
properties: {
|
|
26618
|
+
client_session: {
|
|
26619
|
+
$ref: '#/components/schemas/client_session',
|
|
26620
|
+
},
|
|
26621
|
+
ok: { type: 'boolean' },
|
|
26622
|
+
},
|
|
26623
|
+
required: ['client_session', 'ok'],
|
|
26624
|
+
type: 'object',
|
|
26625
|
+
},
|
|
26626
|
+
},
|
|
26627
|
+
},
|
|
26628
|
+
description: 'OK',
|
|
26629
|
+
},
|
|
26630
|
+
400: { description: 'Bad Request' },
|
|
26631
|
+
401: { description: 'Unauthorized' },
|
|
26632
|
+
},
|
|
26633
|
+
security: [{ certified_client: [] }],
|
|
26634
|
+
summary: '/seam/instant_key/v1/client_sessions/exchange_short_code',
|
|
26635
|
+
tags: ['/client_sessions'],
|
|
26636
|
+
'x-fern-sdk-group-name': [
|
|
26637
|
+
'seam',
|
|
26638
|
+
'instant_key',
|
|
26639
|
+
'v1',
|
|
26640
|
+
'client_sessions',
|
|
26641
|
+
],
|
|
26642
|
+
'x-fern-sdk-method-name': 'exchange_short_code',
|
|
26643
|
+
'x-fern-sdk-return-value': 'client_session',
|
|
26644
|
+
'x-response-key': 'client_session',
|
|
26645
|
+
'x-title': 'Exchange Instant Key Short Code',
|
|
26646
|
+
},
|
|
26647
|
+
},
|
|
26394
26648
|
'/thermostats/activate_climate_preset': {
|
|
26395
26649
|
post: {
|
|
26396
26650
|
description: 'Activates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
|
|
@@ -28424,20 +28678,6 @@ export default {
|
|
|
28424
28678
|
},
|
|
28425
28679
|
{
|
|
28426
28680
|
properties: {
|
|
28427
|
-
desired_access_methods: {
|
|
28428
|
-
items: {
|
|
28429
|
-
properties: {
|
|
28430
|
-
mode: {
|
|
28431
|
-
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
28432
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
28433
|
-
type: 'string',
|
|
28434
|
-
},
|
|
28435
|
-
},
|
|
28436
|
-
required: ['mode'],
|
|
28437
|
-
type: 'object',
|
|
28438
|
-
},
|
|
28439
|
-
type: 'array',
|
|
28440
|
-
},
|
|
28441
28681
|
ends_at: {
|
|
28442
28682
|
description: 'Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
28443
28683
|
format: 'date-time',
|
|
@@ -28458,6 +28698,10 @@ export default {
|
|
|
28458
28698
|
items: { format: 'uuid', type: 'string' },
|
|
28459
28699
|
type: 'array',
|
|
28460
28700
|
},
|
|
28701
|
+
name: {
|
|
28702
|
+
description: 'Name of the location.',
|
|
28703
|
+
type: 'string',
|
|
28704
|
+
},
|
|
28461
28705
|
},
|
|
28462
28706
|
type: 'object',
|
|
28463
28707
|
},
|
|
@@ -28466,13 +28710,27 @@ export default {
|
|
|
28466
28710
|
items: { format: 'uuid', type: 'string' },
|
|
28467
28711
|
type: 'array',
|
|
28468
28712
|
},
|
|
28713
|
+
requested_access_methods: {
|
|
28714
|
+
items: {
|
|
28715
|
+
properties: {
|
|
28716
|
+
mode: {
|
|
28717
|
+
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
28718
|
+
enum: ['code', 'card', 'mobile_key'],
|
|
28719
|
+
type: 'string',
|
|
28720
|
+
},
|
|
28721
|
+
},
|
|
28722
|
+
required: ['mode'],
|
|
28723
|
+
type: 'object',
|
|
28724
|
+
},
|
|
28725
|
+
type: 'array',
|
|
28726
|
+
},
|
|
28469
28727
|
starts_at: {
|
|
28470
28728
|
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.',
|
|
28471
28729
|
format: 'date-time',
|
|
28472
28730
|
type: 'string',
|
|
28473
28731
|
},
|
|
28474
28732
|
},
|
|
28475
|
-
required: ['
|
|
28733
|
+
required: ['requested_access_methods'],
|
|
28476
28734
|
type: 'object',
|
|
28477
28735
|
},
|
|
28478
28736
|
],
|
|
@@ -28493,6 +28751,11 @@ export default {
|
|
|
28493
28751
|
format: 'uuid',
|
|
28494
28752
|
type: 'string',
|
|
28495
28753
|
},
|
|
28754
|
+
access_method_ids: {
|
|
28755
|
+
description: 'IDs of the access methods that were created for this access grant.',
|
|
28756
|
+
items: { format: 'uuid', type: 'string' },
|
|
28757
|
+
type: 'array',
|
|
28758
|
+
},
|
|
28496
28759
|
created_at: {
|
|
28497
28760
|
description: 'Date and time at which the access grant was created.',
|
|
28498
28761
|
format: 'date-time',
|
|
@@ -28511,6 +28774,11 @@ export default {
|
|
|
28511
28774
|
description: 'Access methods that the user requested for this access grant.',
|
|
28512
28775
|
items: {
|
|
28513
28776
|
properties: {
|
|
28777
|
+
created_access_method_ids: {
|
|
28778
|
+
description: 'IDs of the access methods that were created for this requested access method.',
|
|
28779
|
+
items: { format: 'uuid', type: 'string' },
|
|
28780
|
+
type: 'array',
|
|
28781
|
+
},
|
|
28514
28782
|
created_at: {
|
|
28515
28783
|
description: 'Date and time at which the requested access method was added to this access grant.',
|
|
28516
28784
|
format: 'date-time',
|
|
@@ -28525,17 +28793,12 @@ export default {
|
|
|
28525
28793
|
enum: ['code', 'card', 'mobile_key'],
|
|
28526
28794
|
type: 'string',
|
|
28527
28795
|
},
|
|
28528
|
-
provisioned_access_method_ids: {
|
|
28529
|
-
description: 'IDs of the locations to which access is being given.',
|
|
28530
|
-
items: { format: 'uuid', type: 'string' },
|
|
28531
|
-
type: 'array',
|
|
28532
|
-
},
|
|
28533
28796
|
},
|
|
28534
28797
|
required: [
|
|
28535
28798
|
'display_name',
|
|
28536
28799
|
'mode',
|
|
28537
28800
|
'created_at',
|
|
28538
|
-
'
|
|
28801
|
+
'created_access_method_ids',
|
|
28539
28802
|
],
|
|
28540
28803
|
type: 'object',
|
|
28541
28804
|
'x-undocumented': 'Unreleased.',
|
|
@@ -28559,6 +28822,7 @@ export default {
|
|
|
28559
28822
|
'user_identity_id',
|
|
28560
28823
|
'location_ids',
|
|
28561
28824
|
'requested_access_methods',
|
|
28825
|
+
'access_method_ids',
|
|
28562
28826
|
'display_name',
|
|
28563
28827
|
'created_at',
|
|
28564
28828
|
],
|
|
@@ -28626,6 +28890,11 @@ export default {
|
|
|
28626
28890
|
format: 'uuid',
|
|
28627
28891
|
type: 'string',
|
|
28628
28892
|
},
|
|
28893
|
+
access_method_ids: {
|
|
28894
|
+
description: 'IDs of the access methods that were created for this access grant.',
|
|
28895
|
+
items: { format: 'uuid', type: 'string' },
|
|
28896
|
+
type: 'array',
|
|
28897
|
+
},
|
|
28629
28898
|
created_at: {
|
|
28630
28899
|
description: 'Date and time at which the access grant was created.',
|
|
28631
28900
|
format: 'date-time',
|
|
@@ -28644,6 +28913,11 @@ export default {
|
|
|
28644
28913
|
description: 'Access methods that the user requested for this access grant.',
|
|
28645
28914
|
items: {
|
|
28646
28915
|
properties: {
|
|
28916
|
+
created_access_method_ids: {
|
|
28917
|
+
description: 'IDs of the access methods that were created for this requested access method.',
|
|
28918
|
+
items: { format: 'uuid', type: 'string' },
|
|
28919
|
+
type: 'array',
|
|
28920
|
+
},
|
|
28647
28921
|
created_at: {
|
|
28648
28922
|
description: 'Date and time at which the requested access method was added to this access grant.',
|
|
28649
28923
|
format: 'date-time',
|
|
@@ -28658,17 +28932,12 @@ export default {
|
|
|
28658
28932
|
enum: ['code', 'card', 'mobile_key'],
|
|
28659
28933
|
type: 'string',
|
|
28660
28934
|
},
|
|
28661
|
-
provisioned_access_method_ids: {
|
|
28662
|
-
description: 'IDs of the locations to which access is being given.',
|
|
28663
|
-
items: { format: 'uuid', type: 'string' },
|
|
28664
|
-
type: 'array',
|
|
28665
|
-
},
|
|
28666
28935
|
},
|
|
28667
28936
|
required: [
|
|
28668
28937
|
'display_name',
|
|
28669
28938
|
'mode',
|
|
28670
28939
|
'created_at',
|
|
28671
|
-
'
|
|
28940
|
+
'created_access_method_ids',
|
|
28672
28941
|
],
|
|
28673
28942
|
type: 'object',
|
|
28674
28943
|
'x-undocumented': 'Unreleased.',
|
|
@@ -28692,6 +28961,7 @@ export default {
|
|
|
28692
28961
|
'user_identity_id',
|
|
28693
28962
|
'location_ids',
|
|
28694
28963
|
'requested_access_methods',
|
|
28964
|
+
'access_method_ids',
|
|
28695
28965
|
'display_name',
|
|
28696
28966
|
'created_at',
|
|
28697
28967
|
],
|
|
@@ -28774,6 +29044,11 @@ export default {
|
|
|
28774
29044
|
format: 'uuid',
|
|
28775
29045
|
type: 'string',
|
|
28776
29046
|
},
|
|
29047
|
+
access_method_ids: {
|
|
29048
|
+
description: 'IDs of the access methods that were created for this access grant.',
|
|
29049
|
+
items: { format: 'uuid', type: 'string' },
|
|
29050
|
+
type: 'array',
|
|
29051
|
+
},
|
|
28777
29052
|
created_at: {
|
|
28778
29053
|
description: 'Date and time at which the access grant was created.',
|
|
28779
29054
|
format: 'date-time',
|
|
@@ -28792,6 +29067,11 @@ export default {
|
|
|
28792
29067
|
description: 'Access methods that the user requested for this access grant.',
|
|
28793
29068
|
items: {
|
|
28794
29069
|
properties: {
|
|
29070
|
+
created_access_method_ids: {
|
|
29071
|
+
description: 'IDs of the access methods that were created for this requested access method.',
|
|
29072
|
+
items: { format: 'uuid', type: 'string' },
|
|
29073
|
+
type: 'array',
|
|
29074
|
+
},
|
|
28795
29075
|
created_at: {
|
|
28796
29076
|
description: 'Date and time at which the requested access method was added to this access grant.',
|
|
28797
29077
|
format: 'date-time',
|
|
@@ -28806,17 +29086,12 @@ export default {
|
|
|
28806
29086
|
enum: ['code', 'card', 'mobile_key'],
|
|
28807
29087
|
type: 'string',
|
|
28808
29088
|
},
|
|
28809
|
-
provisioned_access_method_ids: {
|
|
28810
|
-
description: 'IDs of the locations to which access is being given.',
|
|
28811
|
-
items: { format: 'uuid', type: 'string' },
|
|
28812
|
-
type: 'array',
|
|
28813
|
-
},
|
|
28814
29089
|
},
|
|
28815
29090
|
required: [
|
|
28816
29091
|
'display_name',
|
|
28817
29092
|
'mode',
|
|
28818
29093
|
'created_at',
|
|
28819
|
-
'
|
|
29094
|
+
'created_access_method_ids',
|
|
28820
29095
|
],
|
|
28821
29096
|
type: 'object',
|
|
28822
29097
|
'x-undocumented': 'Unreleased.',
|
|
@@ -28840,6 +29115,7 @@ export default {
|
|
|
28840
29115
|
'user_identity_id',
|
|
28841
29116
|
'location_ids',
|
|
28842
29117
|
'requested_access_methods',
|
|
29118
|
+
'access_method_ids',
|
|
28843
29119
|
'display_name',
|
|
28844
29120
|
'created_at',
|
|
28845
29121
|
],
|
|
@@ -28875,10 +29151,10 @@ export default {
|
|
|
28875
29151
|
'x-undocumented': 'Unreleased.',
|
|
28876
29152
|
},
|
|
28877
29153
|
},
|
|
28878
|
-
'/
|
|
29154
|
+
'/unstable_access_methods/list': {
|
|
28879
29155
|
post: {
|
|
28880
|
-
description: 'List all access methods
|
|
28881
|
-
operationId: '
|
|
29156
|
+
description: 'List all access methods, usually filtered by access grant.',
|
|
29157
|
+
operationId: 'unstableAccessMethodsListPost',
|
|
28882
29158
|
requestBody: {
|
|
28883
29159
|
content: {
|
|
28884
29160
|
'application/json': {
|
|
@@ -28966,13 +29242,13 @@ export default {
|
|
|
28966
29242
|
{ console_session_with_workspace: [] },
|
|
28967
29243
|
{ api_key: [] },
|
|
28968
29244
|
],
|
|
28969
|
-
summary: '/
|
|
29245
|
+
summary: '/unstable_access_methods/list',
|
|
28970
29246
|
tags: [],
|
|
28971
|
-
'x-fern-sdk-group-name': ['
|
|
28972
|
-
'x-fern-sdk-method-name': '
|
|
29247
|
+
'x-fern-sdk-group-name': ['unstable_access_methods'],
|
|
29248
|
+
'x-fern-sdk-method-name': 'list',
|
|
28973
29249
|
'x-fern-sdk-return-value': 'access_methods',
|
|
28974
29250
|
'x-response-key': 'access_methods',
|
|
28975
|
-
'x-title': '
|
|
29251
|
+
'x-title': 'List Access Methods',
|
|
28976
29252
|
'x-undocumented': 'Unreleased.',
|
|
28977
29253
|
},
|
|
28978
29254
|
},
|