@seamapi/types 1.344.2 → 1.345.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 +157 -30
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +242 -1
- package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +26 -0
- package/lib/seam/connect/models/access-codes/managed-access-code.js +8 -0
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +16 -0
- package/lib/seam/connect/models/devices/phone-properties.js +18 -8
- package/lib/seam/connect/models/devices/phone-properties.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.js +4 -1
- package/lib/seam/connect/models/devices/phone.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +39 -0
- package/lib/seam/connect/openapi.js +139 -20
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +161 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +9 -0
- package/src/lib/seam/connect/models/devices/phone-properties.ts +24 -10
- package/src/lib/seam/connect/models/devices/phone.ts +4 -1
- package/src/lib/seam/connect/openapi.ts +174 -20
- package/src/lib/seam/connect/route-types.ts +170 -1
|
@@ -627,6 +627,19 @@ export default {
|
|
|
627
627
|
required: ['message', 'warning_code'],
|
|
628
628
|
type: 'object',
|
|
629
629
|
},
|
|
630
|
+
{
|
|
631
|
+
description: 'Lock is in Office Mode. Access Codes will not unlock doors.',
|
|
632
|
+
properties: {
|
|
633
|
+
message: { type: 'string' },
|
|
634
|
+
warning_code: {
|
|
635
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
636
|
+
enum: ['salto_office_mode'],
|
|
637
|
+
type: 'string',
|
|
638
|
+
},
|
|
639
|
+
},
|
|
640
|
+
required: ['message', 'warning_code'],
|
|
641
|
+
type: 'object',
|
|
642
|
+
},
|
|
630
643
|
{
|
|
631
644
|
description: 'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
632
645
|
properties: {
|
|
@@ -5455,26 +5468,41 @@ export default {
|
|
|
5455
5468
|
{
|
|
5456
5469
|
properties: {
|
|
5457
5470
|
assa_abloy_credential_service_metadata: {
|
|
5471
|
+
description: 'ASSA ABLOY Credential Service metadata for the phone.',
|
|
5458
5472
|
properties: {
|
|
5459
5473
|
endpoints: {
|
|
5474
|
+
description: 'Endpoints associated with the phone.',
|
|
5460
5475
|
items: {
|
|
5461
5476
|
properties: {
|
|
5462
|
-
endpoint_id: {
|
|
5463
|
-
|
|
5477
|
+
endpoint_id: {
|
|
5478
|
+
description: 'ID of the associated endpoint.',
|
|
5479
|
+
type: 'string',
|
|
5480
|
+
},
|
|
5481
|
+
is_active: {
|
|
5482
|
+
description: 'Indicated whether the endpoint is active.',
|
|
5483
|
+
type: 'boolean',
|
|
5484
|
+
},
|
|
5464
5485
|
},
|
|
5465
5486
|
required: ['endpoint_id', 'is_active'],
|
|
5466
5487
|
type: 'object',
|
|
5467
5488
|
},
|
|
5468
5489
|
type: 'array',
|
|
5469
5490
|
},
|
|
5470
|
-
has_active_endpoint: {
|
|
5491
|
+
has_active_endpoint: {
|
|
5492
|
+
description: 'Indicates whether the credential service has active endpoints associated with the phone.',
|
|
5493
|
+
type: 'boolean',
|
|
5494
|
+
},
|
|
5471
5495
|
},
|
|
5472
5496
|
required: ['has_active_endpoint', 'endpoints'],
|
|
5473
5497
|
type: 'object',
|
|
5474
5498
|
},
|
|
5475
5499
|
salto_space_credential_service_metadata: {
|
|
5500
|
+
description: 'Salto Space credential service metadata for the phone.',
|
|
5476
5501
|
properties: {
|
|
5477
|
-
has_active_phone: {
|
|
5502
|
+
has_active_phone: {
|
|
5503
|
+
description: 'Indicates whether the credential service has an active associated phone.',
|
|
5504
|
+
type: 'boolean',
|
|
5505
|
+
},
|
|
5478
5506
|
},
|
|
5479
5507
|
required: ['has_active_phone'],
|
|
5480
5508
|
type: 'object',
|
|
@@ -10926,6 +10954,7 @@ export default {
|
|
|
10926
10954
|
'x-route-path': '/noise_sensors/noise_thresholds',
|
|
10927
10955
|
},
|
|
10928
10956
|
phone: {
|
|
10957
|
+
description: 'Properties of the phone.',
|
|
10929
10958
|
properties: {
|
|
10930
10959
|
can_hvac_cool: { type: 'boolean' },
|
|
10931
10960
|
can_hvac_heat: { type: 'boolean' },
|
|
@@ -10969,7 +10998,11 @@ export default {
|
|
|
10969
10998
|
format: 'uuid',
|
|
10970
10999
|
type: 'string',
|
|
10971
11000
|
},
|
|
10972
|
-
device_type: {
|
|
11001
|
+
device_type: {
|
|
11002
|
+
description: 'Type of phone.',
|
|
11003
|
+
enum: ['android_phone', 'ios_phone'],
|
|
11004
|
+
type: 'string',
|
|
11005
|
+
},
|
|
10973
11006
|
display_name: {
|
|
10974
11007
|
description: 'Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
|
|
10975
11008
|
type: 'string',
|
|
@@ -11220,25 +11253,42 @@ export default {
|
|
|
11220
11253
|
properties: {
|
|
11221
11254
|
properties: {
|
|
11222
11255
|
assa_abloy_credential_service_metadata: {
|
|
11256
|
+
description: 'ASSA ABLOY Credential Service metadata for the phone.',
|
|
11223
11257
|
properties: {
|
|
11224
11258
|
endpoints: {
|
|
11259
|
+
description: 'Endpoints associated with the phone.',
|
|
11225
11260
|
items: {
|
|
11226
11261
|
properties: {
|
|
11227
|
-
endpoint_id: {
|
|
11228
|
-
|
|
11262
|
+
endpoint_id: {
|
|
11263
|
+
description: 'ID of the associated endpoint.',
|
|
11264
|
+
type: 'string',
|
|
11265
|
+
},
|
|
11266
|
+
is_active: {
|
|
11267
|
+
description: 'Indicated whether the endpoint is active.',
|
|
11268
|
+
type: 'boolean',
|
|
11269
|
+
},
|
|
11229
11270
|
},
|
|
11230
11271
|
required: ['endpoint_id', 'is_active'],
|
|
11231
11272
|
type: 'object',
|
|
11232
11273
|
},
|
|
11233
11274
|
type: 'array',
|
|
11234
11275
|
},
|
|
11235
|
-
has_active_endpoint: {
|
|
11276
|
+
has_active_endpoint: {
|
|
11277
|
+
description: 'Indicates whether the credential service has active endpoints associated with the phone.',
|
|
11278
|
+
type: 'boolean',
|
|
11279
|
+
},
|
|
11236
11280
|
},
|
|
11237
11281
|
required: ['has_active_endpoint', 'endpoints'],
|
|
11238
11282
|
type: 'object',
|
|
11239
11283
|
},
|
|
11240
11284
|
salto_space_credential_service_metadata: {
|
|
11241
|
-
|
|
11285
|
+
description: 'Salto Space credential service metadata for the phone.',
|
|
11286
|
+
properties: {
|
|
11287
|
+
has_active_phone: {
|
|
11288
|
+
description: 'Indicates whether the credential service has an active associated phone.',
|
|
11289
|
+
type: 'boolean',
|
|
11290
|
+
},
|
|
11291
|
+
},
|
|
11242
11292
|
required: ['has_active_phone'],
|
|
11243
11293
|
type: 'object',
|
|
11244
11294
|
},
|
|
@@ -12146,6 +12196,19 @@ export default {
|
|
|
12146
12196
|
required: ['message', 'warning_code'],
|
|
12147
12197
|
type: 'object',
|
|
12148
12198
|
},
|
|
12199
|
+
{
|
|
12200
|
+
description: 'Lock is in Office Mode. Access Codes will not unlock doors.',
|
|
12201
|
+
properties: {
|
|
12202
|
+
message: { type: 'string' },
|
|
12203
|
+
warning_code: {
|
|
12204
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
12205
|
+
enum: ['salto_office_mode'],
|
|
12206
|
+
type: 'string',
|
|
12207
|
+
},
|
|
12208
|
+
},
|
|
12209
|
+
required: ['message', 'warning_code'],
|
|
12210
|
+
type: 'object',
|
|
12211
|
+
},
|
|
12149
12212
|
{
|
|
12150
12213
|
description: 'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
12151
12214
|
properties: {
|
|
@@ -22265,12 +22328,18 @@ export default {
|
|
|
22265
22328
|
},
|
|
22266
22329
|
'/phones/deactivate': {
|
|
22267
22330
|
post: {
|
|
22331
|
+
description: 'Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://docs.seam.co/latest/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process).',
|
|
22268
22332
|
operationId: 'phonesDeactivatePost',
|
|
22269
22333
|
requestBody: {
|
|
22270
22334
|
content: {
|
|
22271
22335
|
'application/json': {
|
|
22272
22336
|
schema: {
|
|
22273
|
-
properties: {
|
|
22337
|
+
properties: {
|
|
22338
|
+
device_id: {
|
|
22339
|
+
description: 'Device ID of the desired phone.',
|
|
22340
|
+
type: 'string',
|
|
22341
|
+
},
|
|
22342
|
+
},
|
|
22274
22343
|
required: ['device_id'],
|
|
22275
22344
|
type: 'object',
|
|
22276
22345
|
},
|
|
@@ -22304,18 +22373,28 @@ export default {
|
|
|
22304
22373
|
'x-fern-sdk-group-name': ['phones'],
|
|
22305
22374
|
'x-fern-sdk-method-name': 'deactivate',
|
|
22306
22375
|
'x-response-key': null,
|
|
22376
|
+
'x-title': 'Deactivate a Phone',
|
|
22307
22377
|
},
|
|
22308
22378
|
},
|
|
22309
22379
|
'/phones/list': {
|
|
22310
22380
|
post: {
|
|
22381
|
+
description: 'Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.',
|
|
22311
22382
|
operationId: 'phonesListPost',
|
|
22312
22383
|
requestBody: {
|
|
22313
22384
|
content: {
|
|
22314
22385
|
'application/json': {
|
|
22315
22386
|
schema: {
|
|
22316
22387
|
properties: {
|
|
22317
|
-
acs_credential_id: {
|
|
22318
|
-
|
|
22388
|
+
acs_credential_id: {
|
|
22389
|
+
description: 'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which to filter the list of returned phones.',
|
|
22390
|
+
format: 'uuid',
|
|
22391
|
+
type: 'string',
|
|
22392
|
+
},
|
|
22393
|
+
owner_user_identity_id: {
|
|
22394
|
+
description: 'ID of the user identity that represents the owner by which to filter the list of returned phones.',
|
|
22395
|
+
format: 'uuid',
|
|
22396
|
+
type: 'string',
|
|
22397
|
+
},
|
|
22319
22398
|
},
|
|
22320
22399
|
type: 'object',
|
|
22321
22400
|
},
|
|
@@ -22355,10 +22434,12 @@ export default {
|
|
|
22355
22434
|
'x-fern-sdk-method-name': 'list',
|
|
22356
22435
|
'x-fern-sdk-return-value': 'phones',
|
|
22357
22436
|
'x-response-key': 'phones',
|
|
22437
|
+
'x-title': 'List Phones',
|
|
22358
22438
|
},
|
|
22359
22439
|
},
|
|
22360
22440
|
'/phones/simulate/create_sandbox_phone': {
|
|
22361
22441
|
post: {
|
|
22442
|
+
description: 'Creates a new simulated phone in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](https://docs.seam.co/latest/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity).',
|
|
22362
22443
|
operationId: 'phonesSimulateCreateSandboxPhonePost',
|
|
22363
22444
|
requestBody: {
|
|
22364
22445
|
content: {
|
|
@@ -22367,42 +22448,79 @@ export default {
|
|
|
22367
22448
|
properties: {
|
|
22368
22449
|
assa_abloy_metadata: {
|
|
22369
22450
|
default: {},
|
|
22451
|
+
description: 'ASSA ABLOY metadata to associate with the simulated phone.',
|
|
22370
22452
|
properties: {
|
|
22371
|
-
application_version: {
|
|
22372
|
-
|
|
22373
|
-
|
|
22374
|
-
|
|
22375
|
-
|
|
22453
|
+
application_version: {
|
|
22454
|
+
default: '1.0.0',
|
|
22455
|
+
description: 'Application version that you want to use for the simulated phone.',
|
|
22456
|
+
type: 'string',
|
|
22457
|
+
},
|
|
22458
|
+
ble_capability: {
|
|
22459
|
+
default: true,
|
|
22460
|
+
description: 'Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability.',
|
|
22461
|
+
type: 'boolean',
|
|
22462
|
+
},
|
|
22463
|
+
hce_capability: {
|
|
22464
|
+
default: false,
|
|
22465
|
+
description: 'Indicates whether the simulated phone should have host card emulation (HCE) capability.',
|
|
22466
|
+
type: 'boolean',
|
|
22467
|
+
},
|
|
22468
|
+
nfc_capability: {
|
|
22469
|
+
default: false,
|
|
22470
|
+
description: 'Indicates whether the simulated phone should have near-field communication (NFC) capability.',
|
|
22471
|
+
type: 'boolean',
|
|
22472
|
+
},
|
|
22473
|
+
seos_applet_version: {
|
|
22474
|
+
default: '1.0.0',
|
|
22475
|
+
description: 'SEOS applet version that you want to use for the simulated phone.',
|
|
22476
|
+
type: 'string',
|
|
22477
|
+
},
|
|
22376
22478
|
seos_tsm_endpoint_id: {
|
|
22377
22479
|
default: 1,
|
|
22480
|
+
description: 'ID of the SEOS trusted service manager (TSM) endpoint that you want to use for the simulated phone.',
|
|
22378
22481
|
format: 'float',
|
|
22379
22482
|
type: 'number',
|
|
22380
22483
|
},
|
|
22381
22484
|
},
|
|
22382
22485
|
type: 'object',
|
|
22383
22486
|
},
|
|
22384
|
-
custom_sdk_installation_id: {
|
|
22487
|
+
custom_sdk_installation_id: {
|
|
22488
|
+
description: 'ID of the custom SDK installation to use for the simulated phone.',
|
|
22489
|
+
type: 'string',
|
|
22490
|
+
},
|
|
22385
22491
|
phone_metadata: {
|
|
22386
22492
|
default: {},
|
|
22493
|
+
description: 'Metadata to associate with the simulated phone.',
|
|
22387
22494
|
properties: {
|
|
22388
22495
|
device_manufacturer: {
|
|
22389
22496
|
default: 'Samsung',
|
|
22497
|
+
description: 'Manufacturer that you want to use for the simulated phone.',
|
|
22390
22498
|
type: 'string',
|
|
22391
22499
|
},
|
|
22392
22500
|
device_model: {
|
|
22393
22501
|
default: 'Samsung Galaxy S10',
|
|
22502
|
+
description: 'Device model that you want to use for the simulated phone.',
|
|
22394
22503
|
type: 'string',
|
|
22395
22504
|
},
|
|
22396
22505
|
operating_system: {
|
|
22397
22506
|
default: 'android',
|
|
22507
|
+
description: 'Mobile operating system that you want to use for the simulated phone.',
|
|
22398
22508
|
enum: ['android', 'ios'],
|
|
22399
22509
|
type: 'string',
|
|
22400
22510
|
},
|
|
22401
|
-
os_version: {
|
|
22511
|
+
os_version: {
|
|
22512
|
+
default: '10',
|
|
22513
|
+
description: 'Mobile operating system version that you want to use for the simulated phone.',
|
|
22514
|
+
type: 'string',
|
|
22515
|
+
},
|
|
22402
22516
|
},
|
|
22403
22517
|
type: 'object',
|
|
22404
22518
|
},
|
|
22405
|
-
user_identity_id: {
|
|
22519
|
+
user_identity_id: {
|
|
22520
|
+
description: 'ID of the user identity to associate with the simulated phone.',
|
|
22521
|
+
format: 'uuid',
|
|
22522
|
+
type: 'string',
|
|
22523
|
+
},
|
|
22406
22524
|
},
|
|
22407
22525
|
required: ['user_identity_id'],
|
|
22408
22526
|
type: 'object',
|
|
@@ -22440,6 +22558,7 @@ export default {
|
|
|
22440
22558
|
'x-fern-sdk-method-name': 'create_sandbox_phone',
|
|
22441
22559
|
'x-fern-sdk-return-value': 'phone',
|
|
22442
22560
|
'x-response-key': 'phone',
|
|
22561
|
+
'x-title': 'Create a Sandbox Phone',
|
|
22443
22562
|
},
|
|
22444
22563
|
},
|
|
22445
22564
|
'/thermostats/activate_climate_preset': {
|