@seamapi/types 1.406.7 → 1.406.9

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.
Files changed (33) hide show
  1. package/dist/connect.cjs +597 -79
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +695 -16
  4. package/lib/seam/connect/internal/schemas.d.ts +1 -1
  5. package/lib/seam/connect/internal/schemas.js +1 -1
  6. package/lib/seam/connect/internal/schemas.js.map +1 -1
  7. package/lib/seam/connect/models/acs/acs-access-group.d.ts +6 -0
  8. package/lib/seam/connect/models/acs/acs-access-group.js +5 -1
  9. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-encoder.d.ts +3 -0
  11. package/lib/seam/connect/models/acs/acs-encoder.js +4 -0
  12. package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
  13. package/lib/seam/connect/models/noise-sensors/noise-threshold.js +23 -7
  14. package/lib/seam/connect/models/noise-sensors/noise-threshold.js.map +1 -1
  15. package/lib/seam/connect/models/partner/magic-link.d.ts +5 -6
  16. package/lib/seam/connect/models/partner/magic-link.js +6 -2
  17. package/lib/seam/connect/models/partner/magic-link.js.map +1 -1
  18. package/lib/seam/connect/models/partner/resources.d.ts +16 -0
  19. package/lib/seam/connect/models/partner/resources.js +11 -0
  20. package/lib/seam/connect/models/partner/resources.js.map +1 -1
  21. package/lib/seam/connect/openapi.d.ts +521 -8
  22. package/lib/seam/connect/openapi.js +566 -61
  23. package/lib/seam/connect/openapi.js.map +1 -1
  24. package/lib/seam/connect/route-types.d.ts +165 -8
  25. package/package.json +1 -1
  26. package/src/lib/seam/connect/internal/schemas.ts +2 -0
  27. package/src/lib/seam/connect/models/acs/acs-access-group.ts +7 -1
  28. package/src/lib/seam/connect/models/acs/acs-encoder.ts +6 -0
  29. package/src/lib/seam/connect/models/noise-sensors/noise-threshold.ts +29 -7
  30. package/src/lib/seam/connect/models/partner/magic-link.ts +9 -2
  31. package/src/lib/seam/connect/models/partner/resources.ts +13 -0
  32. package/src/lib/seam/connect/openapi.ts +622 -61
  33. package/src/lib/seam/connect/route-types.ts +180 -8
@@ -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',
@@ -14522,11 +14534,10 @@ export default {
14522
14534
  magic_link: {
14523
14535
  properties: {
14524
14536
  building_block_type: {
14525
- enum: ['connect_account', 'manage_devices'],
14537
+ enum: ['connect_accounts', 'manage_devices', 'organize_spaces'],
14526
14538
  type: 'string',
14527
14539
  },
14528
14540
  created_at: { format: 'date-time', type: 'string' },
14529
- customer_id: { format: 'uuid', type: 'string' },
14530
14541
  customer_key: { type: 'string' },
14531
14542
  expires_at: { format: 'date-time', type: 'string' },
14532
14543
  url: { format: 'uri', type: 'string' },
@@ -14535,7 +14546,6 @@ export default {
14535
14546
  required: [
14536
14547
  'url',
14537
14548
  'building_block_type',
14538
- 'customer_id',
14539
14549
  'customer_key',
14540
14550
  'expires_at',
14541
14551
  'workspace_id',
@@ -14557,14 +14567,37 @@ export default {
14557
14567
  'x-route-path': '/networks',
14558
14568
  },
14559
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.',
14560
14571
  properties: {
14561
- device_id: { format: 'uuid', type: 'string' },
14562
- ends_daily_at: { type: 'string' },
14563
- name: { type: 'string' },
14564
- noise_threshold_decibels: { format: 'float', type: 'number' },
14565
- noise_threshold_id: { format: 'uuid', type: 'string' },
14566
- noise_threshold_nrs: { format: 'float', type: 'number' },
14567
- starts_daily_at: { type: 'string' },
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
+ },
14568
14601
  },
14569
14602
  required: [
14570
14603
  'noise_threshold_id',
@@ -16729,6 +16762,11 @@ export default {
16729
16762
  format: 'uuid',
16730
16763
  type: 'string',
16731
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
+ },
16732
16770
  created_at: {
16733
16771
  description: 'Date and time at which the access group was created.',
16734
16772
  format: 'date-time',
@@ -16788,6 +16826,7 @@ export default {
16788
16826
  'acs_access_group_id',
16789
16827
  'acs_system_id',
16790
16828
  'workspace_id',
16829
+ 'connected_account_id',
16791
16830
  'name',
16792
16831
  'access_group_type',
16793
16832
  'access_group_type_display_name',
@@ -18866,6 +18905,7 @@ export default {
18866
18905
  401: { description: 'Unauthorized' },
18867
18906
  },
18868
18907
  security: [
18908
+ { client_session_with_customer: [] },
18869
18909
  { client_session: [] },
18870
18910
  { pat_with_workspace: [] },
18871
18911
  { console_session_with_workspace: [] },
@@ -19177,6 +19217,7 @@ export default {
19177
19217
  },
19178
19218
  security: [
19179
19219
  { client_session: [] },
19220
+ { client_session_with_customer: [] },
19180
19221
  { pat_with_workspace: [] },
19181
19222
  { console_session_with_workspace: [] },
19182
19223
  { api_key: [] },
@@ -19300,6 +19341,7 @@ export default {
19300
19341
  { access_token: [] },
19301
19342
  { console_session_with_workspace: [] },
19302
19343
  { client_session: [] },
19344
+ { client_session_with_customer: [] },
19303
19345
  ],
19304
19346
  summary: '/access_codes/get',
19305
19347
  tags: ['/access_codes'],
@@ -19324,6 +19366,10 @@ export default {
19324
19366
  items: { format: 'uuid', type: 'string' },
19325
19367
  type: 'array',
19326
19368
  },
19369
+ customer_ids: {
19370
+ items: { format: 'uuid', type: 'string' },
19371
+ type: 'array',
19372
+ },
19327
19373
  device_id: {
19328
19374
  description: 'ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.',
19329
19375
  format: 'uuid',
@@ -19375,6 +19421,7 @@ export default {
19375
19421
  },
19376
19422
  security: [
19377
19423
  { client_session: [] },
19424
+ { client_session_with_customer: [] },
19378
19425
  { pat_with_workspace: [] },
19379
19426
  { console_session_with_workspace: [] },
19380
19427
  { api_key: [] },
@@ -25813,7 +25860,7 @@ export default {
25813
25860
  },
25814
25861
  '/connected_accounts/sync': {
25815
25862
  post: {
25816
- 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`.',
25817
25864
  operationId: 'connectedAccountsSyncPost',
25818
25865
  requestBody: {
25819
25866
  content: {
@@ -27970,6 +28017,7 @@ export default {
27970
28017
  },
27971
28018
  security: [
27972
28019
  { client_session: [] },
28020
+ { client_session_with_customer: [] },
27973
28021
  { pat_with_workspace: [] },
27974
28022
  { console_session_with_workspace: [] },
27975
28023
  { api_key: [] },
@@ -28151,6 +28199,7 @@ export default {
28151
28199
  },
28152
28200
  security: [
28153
28201
  { client_session: [] },
28202
+ { client_session_with_customer: [] },
28154
28203
  { pat_with_workspace: [] },
28155
28204
  { console_session_with_workspace: [] },
28156
28205
  { api_key: [] },
@@ -28260,6 +28309,7 @@ export default {
28260
28309
  },
28261
28310
  '/noise_sensors/list': {
28262
28311
  post: {
28312
+ description: 'Returns a list of all [noise sensors](https://docs.seam.co/latest/capability-guides/noise-sensors).',
28263
28313
  operationId: 'noiseSensorsListPost',
28264
28314
  requestBody: {
28265
28315
  content: {
@@ -28303,12 +28353,12 @@ export default {
28303
28353
  type: 'array',
28304
28354
  },
28305
28355
  device_type: {
28306
- description: 'Device type by which to filter devices.',
28356
+ description: 'Device type of the noise sensors that you want to list.',
28307
28357
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
28308
28358
  type: 'string',
28309
28359
  },
28310
28360
  device_types: {
28311
- description: 'Array of device types by which to filter devices.',
28361
+ description: 'Device types of the noise sensors that you want to list.',
28312
28362
  items: {
28313
28363
  description: 'Device type for noise sensors.\n ',
28314
28364
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
@@ -28363,7 +28413,7 @@ export default {
28363
28413
  type: 'number',
28364
28414
  },
28365
28415
  manufacturer: {
28366
- description: 'Manufacturer by which to filter devices.',
28416
+ description: 'Manufacturers of the noise sensors that you want to list.',
28367
28417
  enum: ['minut', 'noiseaware'],
28368
28418
  type: 'string',
28369
28419
  },
@@ -28427,23 +28477,50 @@ export default {
28427
28477
  'x-fern-sdk-method-name': 'list',
28428
28478
  'x-fern-sdk-return-value': 'devices',
28429
28479
  'x-response-key': 'devices',
28480
+ 'x-title': 'List Noise Sensors',
28430
28481
  },
28431
28482
  },
28432
28483
  '/noise_sensors/noise_thresholds/create': {
28433
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.',
28434
28486
  operationId: 'noiseSensorsNoiseThresholdsCreatePost',
28435
28487
  requestBody: {
28436
28488
  content: {
28437
28489
  'application/json': {
28438
28490
  schema: {
28439
28491
  properties: {
28440
- device_id: { format: 'uuid', type: 'string' },
28441
- ends_daily_at: { type: 'string' },
28442
- name: { type: 'string' },
28443
- noise_threshold_decibels: { format: 'float', type: 'number' },
28444
- noise_threshold_nrs: { format: 'float', type: 'number' },
28445
- starts_daily_at: { type: 'string' },
28446
- sync: { default: false, type: 'boolean' },
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
+ },
28447
28524
  },
28448
28525
  required: ['device_id', 'starts_daily_at', 'ends_daily_at'],
28449
28526
  type: 'object',
@@ -28487,19 +28564,33 @@ export default {
28487
28564
  'x-fern-sdk-method-name': 'create',
28488
28565
  'x-fern-sdk-return-value': 'noise_threshold',
28489
28566
  'x-response-key': 'noise_threshold',
28567
+ 'x-title': 'Create a Noise Threshold',
28490
28568
  },
28491
28569
  },
28492
28570
  '/noise_sensors/noise_thresholds/delete': {
28493
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).',
28494
28573
  operationId: 'noiseSensorsNoiseThresholdsDeletePost',
28495
28574
  requestBody: {
28496
28575
  content: {
28497
28576
  'application/json': {
28498
28577
  schema: {
28499
28578
  properties: {
28500
- device_id: { format: 'uuid', type: 'string' },
28501
- noise_threshold_id: { format: 'uuid', type: 'string' },
28502
- sync: { default: false, type: 'boolean' },
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
+ },
28503
28594
  },
28504
28595
  required: ['noise_threshold_id', 'device_id'],
28505
28596
  type: 'object',
@@ -28539,17 +28630,23 @@ export default {
28539
28630
  'x-fern-sdk-group-name': ['noise_sensors', 'noise_thresholds'],
28540
28631
  'x-fern-sdk-method-name': 'delete',
28541
28632
  'x-response-key': null,
28633
+ 'x-title': 'Delete a Noise Threshold',
28542
28634
  },
28543
28635
  },
28544
28636
  '/noise_sensors/noise_thresholds/get': {
28545
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).',
28546
28639
  operationId: 'noiseSensorsNoiseThresholdsGetPost',
28547
28640
  requestBody: {
28548
28641
  content: {
28549
28642
  'application/json': {
28550
28643
  schema: {
28551
28644
  properties: {
28552
- noise_threshold_id: { format: 'uuid', type: 'string' },
28645
+ noise_threshold_id: {
28646
+ description: 'ID of the noise threshold that you want to get.',
28647
+ format: 'uuid',
28648
+ type: 'string',
28649
+ },
28553
28650
  },
28554
28651
  required: ['noise_threshold_id'],
28555
28652
  type: 'object',
@@ -28589,18 +28686,28 @@ export default {
28589
28686
  'x-fern-sdk-method-name': 'get',
28590
28687
  'x-fern-sdk-return-value': 'noise_threshold',
28591
28688
  'x-response-key': 'noise_threshold',
28689
+ 'x-title': 'Get a Noise Threshold',
28592
28690
  },
28593
28691
  },
28594
28692
  '/noise_sensors/noise_thresholds/list': {
28595
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).',
28596
28695
  operationId: 'noiseSensorsNoiseThresholdsListPost',
28597
28696
  requestBody: {
28598
28697
  content: {
28599
28698
  'application/json': {
28600
28699
  schema: {
28601
28700
  properties: {
28602
- device_id: { format: 'uuid', type: 'string' },
28603
- is_programmed: { type: 'boolean' },
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
+ },
28604
28711
  },
28605
28712
  required: ['device_id'],
28606
28713
  type: 'object',
@@ -28642,24 +28749,55 @@ export default {
28642
28749
  'x-fern-sdk-method-name': 'list',
28643
28750
  'x-fern-sdk-return-value': 'noise_thresholds',
28644
28751
  'x-response-key': 'noise_thresholds',
28752
+ 'x-title': 'List Noise Thresholds',
28645
28753
  },
28646
28754
  },
28647
28755
  '/noise_sensors/noise_thresholds/update': {
28648
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).',
28649
28758
  operationId: 'noiseSensorsNoiseThresholdsUpdatePatch',
28650
28759
  requestBody: {
28651
28760
  content: {
28652
28761
  'application/json': {
28653
28762
  schema: {
28654
28763
  properties: {
28655
- device_id: { format: 'uuid', type: 'string' },
28656
- ends_daily_at: { type: 'string' },
28657
- name: { type: 'string' },
28658
- noise_threshold_decibels: { format: 'float', type: 'number' },
28659
- noise_threshold_id: { format: 'uuid', type: 'string' },
28660
- noise_threshold_nrs: { format: 'float', type: 'number' },
28661
- starts_daily_at: { type: 'string' },
28662
- sync: { default: false, type: 'boolean' },
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
+ },
28663
28801
  },
28664
28802
  required: ['noise_threshold_id', 'device_id'],
28665
28803
  type: 'object',
@@ -28698,22 +28836,53 @@ export default {
28698
28836
  'x-action-attempt-type': 'UPDATE_NOISE_THRESHOLD',
28699
28837
  'x-fern-ignore': true,
28700
28838
  'x-response-key': null,
28839
+ 'x-title': 'Update a Noise Threshold',
28701
28840
  },
28702
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).',
28703
28843
  operationId: 'noiseSensorsNoiseThresholdsUpdatePost',
28704
28844
  requestBody: {
28705
28845
  content: {
28706
28846
  'application/json': {
28707
28847
  schema: {
28708
28848
  properties: {
28709
- device_id: { format: 'uuid', type: 'string' },
28710
- ends_daily_at: { type: 'string' },
28711
- name: { type: 'string' },
28712
- noise_threshold_decibels: { format: 'float', type: 'number' },
28713
- noise_threshold_id: { format: 'uuid', type: 'string' },
28714
- noise_threshold_nrs: { format: 'float', type: 'number' },
28715
- starts_daily_at: { type: 'string' },
28716
- sync: { default: false, type: 'boolean' },
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
+ },
28717
28886
  },
28718
28887
  required: ['noise_threshold_id', 'device_id'],
28719
28888
  type: 'object',
@@ -28753,22 +28922,53 @@ export default {
28753
28922
  'x-fern-sdk-group-name': ['noise_sensors', 'noise_thresholds'],
28754
28923
  'x-fern-sdk-method-name': 'update',
28755
28924
  'x-response-key': null,
28925
+ 'x-title': 'Update a Noise Threshold',
28756
28926
  },
28757
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).',
28758
28929
  operationId: 'noiseSensorsNoiseThresholdsUpdatePut',
28759
28930
  requestBody: {
28760
28931
  content: {
28761
28932
  'application/json': {
28762
28933
  schema: {
28763
28934
  properties: {
28764
- device_id: { format: 'uuid', type: 'string' },
28765
- ends_daily_at: { type: 'string' },
28766
- name: { type: 'string' },
28767
- noise_threshold_decibels: { format: 'float', type: 'number' },
28768
- noise_threshold_id: { format: 'uuid', type: 'string' },
28769
- noise_threshold_nrs: { format: 'float', type: 'number' },
28770
- starts_daily_at: { type: 'string' },
28771
- sync: { default: false, type: 'boolean' },
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
+ },
28772
28972
  },
28773
28973
  required: ['noise_threshold_id', 'device_id'],
28774
28974
  type: 'object',
@@ -28807,16 +29007,24 @@ export default {
28807
29007
  'x-action-attempt-type': 'UPDATE_NOISE_THRESHOLD',
28808
29008
  'x-fern-ignore': true,
28809
29009
  'x-response-key': null,
29010
+ 'x-title': 'Update a Noise Threshold',
28810
29011
  },
28811
29012
  },
28812
29013
  '/noise_sensors/simulate/trigger_noise_threshold': {
28813
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).',
28814
29016
  operationId: 'noiseSensorsSimulateTriggerNoiseThresholdPost',
28815
29017
  requestBody: {
28816
29018
  content: {
28817
29019
  'application/json': {
28818
29020
  schema: {
28819
- properties: { device_id: { format: 'uuid', type: 'string' } },
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
+ },
28820
29028
  required: ['device_id'],
28821
29029
  type: 'object',
28822
29030
  },
@@ -28849,6 +29057,7 @@ export default {
28849
29057
  'x-fern-sdk-group-name': ['noise_sensors', 'simulate'],
28850
29058
  'x-fern-sdk-method-name': 'trigger_noise_threshold',
28851
29059
  'x-response-key': null,
29060
+ 'x-title': 'Simulate Triggering a Noise Threshold',
28852
29061
  },
28853
29062
  },
28854
29063
  '/phones/deactivate': {
@@ -30358,6 +30567,99 @@ export default {
30358
30567
  'x-undocumented': 'Mobile SDK only.',
30359
30568
  },
30360
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
+ },
30361
30663
  '/seam/partner/v1/resources/list': {
30362
30664
  post: {
30363
30665
  description: 'List partner resources that have been pushed to Seam.',
@@ -34680,6 +34982,55 @@ export default {
34680
34982
  'x-undocumented': 'Experimental locations.',
34681
34983
  },
34682
34984
  },
34985
+ '/unstable_partner/building_blocks/connect_accounts': {
34986
+ post: {
34987
+ description: 'Creates a new building block magic link to connect accounts.',
34988
+ operationId: 'unstablePartnerBuildingBlocksConnectAccountsPost',
34989
+ requestBody: {
34990
+ content: {
34991
+ 'application/json': {
34992
+ schema: {
34993
+ properties: { customer_key: { type: 'string' } },
34994
+ required: ['customer_key'],
34995
+ type: 'object',
34996
+ },
34997
+ },
34998
+ },
34999
+ },
35000
+ responses: {
35001
+ 200: {
35002
+ content: {
35003
+ 'application/json': {
35004
+ schema: {
35005
+ properties: {
35006
+ magic_link: { $ref: '#/components/schemas/magic_link' },
35007
+ ok: { type: 'boolean' },
35008
+ },
35009
+ required: ['magic_link', 'ok'],
35010
+ type: 'object',
35011
+ },
35012
+ },
35013
+ },
35014
+ description: 'OK',
35015
+ },
35016
+ 400: { description: 'Bad Request' },
35017
+ 401: { description: 'Unauthorized' },
35018
+ },
35019
+ security: [
35020
+ { pat_with_workspace: [] },
35021
+ { console_session_with_workspace: [] },
35022
+ { api_key: [] },
35023
+ ],
35024
+ summary: '/unstable_partner/building_blocks/connect_accounts',
35025
+ tags: [],
35026
+ 'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
35027
+ 'x-fern-sdk-method-name': 'connect_accounts',
35028
+ 'x-fern-sdk-return-value': 'magic_link',
35029
+ 'x-response-key': 'magic_link',
35030
+ 'x-title': 'Connect Accounts',
35031
+ 'x-undocumented': 'Experimental partner building blocks.',
35032
+ },
35033
+ },
34683
35034
  '/unstable_partner/building_blocks/generate_magic_link': {
34684
35035
  post: {
34685
35036
  description: 'Creates a new building block magic link.',
@@ -34688,15 +35039,46 @@ export default {
34688
35039
  content: {
34689
35040
  'application/json': {
34690
35041
  schema: {
34691
- properties: {
34692
- building_block_type: {
34693
- enum: ['connect_account', 'manage_devices'],
34694
- type: 'string',
35042
+ oneOf: [
35043
+ {
35044
+ properties: {
35045
+ building_block_type: {
35046
+ enum: ['connect_accounts'],
35047
+ type: 'string',
35048
+ },
35049
+ customer_key: { type: 'string' },
35050
+ },
35051
+ required: ['building_block_type', 'customer_key'],
35052
+ type: 'object',
34695
35053
  },
34696
- customer_key: { type: 'string' },
34697
- },
34698
- required: ['building_block_type', 'customer_key'],
34699
- type: 'object',
35054
+ {
35055
+ properties: {
35056
+ building_block_type: {
35057
+ enum: ['manage_devices'],
35058
+ type: 'string',
35059
+ },
35060
+ customer_key: { type: 'string' },
35061
+ },
35062
+ required: ['building_block_type', 'customer_key'],
35063
+ type: 'object',
35064
+ },
35065
+ {
35066
+ properties: {
35067
+ building_block_type: {
35068
+ enum: ['organize_spaces'],
35069
+ type: 'string',
35070
+ },
35071
+ collection_key: { type: 'string' },
35072
+ customer_key: { type: 'string' },
35073
+ },
35074
+ required: [
35075
+ 'building_block_type',
35076
+ 'customer_key',
35077
+ 'collection_key',
35078
+ ],
35079
+ type: 'object',
35080
+ },
35081
+ ],
34700
35082
  },
34701
35083
  },
34702
35084
  },
@@ -34720,7 +35102,11 @@ export default {
34720
35102
  400: { description: 'Bad Request' },
34721
35103
  401: { description: 'Unauthorized' },
34722
35104
  },
34723
- security: [{ api_key: [] }],
35105
+ security: [
35106
+ { pat_with_workspace: [] },
35107
+ { console_session_with_workspace: [] },
35108
+ { api_key: [] },
35109
+ ],
34724
35110
  summary: '/unstable_partner/building_blocks/generate_magic_link',
34725
35111
  tags: [],
34726
35112
  'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
@@ -34731,6 +35117,125 @@ export default {
34731
35117
  'x-undocumented': 'Experimental partner building blocks.',
34732
35118
  },
34733
35119
  },
35120
+ '/unstable_partner/building_blocks/manage_devices': {
35121
+ post: {
35122
+ description: 'Creates a new building block magic link to manage devices.',
35123
+ operationId: 'unstablePartnerBuildingBlocksManageDevicesPost',
35124
+ requestBody: {
35125
+ content: {
35126
+ 'application/json': {
35127
+ schema: {
35128
+ properties: { customer_key: { type: 'string' } },
35129
+ required: ['customer_key'],
35130
+ type: 'object',
35131
+ },
35132
+ },
35133
+ },
35134
+ },
35135
+ responses: {
35136
+ 200: {
35137
+ content: {
35138
+ 'application/json': {
35139
+ schema: {
35140
+ properties: {
35141
+ magic_link: { $ref: '#/components/schemas/magic_link' },
35142
+ ok: { type: 'boolean' },
35143
+ },
35144
+ required: ['magic_link', 'ok'],
35145
+ type: 'object',
35146
+ },
35147
+ },
35148
+ },
35149
+ description: 'OK',
35150
+ },
35151
+ 400: { description: 'Bad Request' },
35152
+ 401: { description: 'Unauthorized' },
35153
+ },
35154
+ security: [
35155
+ { pat_with_workspace: [] },
35156
+ { console_session_with_workspace: [] },
35157
+ { api_key: [] },
35158
+ ],
35159
+ summary: '/unstable_partner/building_blocks/manage_devices',
35160
+ tags: [],
35161
+ 'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
35162
+ 'x-fern-sdk-method-name': 'manage_devices',
35163
+ 'x-fern-sdk-return-value': 'magic_link',
35164
+ 'x-response-key': 'magic_link',
35165
+ 'x-title': 'Manage Devices',
35166
+ 'x-undocumented': 'Experimental partner building blocks.',
35167
+ },
35168
+ },
35169
+ '/unstable_partner/building_blocks/organize_spaces': {
35170
+ post: {
35171
+ description: 'Creates a new building block magic link to organize spaces.',
35172
+ operationId: 'unstablePartnerBuildingBlocksOrganizeSpacesPost',
35173
+ requestBody: {
35174
+ content: {
35175
+ 'application/json': {
35176
+ schema: {
35177
+ properties: {
35178
+ customer_key: { type: 'string' },
35179
+ partner_resources: {
35180
+ items: {
35181
+ properties: {
35182
+ custom_metadata: {
35183
+ additionalProperties: { type: 'string' },
35184
+ type: 'object',
35185
+ },
35186
+ description: { type: 'string' },
35187
+ name: { type: 'string' },
35188
+ partner_resource_key: { type: 'string' },
35189
+ },
35190
+ required: ['partner_resource_key', 'name'],
35191
+ type: 'object',
35192
+ 'x-route-path': '/unstable_partner/resources',
35193
+ 'x-undocumented': 'Unreleased.',
35194
+ },
35195
+ minItems: 1,
35196
+ type: 'array',
35197
+ },
35198
+ },
35199
+ required: ['customer_key', 'partner_resources'],
35200
+ type: 'object',
35201
+ },
35202
+ },
35203
+ },
35204
+ },
35205
+ responses: {
35206
+ 200: {
35207
+ content: {
35208
+ 'application/json': {
35209
+ schema: {
35210
+ properties: {
35211
+ magic_link: { $ref: '#/components/schemas/magic_link' },
35212
+ ok: { type: 'boolean' },
35213
+ },
35214
+ required: ['magic_link', 'ok'],
35215
+ type: 'object',
35216
+ },
35217
+ },
35218
+ },
35219
+ description: 'OK',
35220
+ },
35221
+ 400: { description: 'Bad Request' },
35222
+ 401: { description: 'Unauthorized' },
35223
+ },
35224
+ security: [
35225
+ { pat_with_workspace: [] },
35226
+ { console_session_with_workspace: [] },
35227
+ { api_key: [] },
35228
+ ],
35229
+ summary: '/unstable_partner/building_blocks/organize_spaces',
35230
+ tags: [],
35231
+ 'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
35232
+ 'x-fern-sdk-method-name': 'organize_spaces',
35233
+ 'x-fern-sdk-return-value': 'magic_link',
35234
+ 'x-response-key': 'magic_link',
35235
+ 'x-title': 'Organize Spaces',
35236
+ 'x-undocumented': 'Experimental partner building blocks.',
35237
+ },
35238
+ },
34734
35239
  '/unstable_partner/resources/push': {
34735
35240
  post: {
34736
35241
  description: 'Send Seam some of your resources.',