@seamapi/types 1.406.6 → 1.406.8
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 +485 -223
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +472 -192
- package/lib/seam/connect/internal/schemas.d.ts +1 -1
- package/lib/seam/connect/internal/schemas.js +1 -1
- package/lib/seam/connect/internal/schemas.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.d.ts +6 -0
- package/lib/seam/connect/models/acs/acs-access-group.js +5 -1
- package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-encoder.d.ts +3 -0
- package/lib/seam/connect/models/acs/acs-encoder.js +4 -0
- package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
- package/lib/seam/connect/models/noise-sensors/noise-threshold.js +23 -7
- package/lib/seam/connect/models/noise-sensors/noise-threshold.js.map +1 -1
- package/lib/seam/connect/models/partner/index.d.ts +1 -0
- package/lib/seam/connect/models/partner/index.js +1 -0
- package/lib/seam/connect/models/partner/index.js.map +1 -1
- package/lib/seam/connect/models/partner/magic-link.d.ts +24 -0
- package/lib/seam/connect/models/partner/magic-link.js +19 -0
- package/lib/seam/connect/models/partner/magic-link.js.map +1 -0
- package/lib/seam/connect/models/partner/resources.d.ts +18 -2
- package/lib/seam/connect/models/partner/resources.js +17 -1
- package/lib/seam/connect/models/partner/resources.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +351 -145
- package/lib/seam/connect/openapi.js +450 -201
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +112 -47
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +3 -0
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +7 -1
- package/src/lib/seam/connect/models/acs/acs-encoder.ts +6 -0
- package/src/lib/seam/connect/models/noise-sensors/noise-threshold.ts +29 -7
- package/src/lib/seam/connect/models/partner/index.ts +1 -0
- package/src/lib/seam/connect/models/partner/magic-link.ts +21 -0
- package/src/lib/seam/connect/models/partner/resources.ts +19 -1
- package/src/lib/seam/connect/openapi.ts +503 -211
- package/src/lib/seam/connect/route-types.ts +119 -51
|
@@ -1400,6 +1400,11 @@ export default {
|
|
|
1400
1400
|
format: 'uuid',
|
|
1401
1401
|
type: 'string',
|
|
1402
1402
|
},
|
|
1403
|
+
connected_account_id: {
|
|
1404
|
+
description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group.',
|
|
1405
|
+
format: 'uuid',
|
|
1406
|
+
type: 'string',
|
|
1407
|
+
},
|
|
1403
1408
|
created_at: {
|
|
1404
1409
|
description: 'Date and time at which the access group was created.',
|
|
1405
1410
|
format: 'date-time',
|
|
@@ -1459,6 +1464,7 @@ export default {
|
|
|
1459
1464
|
'acs_access_group_id',
|
|
1460
1465
|
'acs_system_id',
|
|
1461
1466
|
'workspace_id',
|
|
1467
|
+
'connected_account_id',
|
|
1462
1468
|
'name',
|
|
1463
1469
|
'access_group_type',
|
|
1464
1470
|
'access_group_type_display_name',
|
|
@@ -1840,6 +1846,11 @@ export default {
|
|
|
1840
1846
|
format: 'uuid',
|
|
1841
1847
|
type: 'string',
|
|
1842
1848
|
},
|
|
1849
|
+
connected_account_id: {
|
|
1850
|
+
description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
|
|
1851
|
+
format: 'uuid',
|
|
1852
|
+
type: 'string',
|
|
1853
|
+
},
|
|
1843
1854
|
created_at: {
|
|
1844
1855
|
description: 'Date and time at which the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was created.',
|
|
1845
1856
|
format: 'date-time',
|
|
@@ -1883,6 +1894,7 @@ export default {
|
|
|
1883
1894
|
required: [
|
|
1884
1895
|
'acs_encoder_id',
|
|
1885
1896
|
'acs_system_id',
|
|
1897
|
+
'connected_account_id',
|
|
1886
1898
|
'workspace_id',
|
|
1887
1899
|
'errors',
|
|
1888
1900
|
'created_at',
|
|
@@ -14519,6 +14531,30 @@ export default {
|
|
|
14519
14531
|
'x-route-path': '/user_identities',
|
|
14520
14532
|
'x-undocumented': 'Unreleased.',
|
|
14521
14533
|
},
|
|
14534
|
+
magic_link: {
|
|
14535
|
+
properties: {
|
|
14536
|
+
building_block_type: {
|
|
14537
|
+
enum: ['connect_account', 'manage_devices', 'organize_spaces'],
|
|
14538
|
+
type: 'string',
|
|
14539
|
+
},
|
|
14540
|
+
created_at: { format: 'date-time', type: 'string' },
|
|
14541
|
+
customer_key: { type: 'string' },
|
|
14542
|
+
expires_at: { format: 'date-time', type: 'string' },
|
|
14543
|
+
url: { format: 'uri', type: 'string' },
|
|
14544
|
+
workspace_id: { format: 'uuid', type: 'string' },
|
|
14545
|
+
},
|
|
14546
|
+
required: [
|
|
14547
|
+
'url',
|
|
14548
|
+
'building_block_type',
|
|
14549
|
+
'customer_key',
|
|
14550
|
+
'expires_at',
|
|
14551
|
+
'workspace_id',
|
|
14552
|
+
'created_at',
|
|
14553
|
+
],
|
|
14554
|
+
type: 'object',
|
|
14555
|
+
'x-route-path': '/unstable_partner/building_blocks',
|
|
14556
|
+
'x-undocumented': 'Unreleased.',
|
|
14557
|
+
},
|
|
14522
14558
|
network: {
|
|
14523
14559
|
properties: {
|
|
14524
14560
|
created_at: { format: 'date-time', type: 'string' },
|
|
@@ -14531,14 +14567,37 @@ export default {
|
|
|
14531
14567
|
'x-route-path': '/networks',
|
|
14532
14568
|
},
|
|
14533
14569
|
noise_threshold: {
|
|
14570
|
+
description: 'Represents a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.',
|
|
14534
14571
|
properties: {
|
|
14535
|
-
device_id: {
|
|
14536
|
-
|
|
14537
|
-
|
|
14538
|
-
|
|
14539
|
-
|
|
14540
|
-
|
|
14541
|
-
|
|
14572
|
+
device_id: {
|
|
14573
|
+
description: 'Unique identifier for the device that contains the noise threshold.',
|
|
14574
|
+
format: 'uuid',
|
|
14575
|
+
type: 'string',
|
|
14576
|
+
},
|
|
14577
|
+
ends_daily_at: {
|
|
14578
|
+
description: 'Time at which the noise threshold should become inactive daily.',
|
|
14579
|
+
type: 'string',
|
|
14580
|
+
},
|
|
14581
|
+
name: { description: 'Name of the noise threshold.', type: 'string' },
|
|
14582
|
+
noise_threshold_decibels: {
|
|
14583
|
+
description: 'Noise level in decibels for the noise threshold.',
|
|
14584
|
+
format: 'float',
|
|
14585
|
+
type: 'number',
|
|
14586
|
+
},
|
|
14587
|
+
noise_threshold_id: {
|
|
14588
|
+
description: 'Unique identifier for the noise threshold.',
|
|
14589
|
+
format: 'uuid',
|
|
14590
|
+
type: 'string',
|
|
14591
|
+
},
|
|
14592
|
+
noise_threshold_nrs: {
|
|
14593
|
+
description: 'Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors).',
|
|
14594
|
+
format: 'float',
|
|
14595
|
+
type: 'number',
|
|
14596
|
+
},
|
|
14597
|
+
starts_daily_at: {
|
|
14598
|
+
description: 'Time at which the noise threshold should become active daily.',
|
|
14599
|
+
type: 'string',
|
|
14600
|
+
},
|
|
14542
14601
|
},
|
|
14543
14602
|
required: [
|
|
14544
14603
|
'noise_threshold_id',
|
|
@@ -16703,6 +16762,11 @@ export default {
|
|
|
16703
16762
|
format: 'uuid',
|
|
16704
16763
|
type: 'string',
|
|
16705
16764
|
},
|
|
16765
|
+
connected_account_id: {
|
|
16766
|
+
description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group.',
|
|
16767
|
+
format: 'uuid',
|
|
16768
|
+
type: 'string',
|
|
16769
|
+
},
|
|
16706
16770
|
created_at: {
|
|
16707
16771
|
description: 'Date and time at which the access group was created.',
|
|
16708
16772
|
format: 'date-time',
|
|
@@ -16762,6 +16826,7 @@ export default {
|
|
|
16762
16826
|
'acs_access_group_id',
|
|
16763
16827
|
'acs_system_id',
|
|
16764
16828
|
'workspace_id',
|
|
16829
|
+
'connected_account_id',
|
|
16765
16830
|
'name',
|
|
16766
16831
|
'access_group_type',
|
|
16767
16832
|
'access_group_type_display_name',
|
|
@@ -18840,6 +18905,7 @@ export default {
|
|
|
18840
18905
|
401: { description: 'Unauthorized' },
|
|
18841
18906
|
},
|
|
18842
18907
|
security: [
|
|
18908
|
+
{ client_session_with_customer: [] },
|
|
18843
18909
|
{ client_session: [] },
|
|
18844
18910
|
{ pat_with_workspace: [] },
|
|
18845
18911
|
{ console_session_with_workspace: [] },
|
|
@@ -19151,6 +19217,7 @@ export default {
|
|
|
19151
19217
|
},
|
|
19152
19218
|
security: [
|
|
19153
19219
|
{ client_session: [] },
|
|
19220
|
+
{ client_session_with_customer: [] },
|
|
19154
19221
|
{ pat_with_workspace: [] },
|
|
19155
19222
|
{ console_session_with_workspace: [] },
|
|
19156
19223
|
{ api_key: [] },
|
|
@@ -19274,6 +19341,7 @@ export default {
|
|
|
19274
19341
|
{ access_token: [] },
|
|
19275
19342
|
{ console_session_with_workspace: [] },
|
|
19276
19343
|
{ client_session: [] },
|
|
19344
|
+
{ client_session_with_customer: [] },
|
|
19277
19345
|
],
|
|
19278
19346
|
summary: '/access_codes/get',
|
|
19279
19347
|
tags: ['/access_codes'],
|
|
@@ -19298,6 +19366,10 @@ export default {
|
|
|
19298
19366
|
items: { format: 'uuid', type: 'string' },
|
|
19299
19367
|
type: 'array',
|
|
19300
19368
|
},
|
|
19369
|
+
customer_ids: {
|
|
19370
|
+
items: { format: 'uuid', type: 'string' },
|
|
19371
|
+
type: 'array',
|
|
19372
|
+
},
|
|
19301
19373
|
device_id: {
|
|
19302
19374
|
description: 'ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.',
|
|
19303
19375
|
format: 'uuid',
|
|
@@ -19349,6 +19421,7 @@ export default {
|
|
|
19349
19421
|
},
|
|
19350
19422
|
security: [
|
|
19351
19423
|
{ client_session: [] },
|
|
19424
|
+
{ client_session_with_customer: [] },
|
|
19352
19425
|
{ pat_with_workspace: [] },
|
|
19353
19426
|
{ console_session_with_workspace: [] },
|
|
19354
19427
|
{ api_key: [] },
|
|
@@ -25787,7 +25860,7 @@ export default {
|
|
|
25787
25860
|
},
|
|
25788
25861
|
'/connected_accounts/sync': {
|
|
25789
25862
|
post: {
|
|
25790
|
-
description: 'Request a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) sync attempt for the specified connected_account_id
|
|
25863
|
+
description: 'Request a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`.',
|
|
25791
25864
|
operationId: 'connectedAccountsSyncPost',
|
|
25792
25865
|
requestBody: {
|
|
25793
25866
|
content: {
|
|
@@ -27944,6 +28017,7 @@ export default {
|
|
|
27944
28017
|
},
|
|
27945
28018
|
security: [
|
|
27946
28019
|
{ client_session: [] },
|
|
28020
|
+
{ client_session_with_customer: [] },
|
|
27947
28021
|
{ pat_with_workspace: [] },
|
|
27948
28022
|
{ console_session_with_workspace: [] },
|
|
27949
28023
|
{ api_key: [] },
|
|
@@ -28125,6 +28199,7 @@ export default {
|
|
|
28125
28199
|
},
|
|
28126
28200
|
security: [
|
|
28127
28201
|
{ client_session: [] },
|
|
28202
|
+
{ client_session_with_customer: [] },
|
|
28128
28203
|
{ pat_with_workspace: [] },
|
|
28129
28204
|
{ console_session_with_workspace: [] },
|
|
28130
28205
|
{ api_key: [] },
|
|
@@ -28234,6 +28309,7 @@ export default {
|
|
|
28234
28309
|
},
|
|
28235
28310
|
'/noise_sensors/list': {
|
|
28236
28311
|
post: {
|
|
28312
|
+
description: 'Returns a list of all [noise sensors](https://docs.seam.co/latest/capability-guides/noise-sensors).',
|
|
28237
28313
|
operationId: 'noiseSensorsListPost',
|
|
28238
28314
|
requestBody: {
|
|
28239
28315
|
content: {
|
|
@@ -28277,12 +28353,12 @@ export default {
|
|
|
28277
28353
|
type: 'array',
|
|
28278
28354
|
},
|
|
28279
28355
|
device_type: {
|
|
28280
|
-
description: 'Device type
|
|
28356
|
+
description: 'Device type of the noise sensors that you want to list.',
|
|
28281
28357
|
enum: ['noiseaware_activity_zone', 'minut_sensor'],
|
|
28282
28358
|
type: 'string',
|
|
28283
28359
|
},
|
|
28284
28360
|
device_types: {
|
|
28285
|
-
description: '
|
|
28361
|
+
description: 'Device types of the noise sensors that you want to list.',
|
|
28286
28362
|
items: {
|
|
28287
28363
|
description: 'Device type for noise sensors.\n ',
|
|
28288
28364
|
enum: ['noiseaware_activity_zone', 'minut_sensor'],
|
|
@@ -28337,7 +28413,7 @@ export default {
|
|
|
28337
28413
|
type: 'number',
|
|
28338
28414
|
},
|
|
28339
28415
|
manufacturer: {
|
|
28340
|
-
description: '
|
|
28416
|
+
description: 'Manufacturers of the noise sensors that you want to list.',
|
|
28341
28417
|
enum: ['minut', 'noiseaware'],
|
|
28342
28418
|
type: 'string',
|
|
28343
28419
|
},
|
|
@@ -28401,23 +28477,50 @@ export default {
|
|
|
28401
28477
|
'x-fern-sdk-method-name': 'list',
|
|
28402
28478
|
'x-fern-sdk-return-value': 'devices',
|
|
28403
28479
|
'x-response-key': 'devices',
|
|
28480
|
+
'x-title': 'List Noise Sensors',
|
|
28404
28481
|
},
|
|
28405
28482
|
},
|
|
28406
28483
|
'/noise_sensors/noise_thresholds/create': {
|
|
28407
28484
|
post: {
|
|
28485
|
+
description: 'Creates a new [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.',
|
|
28408
28486
|
operationId: 'noiseSensorsNoiseThresholdsCreatePost',
|
|
28409
28487
|
requestBody: {
|
|
28410
28488
|
content: {
|
|
28411
28489
|
'application/json': {
|
|
28412
28490
|
schema: {
|
|
28413
28491
|
properties: {
|
|
28414
|
-
device_id: {
|
|
28415
|
-
|
|
28416
|
-
|
|
28417
|
-
|
|
28418
|
-
|
|
28419
|
-
|
|
28420
|
-
|
|
28492
|
+
device_id: {
|
|
28493
|
+
description: 'ID of the device for which you want to create a noise threshold.',
|
|
28494
|
+
format: 'uuid',
|
|
28495
|
+
type: 'string',
|
|
28496
|
+
},
|
|
28497
|
+
ends_daily_at: {
|
|
28498
|
+
description: 'Time at which the new noise threshold should become inactive daily.',
|
|
28499
|
+
type: 'string',
|
|
28500
|
+
},
|
|
28501
|
+
name: {
|
|
28502
|
+
description: 'Name of the new noise threshold.',
|
|
28503
|
+
type: 'string',
|
|
28504
|
+
},
|
|
28505
|
+
noise_threshold_decibels: {
|
|
28506
|
+
description: 'Noise level in decibels for the new noise threshold.',
|
|
28507
|
+
format: 'float',
|
|
28508
|
+
type: 'number',
|
|
28509
|
+
},
|
|
28510
|
+
noise_threshold_nrs: {
|
|
28511
|
+
description: 'Noise level in Noiseaware Noise Risk Score (NRS) for the new noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors).',
|
|
28512
|
+
format: 'float',
|
|
28513
|
+
type: 'number',
|
|
28514
|
+
},
|
|
28515
|
+
starts_daily_at: {
|
|
28516
|
+
description: 'Time at which the new noise threshold should become active daily.',
|
|
28517
|
+
type: 'string',
|
|
28518
|
+
},
|
|
28519
|
+
sync: {
|
|
28520
|
+
default: false,
|
|
28521
|
+
type: 'boolean',
|
|
28522
|
+
'x-undocumented': 'Only used internally.',
|
|
28523
|
+
},
|
|
28421
28524
|
},
|
|
28422
28525
|
required: ['device_id', 'starts_daily_at', 'ends_daily_at'],
|
|
28423
28526
|
type: 'object',
|
|
@@ -28461,19 +28564,33 @@ export default {
|
|
|
28461
28564
|
'x-fern-sdk-method-name': 'create',
|
|
28462
28565
|
'x-fern-sdk-return-value': 'noise_threshold',
|
|
28463
28566
|
'x-response-key': 'noise_threshold',
|
|
28567
|
+
'x-title': 'Create a Noise Threshold',
|
|
28464
28568
|
},
|
|
28465
28569
|
},
|
|
28466
28570
|
'/noise_sensors/noise_thresholds/delete': {
|
|
28467
28571
|
post: {
|
|
28572
|
+
description: 'Deletes a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors).',
|
|
28468
28573
|
operationId: 'noiseSensorsNoiseThresholdsDeletePost',
|
|
28469
28574
|
requestBody: {
|
|
28470
28575
|
content: {
|
|
28471
28576
|
'application/json': {
|
|
28472
28577
|
schema: {
|
|
28473
28578
|
properties: {
|
|
28474
|
-
device_id: {
|
|
28475
|
-
|
|
28476
|
-
|
|
28579
|
+
device_id: {
|
|
28580
|
+
description: 'ID of the device that contains the noise threshold that you want to delete.',
|
|
28581
|
+
format: 'uuid',
|
|
28582
|
+
type: 'string',
|
|
28583
|
+
},
|
|
28584
|
+
noise_threshold_id: {
|
|
28585
|
+
description: 'ID of the noise threshold that you want to delete.',
|
|
28586
|
+
format: 'uuid',
|
|
28587
|
+
type: 'string',
|
|
28588
|
+
},
|
|
28589
|
+
sync: {
|
|
28590
|
+
default: false,
|
|
28591
|
+
type: 'boolean',
|
|
28592
|
+
'x-undocumented': 'Only used internally.',
|
|
28593
|
+
},
|
|
28477
28594
|
},
|
|
28478
28595
|
required: ['noise_threshold_id', 'device_id'],
|
|
28479
28596
|
type: 'object',
|
|
@@ -28513,17 +28630,23 @@ export default {
|
|
|
28513
28630
|
'x-fern-sdk-group-name': ['noise_sensors', 'noise_thresholds'],
|
|
28514
28631
|
'x-fern-sdk-method-name': 'delete',
|
|
28515
28632
|
'x-response-key': null,
|
|
28633
|
+
'x-title': 'Delete a Noise Threshold',
|
|
28516
28634
|
},
|
|
28517
28635
|
},
|
|
28518
28636
|
'/noise_sensors/noise_thresholds/get': {
|
|
28519
28637
|
post: {
|
|
28638
|
+
description: 'Returns a specified [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors).',
|
|
28520
28639
|
operationId: 'noiseSensorsNoiseThresholdsGetPost',
|
|
28521
28640
|
requestBody: {
|
|
28522
28641
|
content: {
|
|
28523
28642
|
'application/json': {
|
|
28524
28643
|
schema: {
|
|
28525
28644
|
properties: {
|
|
28526
|
-
noise_threshold_id: {
|
|
28645
|
+
noise_threshold_id: {
|
|
28646
|
+
description: 'ID of the noise threshold that you want to get.',
|
|
28647
|
+
format: 'uuid',
|
|
28648
|
+
type: 'string',
|
|
28649
|
+
},
|
|
28527
28650
|
},
|
|
28528
28651
|
required: ['noise_threshold_id'],
|
|
28529
28652
|
type: 'object',
|
|
@@ -28563,18 +28686,28 @@ export default {
|
|
|
28563
28686
|
'x-fern-sdk-method-name': 'get',
|
|
28564
28687
|
'x-fern-sdk-return-value': 'noise_threshold',
|
|
28565
28688
|
'x-response-key': 'noise_threshold',
|
|
28689
|
+
'x-title': 'Get a Noise Threshold',
|
|
28566
28690
|
},
|
|
28567
28691
|
},
|
|
28568
28692
|
'/noise_sensors/noise_thresholds/list': {
|
|
28569
28693
|
post: {
|
|
28694
|
+
description: 'Returns a list of all [noise thresholds](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors).',
|
|
28570
28695
|
operationId: 'noiseSensorsNoiseThresholdsListPost',
|
|
28571
28696
|
requestBody: {
|
|
28572
28697
|
content: {
|
|
28573
28698
|
'application/json': {
|
|
28574
28699
|
schema: {
|
|
28575
28700
|
properties: {
|
|
28576
|
-
device_id: {
|
|
28577
|
-
|
|
28701
|
+
device_id: {
|
|
28702
|
+
description: 'ID of the device for which you want to list noise thresholds.',
|
|
28703
|
+
format: 'uuid',
|
|
28704
|
+
type: 'string',
|
|
28705
|
+
},
|
|
28706
|
+
is_programmed: {
|
|
28707
|
+
description: 'Enables you to limit the returned noise thresholds by whether they are programmed on the noise sensor. To list only noise thresholds that are programmed on the noise sensor, set this parameter to `true`. To list only noise thresholds that are not programmed on the noise sensor, se this parameter to `false`.',
|
|
28708
|
+
type: 'boolean',
|
|
28709
|
+
'x-undocumented': 'Not sure if this parameter is supported or what it does.',
|
|
28710
|
+
},
|
|
28578
28711
|
},
|
|
28579
28712
|
required: ['device_id'],
|
|
28580
28713
|
type: 'object',
|
|
@@ -28616,24 +28749,55 @@ export default {
|
|
|
28616
28749
|
'x-fern-sdk-method-name': 'list',
|
|
28617
28750
|
'x-fern-sdk-return-value': 'noise_thresholds',
|
|
28618
28751
|
'x-response-key': 'noise_thresholds',
|
|
28752
|
+
'x-title': 'List Noise Thresholds',
|
|
28619
28753
|
},
|
|
28620
28754
|
},
|
|
28621
28755
|
'/noise_sensors/noise_thresholds/update': {
|
|
28622
28756
|
patch: {
|
|
28757
|
+
description: 'Updates a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors).',
|
|
28623
28758
|
operationId: 'noiseSensorsNoiseThresholdsUpdatePatch',
|
|
28624
28759
|
requestBody: {
|
|
28625
28760
|
content: {
|
|
28626
28761
|
'application/json': {
|
|
28627
28762
|
schema: {
|
|
28628
28763
|
properties: {
|
|
28629
|
-
device_id: {
|
|
28630
|
-
|
|
28631
|
-
|
|
28632
|
-
|
|
28633
|
-
|
|
28634
|
-
|
|
28635
|
-
|
|
28636
|
-
|
|
28764
|
+
device_id: {
|
|
28765
|
+
description: 'ID of the device that contains the noise threshold that you want to update.',
|
|
28766
|
+
format: 'uuid',
|
|
28767
|
+
type: 'string',
|
|
28768
|
+
},
|
|
28769
|
+
ends_daily_at: {
|
|
28770
|
+
description: 'Time at which the noise threshold should become inactive daily.',
|
|
28771
|
+
type: 'string',
|
|
28772
|
+
},
|
|
28773
|
+
name: {
|
|
28774
|
+
description: 'Name of the noise threshold that you want to update.',
|
|
28775
|
+
type: 'string',
|
|
28776
|
+
},
|
|
28777
|
+
noise_threshold_decibels: {
|
|
28778
|
+
description: 'Noise level in decibels for the noise threshold.',
|
|
28779
|
+
format: 'float',
|
|
28780
|
+
type: 'number',
|
|
28781
|
+
},
|
|
28782
|
+
noise_threshold_id: {
|
|
28783
|
+
description: 'ID of the noise threshold that you want to update.',
|
|
28784
|
+
format: 'uuid',
|
|
28785
|
+
type: 'string',
|
|
28786
|
+
},
|
|
28787
|
+
noise_threshold_nrs: {
|
|
28788
|
+
description: 'Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors).',
|
|
28789
|
+
format: 'float',
|
|
28790
|
+
type: 'number',
|
|
28791
|
+
},
|
|
28792
|
+
starts_daily_at: {
|
|
28793
|
+
description: 'Time at which the noise threshold should become active daily.',
|
|
28794
|
+
type: 'string',
|
|
28795
|
+
},
|
|
28796
|
+
sync: {
|
|
28797
|
+
default: false,
|
|
28798
|
+
type: 'boolean',
|
|
28799
|
+
'x-undocumented': 'Only used internally.',
|
|
28800
|
+
},
|
|
28637
28801
|
},
|
|
28638
28802
|
required: ['noise_threshold_id', 'device_id'],
|
|
28639
28803
|
type: 'object',
|
|
@@ -28672,22 +28836,53 @@ export default {
|
|
|
28672
28836
|
'x-action-attempt-type': 'UPDATE_NOISE_THRESHOLD',
|
|
28673
28837
|
'x-fern-ignore': true,
|
|
28674
28838
|
'x-response-key': null,
|
|
28839
|
+
'x-title': 'Update a Noise Threshold',
|
|
28675
28840
|
},
|
|
28676
28841
|
post: {
|
|
28842
|
+
description: 'Updates a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors).',
|
|
28677
28843
|
operationId: 'noiseSensorsNoiseThresholdsUpdatePost',
|
|
28678
28844
|
requestBody: {
|
|
28679
28845
|
content: {
|
|
28680
28846
|
'application/json': {
|
|
28681
28847
|
schema: {
|
|
28682
28848
|
properties: {
|
|
28683
|
-
device_id: {
|
|
28684
|
-
|
|
28685
|
-
|
|
28686
|
-
|
|
28687
|
-
|
|
28688
|
-
|
|
28689
|
-
|
|
28690
|
-
|
|
28849
|
+
device_id: {
|
|
28850
|
+
description: 'ID of the device that contains the noise threshold that you want to update.',
|
|
28851
|
+
format: 'uuid',
|
|
28852
|
+
type: 'string',
|
|
28853
|
+
},
|
|
28854
|
+
ends_daily_at: {
|
|
28855
|
+
description: 'Time at which the noise threshold should become inactive daily.',
|
|
28856
|
+
type: 'string',
|
|
28857
|
+
},
|
|
28858
|
+
name: {
|
|
28859
|
+
description: 'Name of the noise threshold that you want to update.',
|
|
28860
|
+
type: 'string',
|
|
28861
|
+
},
|
|
28862
|
+
noise_threshold_decibels: {
|
|
28863
|
+
description: 'Noise level in decibels for the noise threshold.',
|
|
28864
|
+
format: 'float',
|
|
28865
|
+
type: 'number',
|
|
28866
|
+
},
|
|
28867
|
+
noise_threshold_id: {
|
|
28868
|
+
description: 'ID of the noise threshold that you want to update.',
|
|
28869
|
+
format: 'uuid',
|
|
28870
|
+
type: 'string',
|
|
28871
|
+
},
|
|
28872
|
+
noise_threshold_nrs: {
|
|
28873
|
+
description: 'Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors).',
|
|
28874
|
+
format: 'float',
|
|
28875
|
+
type: 'number',
|
|
28876
|
+
},
|
|
28877
|
+
starts_daily_at: {
|
|
28878
|
+
description: 'Time at which the noise threshold should become active daily.',
|
|
28879
|
+
type: 'string',
|
|
28880
|
+
},
|
|
28881
|
+
sync: {
|
|
28882
|
+
default: false,
|
|
28883
|
+
type: 'boolean',
|
|
28884
|
+
'x-undocumented': 'Only used internally.',
|
|
28885
|
+
},
|
|
28691
28886
|
},
|
|
28692
28887
|
required: ['noise_threshold_id', 'device_id'],
|
|
28693
28888
|
type: 'object',
|
|
@@ -28727,22 +28922,53 @@ export default {
|
|
|
28727
28922
|
'x-fern-sdk-group-name': ['noise_sensors', 'noise_thresholds'],
|
|
28728
28923
|
'x-fern-sdk-method-name': 'update',
|
|
28729
28924
|
'x-response-key': null,
|
|
28925
|
+
'x-title': 'Update a Noise Threshold',
|
|
28730
28926
|
},
|
|
28731
28927
|
put: {
|
|
28928
|
+
description: 'Updates a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors).',
|
|
28732
28929
|
operationId: 'noiseSensorsNoiseThresholdsUpdatePut',
|
|
28733
28930
|
requestBody: {
|
|
28734
28931
|
content: {
|
|
28735
28932
|
'application/json': {
|
|
28736
28933
|
schema: {
|
|
28737
28934
|
properties: {
|
|
28738
|
-
device_id: {
|
|
28739
|
-
|
|
28740
|
-
|
|
28741
|
-
|
|
28742
|
-
|
|
28743
|
-
|
|
28744
|
-
|
|
28745
|
-
|
|
28935
|
+
device_id: {
|
|
28936
|
+
description: 'ID of the device that contains the noise threshold that you want to update.',
|
|
28937
|
+
format: 'uuid',
|
|
28938
|
+
type: 'string',
|
|
28939
|
+
},
|
|
28940
|
+
ends_daily_at: {
|
|
28941
|
+
description: 'Time at which the noise threshold should become inactive daily.',
|
|
28942
|
+
type: 'string',
|
|
28943
|
+
},
|
|
28944
|
+
name: {
|
|
28945
|
+
description: 'Name of the noise threshold that you want to update.',
|
|
28946
|
+
type: 'string',
|
|
28947
|
+
},
|
|
28948
|
+
noise_threshold_decibels: {
|
|
28949
|
+
description: 'Noise level in decibels for the noise threshold.',
|
|
28950
|
+
format: 'float',
|
|
28951
|
+
type: 'number',
|
|
28952
|
+
},
|
|
28953
|
+
noise_threshold_id: {
|
|
28954
|
+
description: 'ID of the noise threshold that you want to update.',
|
|
28955
|
+
format: 'uuid',
|
|
28956
|
+
type: 'string',
|
|
28957
|
+
},
|
|
28958
|
+
noise_threshold_nrs: {
|
|
28959
|
+
description: 'Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors).',
|
|
28960
|
+
format: 'float',
|
|
28961
|
+
type: 'number',
|
|
28962
|
+
},
|
|
28963
|
+
starts_daily_at: {
|
|
28964
|
+
description: 'Time at which the noise threshold should become active daily.',
|
|
28965
|
+
type: 'string',
|
|
28966
|
+
},
|
|
28967
|
+
sync: {
|
|
28968
|
+
default: false,
|
|
28969
|
+
type: 'boolean',
|
|
28970
|
+
'x-undocumented': 'Only used internally.',
|
|
28971
|
+
},
|
|
28746
28972
|
},
|
|
28747
28973
|
required: ['noise_threshold_id', 'device_id'],
|
|
28748
28974
|
type: 'object',
|
|
@@ -28781,16 +29007,24 @@ export default {
|
|
|
28781
29007
|
'x-action-attempt-type': 'UPDATE_NOISE_THRESHOLD',
|
|
28782
29008
|
'x-fern-ignore': true,
|
|
28783
29009
|
'x-response-key': null,
|
|
29010
|
+
'x-title': 'Update a Noise Threshold',
|
|
28784
29011
|
},
|
|
28785
29012
|
},
|
|
28786
29013
|
'/noise_sensors/simulate/trigger_noise_threshold': {
|
|
28787
29014
|
post: {
|
|
29015
|
+
description: 'Simulates the triggering of a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors) in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
|
|
28788
29016
|
operationId: 'noiseSensorsSimulateTriggerNoiseThresholdPost',
|
|
28789
29017
|
requestBody: {
|
|
28790
29018
|
content: {
|
|
28791
29019
|
'application/json': {
|
|
28792
29020
|
schema: {
|
|
28793
|
-
properties: {
|
|
29021
|
+
properties: {
|
|
29022
|
+
device_id: {
|
|
29023
|
+
description: 'ID of the device for which you want to simulate the triggering of a noise threshold.',
|
|
29024
|
+
format: 'uuid',
|
|
29025
|
+
type: 'string',
|
|
29026
|
+
},
|
|
29027
|
+
},
|
|
28794
29028
|
required: ['device_id'],
|
|
28795
29029
|
type: 'object',
|
|
28796
29030
|
},
|
|
@@ -28823,6 +29057,7 @@ export default {
|
|
|
28823
29057
|
'x-fern-sdk-group-name': ['noise_sensors', 'simulate'],
|
|
28824
29058
|
'x-fern-sdk-method-name': 'trigger_noise_threshold',
|
|
28825
29059
|
'x-response-key': null,
|
|
29060
|
+
'x-title': 'Simulate Triggering a Noise Threshold',
|
|
28826
29061
|
},
|
|
28827
29062
|
},
|
|
28828
29063
|
'/phones/deactivate': {
|
|
@@ -30332,6 +30567,99 @@ export default {
|
|
|
30332
30567
|
'x-undocumented': 'Mobile SDK only.',
|
|
30333
30568
|
},
|
|
30334
30569
|
},
|
|
30570
|
+
'/seam/partner/v1/building_blocks/spaces/auto_map': {
|
|
30571
|
+
post: {
|
|
30572
|
+
description: 'Auto map partner resources that have been pushed to Seam.',
|
|
30573
|
+
operationId: 'seamPartnerV1BuildingBlocksSpacesAutoMapPost',
|
|
30574
|
+
requestBody: {
|
|
30575
|
+
content: {
|
|
30576
|
+
'application/json': {
|
|
30577
|
+
schema: {
|
|
30578
|
+
properties: { collection_key: { type: 'string' } },
|
|
30579
|
+
required: ['collection_key'],
|
|
30580
|
+
type: 'object',
|
|
30581
|
+
},
|
|
30582
|
+
},
|
|
30583
|
+
},
|
|
30584
|
+
},
|
|
30585
|
+
responses: {
|
|
30586
|
+
200: {
|
|
30587
|
+
content: {
|
|
30588
|
+
'application/json': {
|
|
30589
|
+
schema: {
|
|
30590
|
+
properties: {
|
|
30591
|
+
ok: { type: 'boolean' },
|
|
30592
|
+
spaces: {
|
|
30593
|
+
items: {
|
|
30594
|
+
properties: {
|
|
30595
|
+
acs_entrances: {
|
|
30596
|
+
items: {
|
|
30597
|
+
properties: {
|
|
30598
|
+
acs_entrance_id: { type: 'string' },
|
|
30599
|
+
name: { type: 'string' },
|
|
30600
|
+
},
|
|
30601
|
+
required: ['acs_entrance_id', 'name'],
|
|
30602
|
+
type: 'object',
|
|
30603
|
+
},
|
|
30604
|
+
type: 'array',
|
|
30605
|
+
},
|
|
30606
|
+
devices: {
|
|
30607
|
+
items: {
|
|
30608
|
+
properties: {
|
|
30609
|
+
device_id: { type: 'string' },
|
|
30610
|
+
device_type: {
|
|
30611
|
+
enum: ['lock', 'thermostat', 'sensor'],
|
|
30612
|
+
type: 'string',
|
|
30613
|
+
},
|
|
30614
|
+
name: { type: 'string' },
|
|
30615
|
+
},
|
|
30616
|
+
required: ['device_id', 'device_type', 'name'],
|
|
30617
|
+
type: 'object',
|
|
30618
|
+
},
|
|
30619
|
+
type: 'array',
|
|
30620
|
+
},
|
|
30621
|
+
name: { type: 'string' },
|
|
30622
|
+
needs_review: { type: 'boolean' },
|
|
30623
|
+
partner_resource_key: { type: 'string' },
|
|
30624
|
+
},
|
|
30625
|
+
required: [
|
|
30626
|
+
'name',
|
|
30627
|
+
'partner_resource_key',
|
|
30628
|
+
'devices',
|
|
30629
|
+
'acs_entrances',
|
|
30630
|
+
],
|
|
30631
|
+
type: 'object',
|
|
30632
|
+
},
|
|
30633
|
+
type: 'array',
|
|
30634
|
+
},
|
|
30635
|
+
},
|
|
30636
|
+
required: ['spaces', 'ok'],
|
|
30637
|
+
type: 'object',
|
|
30638
|
+
},
|
|
30639
|
+
},
|
|
30640
|
+
},
|
|
30641
|
+
description: 'OK',
|
|
30642
|
+
},
|
|
30643
|
+
400: { description: 'Bad Request' },
|
|
30644
|
+
401: { description: 'Unauthorized' },
|
|
30645
|
+
},
|
|
30646
|
+
security: [{ client_session_with_customer: [] }],
|
|
30647
|
+
summary: '/seam/partner/v1/building_blocks/spaces/auto_map',
|
|
30648
|
+
tags: [],
|
|
30649
|
+
'x-fern-sdk-group-name': [
|
|
30650
|
+
'seam',
|
|
30651
|
+
'partner',
|
|
30652
|
+
'v1',
|
|
30653
|
+
'building_blocks',
|
|
30654
|
+
'spaces',
|
|
30655
|
+
],
|
|
30656
|
+
'x-fern-sdk-method-name': 'auto_map',
|
|
30657
|
+
'x-fern-sdk-return-value': 'spaces',
|
|
30658
|
+
'x-response-key': 'spaces',
|
|
30659
|
+
'x-title': 'Do auto mapping for partner resources that map to spaces',
|
|
30660
|
+
'x-undocumented': 'Partner building blocks/UI only.',
|
|
30661
|
+
},
|
|
30662
|
+
},
|
|
30335
30663
|
'/seam/partner/v1/resources/list': {
|
|
30336
30664
|
post: {
|
|
30337
30665
|
description: 'List partner resources that have been pushed to Seam.',
|
|
@@ -30386,6 +30714,8 @@ export default {
|
|
|
30386
30714
|
'customer_key',
|
|
30387
30715
|
],
|
|
30388
30716
|
type: 'object',
|
|
30717
|
+
'x-route-path': '/unstable_partner/resources',
|
|
30718
|
+
'x-undocumented': 'Unreleased.',
|
|
30389
30719
|
},
|
|
30390
30720
|
type: 'array',
|
|
30391
30721
|
},
|
|
@@ -34652,25 +34982,72 @@ export default {
|
|
|
34652
34982
|
'x-undocumented': 'Experimental locations.',
|
|
34653
34983
|
},
|
|
34654
34984
|
},
|
|
34655
|
-
'/unstable_partner/building_blocks/
|
|
34985
|
+
'/unstable_partner/building_blocks/generate_magic_link': {
|
|
34656
34986
|
post: {
|
|
34657
|
-
description: 'Creates a new
|
|
34658
|
-
operationId: '
|
|
34987
|
+
description: 'Creates a new building block magic link.',
|
|
34988
|
+
operationId: 'unstablePartnerBuildingBlocksGenerateMagicLinkPost',
|
|
34659
34989
|
requestBody: {
|
|
34660
34990
|
content: {
|
|
34661
34991
|
'application/json': {
|
|
34662
34992
|
schema: {
|
|
34663
|
-
|
|
34664
|
-
|
|
34665
|
-
|
|
34666
|
-
|
|
34667
|
-
|
|
34668
|
-
|
|
34669
|
-
|
|
34670
|
-
|
|
34671
|
-
|
|
34993
|
+
discriminator: { propertyName: 'building_block_type' },
|
|
34994
|
+
oneOf: [
|
|
34995
|
+
{
|
|
34996
|
+
properties: {
|
|
34997
|
+
building_block_type: {
|
|
34998
|
+
enum: ['connect_account'],
|
|
34999
|
+
type: 'string',
|
|
35000
|
+
},
|
|
35001
|
+
customer_key: { type: 'string' },
|
|
35002
|
+
},
|
|
35003
|
+
required: ['building_block_type', 'customer_key'],
|
|
35004
|
+
type: 'object',
|
|
35005
|
+
},
|
|
35006
|
+
{
|
|
35007
|
+
properties: {
|
|
35008
|
+
building_block_type: {
|
|
35009
|
+
enum: ['manage_devices'],
|
|
35010
|
+
type: 'string',
|
|
35011
|
+
},
|
|
35012
|
+
customer_key: { type: 'string' },
|
|
35013
|
+
},
|
|
35014
|
+
required: ['building_block_type', 'customer_key'],
|
|
35015
|
+
type: 'object',
|
|
35016
|
+
},
|
|
35017
|
+
{
|
|
35018
|
+
properties: {
|
|
35019
|
+
building_block_type: {
|
|
35020
|
+
enum: ['organize_spaces'],
|
|
35021
|
+
type: 'string',
|
|
35022
|
+
},
|
|
35023
|
+
customer_key: { type: 'string' },
|
|
35024
|
+
partner_resources: {
|
|
35025
|
+
items: {
|
|
35026
|
+
properties: {
|
|
35027
|
+
custom_metadata: {
|
|
35028
|
+
additionalProperties: { type: 'string' },
|
|
35029
|
+
type: 'object',
|
|
35030
|
+
},
|
|
35031
|
+
description: { type: 'string' },
|
|
35032
|
+
name: { type: 'string' },
|
|
35033
|
+
partner_resource_key: { type: 'string' },
|
|
35034
|
+
},
|
|
35035
|
+
required: ['partner_resource_key', 'name'],
|
|
35036
|
+
type: 'object',
|
|
35037
|
+
'x-route-path': '/unstable_partner/resources',
|
|
35038
|
+
'x-undocumented': 'Unreleased.',
|
|
35039
|
+
},
|
|
35040
|
+
type: 'array',
|
|
35041
|
+
},
|
|
35042
|
+
},
|
|
35043
|
+
required: [
|
|
35044
|
+
'building_block_type',
|
|
35045
|
+
'customer_key',
|
|
35046
|
+
'partner_resources',
|
|
35047
|
+
],
|
|
35048
|
+
type: 'object',
|
|
35049
|
+
},
|
|
34672
35050
|
],
|
|
34673
|
-
type: 'object',
|
|
34674
35051
|
},
|
|
34675
35052
|
},
|
|
34676
35053
|
},
|
|
@@ -34681,142 +35058,10 @@ export default {
|
|
|
34681
35058
|
'application/json': {
|
|
34682
35059
|
schema: {
|
|
34683
35060
|
properties: {
|
|
34684
|
-
|
|
34685
|
-
properties: {
|
|
34686
|
-
bridge_client_machine_identifier_key: {
|
|
34687
|
-
type: 'string',
|
|
34688
|
-
},
|
|
34689
|
-
bridge_client_name: { type: 'string' },
|
|
34690
|
-
bridge_client_session_id: {
|
|
34691
|
-
format: 'uuid',
|
|
34692
|
-
type: 'string',
|
|
34693
|
-
},
|
|
34694
|
-
bridge_client_session_token: { type: 'string' },
|
|
34695
|
-
bridge_client_time_zone: { type: 'string' },
|
|
34696
|
-
created_at: { format: 'date-time', type: 'string' },
|
|
34697
|
-
errors: {
|
|
34698
|
-
items: {
|
|
34699
|
-
description: 'Error associated with the `bridge_client_session`.',
|
|
34700
|
-
discriminator: { propertyName: 'error_code' },
|
|
34701
|
-
oneOf: [
|
|
34702
|
-
{
|
|
34703
|
-
description: "Seam cannot reach the bridge's LAN",
|
|
34704
|
-
properties: {
|
|
34705
|
-
can_tailscale_proxy_reach_bridge: {
|
|
34706
|
-
description: 'Tailscale proxy cannot reach the bridge',
|
|
34707
|
-
nullable: true,
|
|
34708
|
-
type: 'boolean',
|
|
34709
|
-
},
|
|
34710
|
-
can_tailscale_proxy_reach_tailscale_network: {
|
|
34711
|
-
description: 'Tailscale proxy cannot reach the Tailscale network',
|
|
34712
|
-
nullable: true,
|
|
34713
|
-
type: 'boolean',
|
|
34714
|
-
},
|
|
34715
|
-
created_at: {
|
|
34716
|
-
format: 'date-time',
|
|
34717
|
-
type: 'string',
|
|
34718
|
-
},
|
|
34719
|
-
error_code: {
|
|
34720
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
34721
|
-
enum: ['bridge_lan_unreachable'],
|
|
34722
|
-
type: 'string',
|
|
34723
|
-
},
|
|
34724
|
-
is_bridge_socks_server_healthy: {
|
|
34725
|
-
description: "Bridge's SOCKS server is unhealthy",
|
|
34726
|
-
nullable: true,
|
|
34727
|
-
type: 'boolean',
|
|
34728
|
-
},
|
|
34729
|
-
is_tailscale_proxy_reachable: {
|
|
34730
|
-
description: 'Seam cannot reach the tailscale proxy',
|
|
34731
|
-
nullable: true,
|
|
34732
|
-
type: 'boolean',
|
|
34733
|
-
},
|
|
34734
|
-
is_tailscale_proxy_socks_server_healthy: {
|
|
34735
|
-
description: "Tailscale proxy's SOCKS server is unhealthy",
|
|
34736
|
-
nullable: true,
|
|
34737
|
-
type: 'boolean',
|
|
34738
|
-
},
|
|
34739
|
-
message: { type: 'string' },
|
|
34740
|
-
},
|
|
34741
|
-
required: [
|
|
34742
|
-
'message',
|
|
34743
|
-
'created_at',
|
|
34744
|
-
'error_code',
|
|
34745
|
-
'is_tailscale_proxy_reachable',
|
|
34746
|
-
'is_tailscale_proxy_socks_server_healthy',
|
|
34747
|
-
'can_tailscale_proxy_reach_tailscale_network',
|
|
34748
|
-
'can_tailscale_proxy_reach_bridge',
|
|
34749
|
-
'is_bridge_socks_server_healthy',
|
|
34750
|
-
],
|
|
34751
|
-
type: 'object',
|
|
34752
|
-
},
|
|
34753
|
-
{
|
|
34754
|
-
description: 'Bridge has stopped communicating with Seam',
|
|
34755
|
-
properties: {
|
|
34756
|
-
created_at: {
|
|
34757
|
-
format: 'date-time',
|
|
34758
|
-
type: 'string',
|
|
34759
|
-
},
|
|
34760
|
-
error_code: {
|
|
34761
|
-
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
34762
|
-
enum: ['no_communication_from_bridge'],
|
|
34763
|
-
type: 'string',
|
|
34764
|
-
},
|
|
34765
|
-
message: { type: 'string' },
|
|
34766
|
-
},
|
|
34767
|
-
required: [
|
|
34768
|
-
'message',
|
|
34769
|
-
'created_at',
|
|
34770
|
-
'error_code',
|
|
34771
|
-
],
|
|
34772
|
-
type: 'object',
|
|
34773
|
-
},
|
|
34774
|
-
],
|
|
34775
|
-
},
|
|
34776
|
-
type: 'array',
|
|
34777
|
-
},
|
|
34778
|
-
pairing_code: {
|
|
34779
|
-
maxLength: 6,
|
|
34780
|
-
minLength: 6,
|
|
34781
|
-
type: 'string',
|
|
34782
|
-
},
|
|
34783
|
-
pairing_code_expires_at: {
|
|
34784
|
-
format: 'date-time',
|
|
34785
|
-
type: 'string',
|
|
34786
|
-
},
|
|
34787
|
-
tailscale_auth_key: { nullable: true, type: 'string' },
|
|
34788
|
-
tailscale_hostname: { type: 'string' },
|
|
34789
|
-
telemetry_token: { nullable: true, type: 'string' },
|
|
34790
|
-
telemetry_token_expires_at: {
|
|
34791
|
-
format: 'date-time',
|
|
34792
|
-
nullable: true,
|
|
34793
|
-
type: 'string',
|
|
34794
|
-
},
|
|
34795
|
-
telemetry_url: { nullable: true, type: 'string' },
|
|
34796
|
-
},
|
|
34797
|
-
required: [
|
|
34798
|
-
'created_at',
|
|
34799
|
-
'bridge_client_session_id',
|
|
34800
|
-
'bridge_client_session_token',
|
|
34801
|
-
'pairing_code',
|
|
34802
|
-
'pairing_code_expires_at',
|
|
34803
|
-
'tailscale_hostname',
|
|
34804
|
-
'tailscale_auth_key',
|
|
34805
|
-
'bridge_client_name',
|
|
34806
|
-
'bridge_client_time_zone',
|
|
34807
|
-
'bridge_client_machine_identifier_key',
|
|
34808
|
-
'errors',
|
|
34809
|
-
'telemetry_token',
|
|
34810
|
-
'telemetry_token_expires_at',
|
|
34811
|
-
'telemetry_url',
|
|
34812
|
-
],
|
|
34813
|
-
type: 'object',
|
|
34814
|
-
'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
|
|
34815
|
-
'x-undocumented': 'Seam Bridge Client only.',
|
|
34816
|
-
},
|
|
35061
|
+
magic_link: { $ref: '#/components/schemas/magic_link' },
|
|
34817
35062
|
ok: { type: 'boolean' },
|
|
34818
35063
|
},
|
|
34819
|
-
required: ['
|
|
35064
|
+
required: ['magic_link', 'ok'],
|
|
34820
35065
|
type: 'object',
|
|
34821
35066
|
},
|
|
34822
35067
|
},
|
|
@@ -34826,13 +35071,13 @@ export default {
|
|
|
34826
35071
|
400: { description: 'Bad Request' },
|
|
34827
35072
|
401: { description: 'Unauthorized' },
|
|
34828
35073
|
},
|
|
34829
|
-
security: [{
|
|
34830
|
-
summary: '/unstable_partner/building_blocks/
|
|
35074
|
+
security: [{ api_key: [] }],
|
|
35075
|
+
summary: '/unstable_partner/building_blocks/generate_magic_link',
|
|
34831
35076
|
tags: [],
|
|
34832
35077
|
'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
|
|
34833
|
-
'x-fern-sdk-method-name': '
|
|
34834
|
-
'x-fern-sdk-return-value': '
|
|
34835
|
-
'x-response-key': '
|
|
35078
|
+
'x-fern-sdk-method-name': 'generate_magic_link',
|
|
35079
|
+
'x-fern-sdk-return-value': 'magic_link',
|
|
35080
|
+
'x-response-key': 'magic_link',
|
|
34836
35081
|
'x-title': 'Generate a building block magic link',
|
|
34837
35082
|
'x-undocumented': 'Experimental partner building blocks.',
|
|
34838
35083
|
},
|
|
@@ -34869,6 +35114,8 @@ export default {
|
|
|
34869
35114
|
user_identity_key: { type: 'string' },
|
|
34870
35115
|
},
|
|
34871
35116
|
type: 'object',
|
|
35117
|
+
'x-route-path': '/unstable_partner/resources',
|
|
35118
|
+
'x-undocumented': 'Unreleased.',
|
|
34872
35119
|
},
|
|
34873
35120
|
type: 'array',
|
|
34874
35121
|
},
|
|
@@ -34894,6 +35141,8 @@ export default {
|
|
|
34894
35141
|
user_identity_key: { type: 'string' },
|
|
34895
35142
|
},
|
|
34896
35143
|
type: 'object',
|
|
35144
|
+
'x-route-path': '/unstable_partner/resources',
|
|
35145
|
+
'x-undocumented': 'Unreleased.',
|
|
34897
35146
|
},
|
|
34898
35147
|
],
|
|
34899
35148
|
},
|