@seamapi/types 1.406.7 → 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.
Files changed (33) hide show
  1. package/dist/connect.cjs +442 -78
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +418 -21
  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 +3 -6
  16. package/lib/seam/connect/models/partner/magic-link.js +5 -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 +308 -13
  22. package/lib/seam/connect/openapi.js +411 -60
  23. package/lib/seam/connect/openapi.js.map +1 -1
  24. package/lib/seam/connect/route-types.d.ts +101 -8
  25. package/package.json +1 -1
  26. package/src/lib/seam/connect/internal/schemas.ts +1 -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 +5 -2
  31. package/src/lib/seam/connect/models/partner/resources.ts +13 -0
  32. package/src/lib/seam/connect/openapi.ts +464 -60
  33. package/src/lib/seam/connect/route-types.ts +110 -11
@@ -1594,6 +1594,12 @@ export default {
1594
1594
  format: 'uuid',
1595
1595
  type: 'string',
1596
1596
  },
1597
+ connected_account_id: {
1598
+ description:
1599
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group.',
1600
+ format: 'uuid',
1601
+ type: 'string',
1602
+ },
1597
1603
  created_at: {
1598
1604
  description: 'Date and time at which the access group was created.',
1599
1605
  format: 'date-time',
@@ -1659,6 +1665,7 @@ export default {
1659
1665
  'acs_access_group_id',
1660
1666
  'acs_system_id',
1661
1667
  'workspace_id',
1668
+ 'connected_account_id',
1662
1669
  'name',
1663
1670
  'access_group_type',
1664
1671
  'access_group_type_display_name',
@@ -2093,6 +2100,12 @@ export default {
2093
2100
  format: 'uuid',
2094
2101
  type: 'string',
2095
2102
  },
2103
+ connected_account_id: {
2104
+ description:
2105
+ '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).',
2106
+ format: 'uuid',
2107
+ type: 'string',
2108
+ },
2096
2109
  created_at: {
2097
2110
  description:
2098
2111
  'Date and time at which the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was created.',
@@ -2143,6 +2156,7 @@ export default {
2143
2156
  required: [
2144
2157
  'acs_encoder_id',
2145
2158
  'acs_system_id',
2159
+ 'connected_account_id',
2146
2160
  'workspace_id',
2147
2161
  'errors',
2148
2162
  'created_at',
@@ -15903,11 +15917,10 @@ export default {
15903
15917
  magic_link: {
15904
15918
  properties: {
15905
15919
  building_block_type: {
15906
- enum: ['connect_account', 'manage_devices'],
15920
+ enum: ['connect_account', 'manage_devices', 'organize_spaces'],
15907
15921
  type: 'string',
15908
15922
  },
15909
15923
  created_at: { format: 'date-time', type: 'string' },
15910
- customer_id: { format: 'uuid', type: 'string' },
15911
15924
  customer_key: { type: 'string' },
15912
15925
  expires_at: { format: 'date-time', type: 'string' },
15913
15926
  url: { format: 'uri', type: 'string' },
@@ -15916,7 +15929,6 @@ export default {
15916
15929
  required: [
15917
15930
  'url',
15918
15931
  'building_block_type',
15919
- 'customer_id',
15920
15932
  'customer_key',
15921
15933
  'expires_at',
15922
15934
  'workspace_id',
@@ -15938,14 +15950,42 @@ export default {
15938
15950
  'x-route-path': '/networks',
15939
15951
  },
15940
15952
  noise_threshold: {
15953
+ description:
15954
+ '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.',
15941
15955
  properties: {
15942
- device_id: { format: 'uuid', type: 'string' },
15943
- ends_daily_at: { type: 'string' },
15944
- name: { type: 'string' },
15945
- noise_threshold_decibels: { format: 'float', type: 'number' },
15946
- noise_threshold_id: { format: 'uuid', type: 'string' },
15947
- noise_threshold_nrs: { format: 'float', type: 'number' },
15948
- starts_daily_at: { type: 'string' },
15956
+ device_id: {
15957
+ description:
15958
+ 'Unique identifier for the device that contains the noise threshold.',
15959
+ format: 'uuid',
15960
+ type: 'string',
15961
+ },
15962
+ ends_daily_at: {
15963
+ description:
15964
+ 'Time at which the noise threshold should become inactive daily.',
15965
+ type: 'string',
15966
+ },
15967
+ name: { description: 'Name of the noise threshold.', type: 'string' },
15968
+ noise_threshold_decibels: {
15969
+ description: 'Noise level in decibels for the noise threshold.',
15970
+ format: 'float',
15971
+ type: 'number',
15972
+ },
15973
+ noise_threshold_id: {
15974
+ description: 'Unique identifier for the noise threshold.',
15975
+ format: 'uuid',
15976
+ type: 'string',
15977
+ },
15978
+ noise_threshold_nrs: {
15979
+ description:
15980
+ '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).',
15981
+ format: 'float',
15982
+ type: 'number',
15983
+ },
15984
+ starts_daily_at: {
15985
+ description:
15986
+ 'Time at which the noise threshold should become active daily.',
15987
+ type: 'string',
15988
+ },
15949
15989
  },
15950
15990
  required: [
15951
15991
  'noise_threshold_id',
@@ -18384,6 +18424,12 @@ export default {
18384
18424
  format: 'uuid',
18385
18425
  type: 'string',
18386
18426
  },
18427
+ connected_account_id: {
18428
+ description:
18429
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group.',
18430
+ format: 'uuid',
18431
+ type: 'string',
18432
+ },
18387
18433
  created_at: {
18388
18434
  description: 'Date and time at which the access group was created.',
18389
18435
  format: 'date-time',
@@ -18449,6 +18495,7 @@ export default {
18449
18495
  'acs_access_group_id',
18450
18496
  'acs_system_id',
18451
18497
  'workspace_id',
18498
+ 'connected_account_id',
18452
18499
  'name',
18453
18500
  'access_group_type',
18454
18501
  'access_group_type_display_name',
@@ -20734,6 +20781,7 @@ export default {
20734
20781
  401: { description: 'Unauthorized' },
20735
20782
  },
20736
20783
  security: [
20784
+ { client_session_with_customer: [] },
20737
20785
  { client_session: [] },
20738
20786
  { pat_with_workspace: [] },
20739
20787
  { console_session_with_workspace: [] },
@@ -21076,6 +21124,7 @@ export default {
21076
21124
  },
21077
21125
  security: [
21078
21126
  { client_session: [] },
21127
+ { client_session_with_customer: [] },
21079
21128
  { pat_with_workspace: [] },
21080
21129
  { console_session_with_workspace: [] },
21081
21130
  { api_key: [] },
@@ -21205,6 +21254,7 @@ export default {
21205
21254
  { access_token: [] },
21206
21255
  { console_session_with_workspace: [] },
21207
21256
  { client_session: [] },
21257
+ { client_session_with_customer: [] },
21208
21258
  ],
21209
21259
  summary: '/access_codes/get',
21210
21260
  tags: ['/access_codes'],
@@ -21231,6 +21281,10 @@ export default {
21231
21281
  items: { format: 'uuid', type: 'string' },
21232
21282
  type: 'array',
21233
21283
  },
21284
+ customer_ids: {
21285
+ items: { format: 'uuid', type: 'string' },
21286
+ type: 'array',
21287
+ },
21234
21288
  device_id: {
21235
21289
  description:
21236
21290
  'ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.',
@@ -21286,6 +21340,7 @@ export default {
21286
21340
  },
21287
21341
  security: [
21288
21342
  { client_session: [] },
21343
+ { client_session_with_customer: [] },
21289
21344
  { pat_with_workspace: [] },
21290
21345
  { console_session_with_workspace: [] },
21291
21346
  { api_key: [] },
@@ -28130,7 +28185,7 @@ export default {
28130
28185
  '/connected_accounts/sync': {
28131
28186
  post: {
28132
28187
  description:
28133
- 'Request a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) sync attempt for the specified connected_account_id.',
28188
+ 'Request a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`.',
28134
28189
  operationId: 'connectedAccountsSyncPost',
28135
28190
  requestBody: {
28136
28191
  content: {
@@ -30387,6 +30442,7 @@ export default {
30387
30442
  },
30388
30443
  security: [
30389
30444
  { client_session: [] },
30445
+ { client_session_with_customer: [] },
30390
30446
  { pat_with_workspace: [] },
30391
30447
  { console_session_with_workspace: [] },
30392
30448
  { api_key: [] },
@@ -30574,6 +30630,7 @@ export default {
30574
30630
  },
30575
30631
  security: [
30576
30632
  { client_session: [] },
30633
+ { client_session_with_customer: [] },
30577
30634
  { pat_with_workspace: [] },
30578
30635
  { console_session_with_workspace: [] },
30579
30636
  { api_key: [] },
@@ -30683,6 +30740,8 @@ export default {
30683
30740
  },
30684
30741
  '/noise_sensors/list': {
30685
30742
  post: {
30743
+ description:
30744
+ 'Returns a list of all [noise sensors](https://docs.seam.co/latest/capability-guides/noise-sensors).',
30686
30745
  operationId: 'noiseSensorsListPost',
30687
30746
  requestBody: {
30688
30747
  content: {
@@ -30732,13 +30791,14 @@ export default {
30732
30791
  type: 'array',
30733
30792
  },
30734
30793
  device_type: {
30735
- description: 'Device type by which to filter devices.',
30794
+ description:
30795
+ 'Device type of the noise sensors that you want to list.',
30736
30796
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
30737
30797
  type: 'string',
30738
30798
  },
30739
30799
  device_types: {
30740
30800
  description:
30741
- 'Array of device types by which to filter devices.',
30801
+ 'Device types of the noise sensors that you want to list.',
30742
30802
  items: {
30743
30803
  description: 'Device type for noise sensors.\n ',
30744
30804
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
@@ -30794,7 +30854,8 @@ export default {
30794
30854
  type: 'number',
30795
30855
  },
30796
30856
  manufacturer: {
30797
- description: 'Manufacturer by which to filter devices.',
30857
+ description:
30858
+ 'Manufacturers of the noise sensors that you want to list.',
30798
30859
  enum: ['minut', 'noiseaware'],
30799
30860
  type: 'string',
30800
30861
  },
@@ -30861,23 +30922,56 @@ export default {
30861
30922
  'x-fern-sdk-method-name': 'list',
30862
30923
  'x-fern-sdk-return-value': 'devices',
30863
30924
  'x-response-key': 'devices',
30925
+ 'x-title': 'List Noise Sensors',
30864
30926
  },
30865
30927
  },
30866
30928
  '/noise_sensors/noise_thresholds/create': {
30867
30929
  post: {
30930
+ description:
30931
+ '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.',
30868
30932
  operationId: 'noiseSensorsNoiseThresholdsCreatePost',
30869
30933
  requestBody: {
30870
30934
  content: {
30871
30935
  'application/json': {
30872
30936
  schema: {
30873
30937
  properties: {
30874
- device_id: { format: 'uuid', type: 'string' },
30875
- ends_daily_at: { type: 'string' },
30876
- name: { type: 'string' },
30877
- noise_threshold_decibels: { format: 'float', type: 'number' },
30878
- noise_threshold_nrs: { format: 'float', type: 'number' },
30879
- starts_daily_at: { type: 'string' },
30880
- sync: { default: false, type: 'boolean' },
30938
+ device_id: {
30939
+ description:
30940
+ 'ID of the device for which you want to create a noise threshold.',
30941
+ format: 'uuid',
30942
+ type: 'string',
30943
+ },
30944
+ ends_daily_at: {
30945
+ description:
30946
+ 'Time at which the new noise threshold should become inactive daily.',
30947
+ type: 'string',
30948
+ },
30949
+ name: {
30950
+ description: 'Name of the new noise threshold.',
30951
+ type: 'string',
30952
+ },
30953
+ noise_threshold_decibels: {
30954
+ description:
30955
+ 'Noise level in decibels for the new noise threshold.',
30956
+ format: 'float',
30957
+ type: 'number',
30958
+ },
30959
+ noise_threshold_nrs: {
30960
+ description:
30961
+ '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).',
30962
+ format: 'float',
30963
+ type: 'number',
30964
+ },
30965
+ starts_daily_at: {
30966
+ description:
30967
+ 'Time at which the new noise threshold should become active daily.',
30968
+ type: 'string',
30969
+ },
30970
+ sync: {
30971
+ default: false,
30972
+ type: 'boolean',
30973
+ 'x-undocumented': 'Only used internally.',
30974
+ },
30881
30975
  },
30882
30976
  required: ['device_id', 'starts_daily_at', 'ends_daily_at'],
30883
30977
  type: 'object',
@@ -30921,19 +31015,36 @@ export default {
30921
31015
  'x-fern-sdk-method-name': 'create',
30922
31016
  'x-fern-sdk-return-value': 'noise_threshold',
30923
31017
  'x-response-key': 'noise_threshold',
31018
+ 'x-title': 'Create a Noise Threshold',
30924
31019
  },
30925
31020
  },
30926
31021
  '/noise_sensors/noise_thresholds/delete': {
30927
31022
  post: {
31023
+ description:
31024
+ '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).',
30928
31025
  operationId: 'noiseSensorsNoiseThresholdsDeletePost',
30929
31026
  requestBody: {
30930
31027
  content: {
30931
31028
  'application/json': {
30932
31029
  schema: {
30933
31030
  properties: {
30934
- device_id: { format: 'uuid', type: 'string' },
30935
- noise_threshold_id: { format: 'uuid', type: 'string' },
30936
- sync: { default: false, type: 'boolean' },
31031
+ device_id: {
31032
+ description:
31033
+ 'ID of the device that contains the noise threshold that you want to delete.',
31034
+ format: 'uuid',
31035
+ type: 'string',
31036
+ },
31037
+ noise_threshold_id: {
31038
+ description:
31039
+ 'ID of the noise threshold that you want to delete.',
31040
+ format: 'uuid',
31041
+ type: 'string',
31042
+ },
31043
+ sync: {
31044
+ default: false,
31045
+ type: 'boolean',
31046
+ 'x-undocumented': 'Only used internally.',
31047
+ },
30937
31048
  },
30938
31049
  required: ['noise_threshold_id', 'device_id'],
30939
31050
  type: 'object',
@@ -30973,17 +31084,25 @@ export default {
30973
31084
  'x-fern-sdk-group-name': ['noise_sensors', 'noise_thresholds'],
30974
31085
  'x-fern-sdk-method-name': 'delete',
30975
31086
  'x-response-key': null,
31087
+ 'x-title': 'Delete a Noise Threshold',
30976
31088
  },
30977
31089
  },
30978
31090
  '/noise_sensors/noise_thresholds/get': {
30979
31091
  post: {
31092
+ description:
31093
+ '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).',
30980
31094
  operationId: 'noiseSensorsNoiseThresholdsGetPost',
30981
31095
  requestBody: {
30982
31096
  content: {
30983
31097
  'application/json': {
30984
31098
  schema: {
30985
31099
  properties: {
30986
- noise_threshold_id: { format: 'uuid', type: 'string' },
31100
+ noise_threshold_id: {
31101
+ description:
31102
+ 'ID of the noise threshold that you want to get.',
31103
+ format: 'uuid',
31104
+ type: 'string',
31105
+ },
30987
31106
  },
30988
31107
  required: ['noise_threshold_id'],
30989
31108
  type: 'object',
@@ -31023,18 +31142,32 @@ export default {
31023
31142
  'x-fern-sdk-method-name': 'get',
31024
31143
  'x-fern-sdk-return-value': 'noise_threshold',
31025
31144
  'x-response-key': 'noise_threshold',
31145
+ 'x-title': 'Get a Noise Threshold',
31026
31146
  },
31027
31147
  },
31028
31148
  '/noise_sensors/noise_thresholds/list': {
31029
31149
  post: {
31150
+ description:
31151
+ '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).',
31030
31152
  operationId: 'noiseSensorsNoiseThresholdsListPost',
31031
31153
  requestBody: {
31032
31154
  content: {
31033
31155
  'application/json': {
31034
31156
  schema: {
31035
31157
  properties: {
31036
- device_id: { format: 'uuid', type: 'string' },
31037
- is_programmed: { type: 'boolean' },
31158
+ device_id: {
31159
+ description:
31160
+ 'ID of the device for which you want to list noise thresholds.',
31161
+ format: 'uuid',
31162
+ type: 'string',
31163
+ },
31164
+ is_programmed: {
31165
+ description:
31166
+ '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`.',
31167
+ type: 'boolean',
31168
+ 'x-undocumented':
31169
+ 'Not sure if this parameter is supported or what it does.',
31170
+ },
31038
31171
  },
31039
31172
  required: ['device_id'],
31040
31173
  type: 'object',
@@ -31076,24 +31209,63 @@ export default {
31076
31209
  'x-fern-sdk-method-name': 'list',
31077
31210
  'x-fern-sdk-return-value': 'noise_thresholds',
31078
31211
  'x-response-key': 'noise_thresholds',
31212
+ 'x-title': 'List Noise Thresholds',
31079
31213
  },
31080
31214
  },
31081
31215
  '/noise_sensors/noise_thresholds/update': {
31082
31216
  patch: {
31217
+ description:
31218
+ '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).',
31083
31219
  operationId: 'noiseSensorsNoiseThresholdsUpdatePatch',
31084
31220
  requestBody: {
31085
31221
  content: {
31086
31222
  'application/json': {
31087
31223
  schema: {
31088
31224
  properties: {
31089
- device_id: { format: 'uuid', type: 'string' },
31090
- ends_daily_at: { type: 'string' },
31091
- name: { type: 'string' },
31092
- noise_threshold_decibels: { format: 'float', type: 'number' },
31093
- noise_threshold_id: { format: 'uuid', type: 'string' },
31094
- noise_threshold_nrs: { format: 'float', type: 'number' },
31095
- starts_daily_at: { type: 'string' },
31096
- sync: { default: false, type: 'boolean' },
31225
+ device_id: {
31226
+ description:
31227
+ 'ID of the device that contains the noise threshold that you want to update.',
31228
+ format: 'uuid',
31229
+ type: 'string',
31230
+ },
31231
+ ends_daily_at: {
31232
+ description:
31233
+ 'Time at which the noise threshold should become inactive daily.',
31234
+ type: 'string',
31235
+ },
31236
+ name: {
31237
+ description:
31238
+ 'Name of the noise threshold that you want to update.',
31239
+ type: 'string',
31240
+ },
31241
+ noise_threshold_decibels: {
31242
+ description:
31243
+ 'Noise level in decibels for the noise threshold.',
31244
+ format: 'float',
31245
+ type: 'number',
31246
+ },
31247
+ noise_threshold_id: {
31248
+ description:
31249
+ 'ID of the noise threshold that you want to update.',
31250
+ format: 'uuid',
31251
+ type: 'string',
31252
+ },
31253
+ noise_threshold_nrs: {
31254
+ description:
31255
+ '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).',
31256
+ format: 'float',
31257
+ type: 'number',
31258
+ },
31259
+ starts_daily_at: {
31260
+ description:
31261
+ 'Time at which the noise threshold should become active daily.',
31262
+ type: 'string',
31263
+ },
31264
+ sync: {
31265
+ default: false,
31266
+ type: 'boolean',
31267
+ 'x-undocumented': 'Only used internally.',
31268
+ },
31097
31269
  },
31098
31270
  required: ['noise_threshold_id', 'device_id'],
31099
31271
  type: 'object',
@@ -31132,22 +31304,61 @@ export default {
31132
31304
  'x-action-attempt-type': 'UPDATE_NOISE_THRESHOLD',
31133
31305
  'x-fern-ignore': true,
31134
31306
  'x-response-key': null,
31307
+ 'x-title': 'Update a Noise Threshold',
31135
31308
  },
31136
31309
  post: {
31310
+ description:
31311
+ '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).',
31137
31312
  operationId: 'noiseSensorsNoiseThresholdsUpdatePost',
31138
31313
  requestBody: {
31139
31314
  content: {
31140
31315
  'application/json': {
31141
31316
  schema: {
31142
31317
  properties: {
31143
- device_id: { format: 'uuid', type: 'string' },
31144
- ends_daily_at: { type: 'string' },
31145
- name: { type: 'string' },
31146
- noise_threshold_decibels: { format: 'float', type: 'number' },
31147
- noise_threshold_id: { format: 'uuid', type: 'string' },
31148
- noise_threshold_nrs: { format: 'float', type: 'number' },
31149
- starts_daily_at: { type: 'string' },
31150
- sync: { default: false, type: 'boolean' },
31318
+ device_id: {
31319
+ description:
31320
+ 'ID of the device that contains the noise threshold that you want to update.',
31321
+ format: 'uuid',
31322
+ type: 'string',
31323
+ },
31324
+ ends_daily_at: {
31325
+ description:
31326
+ 'Time at which the noise threshold should become inactive daily.',
31327
+ type: 'string',
31328
+ },
31329
+ name: {
31330
+ description:
31331
+ 'Name of the noise threshold that you want to update.',
31332
+ type: 'string',
31333
+ },
31334
+ noise_threshold_decibels: {
31335
+ description:
31336
+ 'Noise level in decibels for the noise threshold.',
31337
+ format: 'float',
31338
+ type: 'number',
31339
+ },
31340
+ noise_threshold_id: {
31341
+ description:
31342
+ 'ID of the noise threshold that you want to update.',
31343
+ format: 'uuid',
31344
+ type: 'string',
31345
+ },
31346
+ noise_threshold_nrs: {
31347
+ description:
31348
+ '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).',
31349
+ format: 'float',
31350
+ type: 'number',
31351
+ },
31352
+ starts_daily_at: {
31353
+ description:
31354
+ 'Time at which the noise threshold should become active daily.',
31355
+ type: 'string',
31356
+ },
31357
+ sync: {
31358
+ default: false,
31359
+ type: 'boolean',
31360
+ 'x-undocumented': 'Only used internally.',
31361
+ },
31151
31362
  },
31152
31363
  required: ['noise_threshold_id', 'device_id'],
31153
31364
  type: 'object',
@@ -31187,22 +31398,61 @@ export default {
31187
31398
  'x-fern-sdk-group-name': ['noise_sensors', 'noise_thresholds'],
31188
31399
  'x-fern-sdk-method-name': 'update',
31189
31400
  'x-response-key': null,
31401
+ 'x-title': 'Update a Noise Threshold',
31190
31402
  },
31191
31403
  put: {
31404
+ description:
31405
+ '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).',
31192
31406
  operationId: 'noiseSensorsNoiseThresholdsUpdatePut',
31193
31407
  requestBody: {
31194
31408
  content: {
31195
31409
  'application/json': {
31196
31410
  schema: {
31197
31411
  properties: {
31198
- device_id: { format: 'uuid', type: 'string' },
31199
- ends_daily_at: { type: 'string' },
31200
- name: { type: 'string' },
31201
- noise_threshold_decibels: { format: 'float', type: 'number' },
31202
- noise_threshold_id: { format: 'uuid', type: 'string' },
31203
- noise_threshold_nrs: { format: 'float', type: 'number' },
31204
- starts_daily_at: { type: 'string' },
31205
- sync: { default: false, type: 'boolean' },
31412
+ device_id: {
31413
+ description:
31414
+ 'ID of the device that contains the noise threshold that you want to update.',
31415
+ format: 'uuid',
31416
+ type: 'string',
31417
+ },
31418
+ ends_daily_at: {
31419
+ description:
31420
+ 'Time at which the noise threshold should become inactive daily.',
31421
+ type: 'string',
31422
+ },
31423
+ name: {
31424
+ description:
31425
+ 'Name of the noise threshold that you want to update.',
31426
+ type: 'string',
31427
+ },
31428
+ noise_threshold_decibels: {
31429
+ description:
31430
+ 'Noise level in decibels for the noise threshold.',
31431
+ format: 'float',
31432
+ type: 'number',
31433
+ },
31434
+ noise_threshold_id: {
31435
+ description:
31436
+ 'ID of the noise threshold that you want to update.',
31437
+ format: 'uuid',
31438
+ type: 'string',
31439
+ },
31440
+ noise_threshold_nrs: {
31441
+ description:
31442
+ '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).',
31443
+ format: 'float',
31444
+ type: 'number',
31445
+ },
31446
+ starts_daily_at: {
31447
+ description:
31448
+ 'Time at which the noise threshold should become active daily.',
31449
+ type: 'string',
31450
+ },
31451
+ sync: {
31452
+ default: false,
31453
+ type: 'boolean',
31454
+ 'x-undocumented': 'Only used internally.',
31455
+ },
31206
31456
  },
31207
31457
  required: ['noise_threshold_id', 'device_id'],
31208
31458
  type: 'object',
@@ -31241,16 +31491,26 @@ export default {
31241
31491
  'x-action-attempt-type': 'UPDATE_NOISE_THRESHOLD',
31242
31492
  'x-fern-ignore': true,
31243
31493
  'x-response-key': null,
31494
+ 'x-title': 'Update a Noise Threshold',
31244
31495
  },
31245
31496
  },
31246
31497
  '/noise_sensors/simulate/trigger_noise_threshold': {
31247
31498
  post: {
31499
+ description:
31500
+ '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).',
31248
31501
  operationId: 'noiseSensorsSimulateTriggerNoiseThresholdPost',
31249
31502
  requestBody: {
31250
31503
  content: {
31251
31504
  'application/json': {
31252
31505
  schema: {
31253
- properties: { device_id: { format: 'uuid', type: 'string' } },
31506
+ properties: {
31507
+ device_id: {
31508
+ description:
31509
+ 'ID of the device for which you want to simulate the triggering of a noise threshold.',
31510
+ format: 'uuid',
31511
+ type: 'string',
31512
+ },
31513
+ },
31254
31514
  required: ['device_id'],
31255
31515
  type: 'object',
31256
31516
  },
@@ -31283,6 +31543,7 @@ export default {
31283
31543
  'x-fern-sdk-group-name': ['noise_sensors', 'simulate'],
31284
31544
  'x-fern-sdk-method-name': 'trigger_noise_threshold',
31285
31545
  'x-response-key': null,
31546
+ 'x-title': 'Simulate Triggering a Noise Threshold',
31286
31547
  },
31287
31548
  },
31288
31549
  '/phones/deactivate': {
@@ -32876,6 +33137,100 @@ export default {
32876
33137
  'x-undocumented': 'Mobile SDK only.',
32877
33138
  },
32878
33139
  },
33140
+ '/seam/partner/v1/building_blocks/spaces/auto_map': {
33141
+ post: {
33142
+ description:
33143
+ 'Auto map partner resources that have been pushed to Seam.',
33144
+ operationId: 'seamPartnerV1BuildingBlocksSpacesAutoMapPost',
33145
+ requestBody: {
33146
+ content: {
33147
+ 'application/json': {
33148
+ schema: {
33149
+ properties: { collection_key: { type: 'string' } },
33150
+ required: ['collection_key'],
33151
+ type: 'object',
33152
+ },
33153
+ },
33154
+ },
33155
+ },
33156
+ responses: {
33157
+ 200: {
33158
+ content: {
33159
+ 'application/json': {
33160
+ schema: {
33161
+ properties: {
33162
+ ok: { type: 'boolean' },
33163
+ spaces: {
33164
+ items: {
33165
+ properties: {
33166
+ acs_entrances: {
33167
+ items: {
33168
+ properties: {
33169
+ acs_entrance_id: { type: 'string' },
33170
+ name: { type: 'string' },
33171
+ },
33172
+ required: ['acs_entrance_id', 'name'],
33173
+ type: 'object',
33174
+ },
33175
+ type: 'array',
33176
+ },
33177
+ devices: {
33178
+ items: {
33179
+ properties: {
33180
+ device_id: { type: 'string' },
33181
+ device_type: {
33182
+ enum: ['lock', 'thermostat', 'sensor'],
33183
+ type: 'string',
33184
+ },
33185
+ name: { type: 'string' },
33186
+ },
33187
+ required: ['device_id', 'device_type', 'name'],
33188
+ type: 'object',
33189
+ },
33190
+ type: 'array',
33191
+ },
33192
+ name: { type: 'string' },
33193
+ needs_review: { type: 'boolean' },
33194
+ partner_resource_key: { type: 'string' },
33195
+ },
33196
+ required: [
33197
+ 'name',
33198
+ 'partner_resource_key',
33199
+ 'devices',
33200
+ 'acs_entrances',
33201
+ ],
33202
+ type: 'object',
33203
+ },
33204
+ type: 'array',
33205
+ },
33206
+ },
33207
+ required: ['spaces', 'ok'],
33208
+ type: 'object',
33209
+ },
33210
+ },
33211
+ },
33212
+ description: 'OK',
33213
+ },
33214
+ 400: { description: 'Bad Request' },
33215
+ 401: { description: 'Unauthorized' },
33216
+ },
33217
+ security: [{ client_session_with_customer: [] }],
33218
+ summary: '/seam/partner/v1/building_blocks/spaces/auto_map',
33219
+ tags: [],
33220
+ 'x-fern-sdk-group-name': [
33221
+ 'seam',
33222
+ 'partner',
33223
+ 'v1',
33224
+ 'building_blocks',
33225
+ 'spaces',
33226
+ ],
33227
+ 'x-fern-sdk-method-name': 'auto_map',
33228
+ 'x-fern-sdk-return-value': 'spaces',
33229
+ 'x-response-key': 'spaces',
33230
+ 'x-title': 'Do auto mapping for partner resources that map to spaces',
33231
+ 'x-undocumented': 'Partner building blocks/UI only.',
33232
+ },
33233
+ },
32879
33234
  '/seam/partner/v1/resources/list': {
32880
33235
  post: {
32881
33236
  description: 'List partner resources that have been pushed to Seam.',
@@ -37466,15 +37821,64 @@ export default {
37466
37821
  content: {
37467
37822
  'application/json': {
37468
37823
  schema: {
37469
- properties: {
37470
- building_block_type: {
37471
- enum: ['connect_account', 'manage_devices'],
37472
- type: 'string',
37824
+ discriminator: { propertyName: 'building_block_type' },
37825
+ oneOf: [
37826
+ {
37827
+ properties: {
37828
+ building_block_type: {
37829
+ enum: ['connect_account'],
37830
+ type: 'string',
37831
+ },
37832
+ customer_key: { type: 'string' },
37833
+ },
37834
+ required: ['building_block_type', 'customer_key'],
37835
+ type: 'object',
37473
37836
  },
37474
- customer_key: { type: 'string' },
37475
- },
37476
- required: ['building_block_type', 'customer_key'],
37477
- type: 'object',
37837
+ {
37838
+ properties: {
37839
+ building_block_type: {
37840
+ enum: ['manage_devices'],
37841
+ type: 'string',
37842
+ },
37843
+ customer_key: { type: 'string' },
37844
+ },
37845
+ required: ['building_block_type', 'customer_key'],
37846
+ type: 'object',
37847
+ },
37848
+ {
37849
+ properties: {
37850
+ building_block_type: {
37851
+ enum: ['organize_spaces'],
37852
+ type: 'string',
37853
+ },
37854
+ customer_key: { type: 'string' },
37855
+ partner_resources: {
37856
+ items: {
37857
+ properties: {
37858
+ custom_metadata: {
37859
+ additionalProperties: { type: 'string' },
37860
+ type: 'object',
37861
+ },
37862
+ description: { type: 'string' },
37863
+ name: { type: 'string' },
37864
+ partner_resource_key: { type: 'string' },
37865
+ },
37866
+ required: ['partner_resource_key', 'name'],
37867
+ type: 'object',
37868
+ 'x-route-path': '/unstable_partner/resources',
37869
+ 'x-undocumented': 'Unreleased.',
37870
+ },
37871
+ type: 'array',
37872
+ },
37873
+ },
37874
+ required: [
37875
+ 'building_block_type',
37876
+ 'customer_key',
37877
+ 'partner_resources',
37878
+ ],
37879
+ type: 'object',
37880
+ },
37881
+ ],
37478
37882
  },
37479
37883
  },
37480
37884
  },