@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.
Files changed (37) hide show
  1. package/dist/connect.cjs +485 -223
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +472 -192
  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/index.d.ts +1 -0
  16. package/lib/seam/connect/models/partner/index.js +1 -0
  17. package/lib/seam/connect/models/partner/index.js.map +1 -1
  18. package/lib/seam/connect/models/partner/magic-link.d.ts +24 -0
  19. package/lib/seam/connect/models/partner/magic-link.js +19 -0
  20. package/lib/seam/connect/models/partner/magic-link.js.map +1 -0
  21. package/lib/seam/connect/models/partner/resources.d.ts +18 -2
  22. package/lib/seam/connect/models/partner/resources.js +17 -1
  23. package/lib/seam/connect/models/partner/resources.js.map +1 -1
  24. package/lib/seam/connect/openapi.d.ts +351 -145
  25. package/lib/seam/connect/openapi.js +450 -201
  26. package/lib/seam/connect/openapi.js.map +1 -1
  27. package/lib/seam/connect/route-types.d.ts +112 -47
  28. package/package.json +1 -1
  29. package/src/lib/seam/connect/internal/schemas.ts +3 -0
  30. package/src/lib/seam/connect/models/acs/acs-access-group.ts +7 -1
  31. package/src/lib/seam/connect/models/acs/acs-encoder.ts +6 -0
  32. package/src/lib/seam/connect/models/noise-sensors/noise-threshold.ts +29 -7
  33. package/src/lib/seam/connect/models/partner/index.ts +1 -0
  34. package/src/lib/seam/connect/models/partner/magic-link.ts +21 -0
  35. package/src/lib/seam/connect/models/partner/resources.ts +19 -1
  36. package/src/lib/seam/connect/openapi.ts +503 -211
  37. package/src/lib/seam/connect/route-types.ts +119 -51
@@ -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',
@@ -15900,6 +15914,30 @@ export default {
15900
15914
  'x-route-path': '/user_identities',
15901
15915
  'x-undocumented': 'Unreleased.',
15902
15916
  },
15917
+ magic_link: {
15918
+ properties: {
15919
+ building_block_type: {
15920
+ enum: ['connect_account', 'manage_devices', 'organize_spaces'],
15921
+ type: 'string',
15922
+ },
15923
+ created_at: { format: 'date-time', type: 'string' },
15924
+ customer_key: { type: 'string' },
15925
+ expires_at: { format: 'date-time', type: 'string' },
15926
+ url: { format: 'uri', type: 'string' },
15927
+ workspace_id: { format: 'uuid', type: 'string' },
15928
+ },
15929
+ required: [
15930
+ 'url',
15931
+ 'building_block_type',
15932
+ 'customer_key',
15933
+ 'expires_at',
15934
+ 'workspace_id',
15935
+ 'created_at',
15936
+ ],
15937
+ type: 'object',
15938
+ 'x-route-path': '/unstable_partner/building_blocks',
15939
+ 'x-undocumented': 'Unreleased.',
15940
+ },
15903
15941
  network: {
15904
15942
  properties: {
15905
15943
  created_at: { format: 'date-time', type: 'string' },
@@ -15912,14 +15950,42 @@ export default {
15912
15950
  'x-route-path': '/networks',
15913
15951
  },
15914
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.',
15915
15955
  properties: {
15916
- device_id: { format: 'uuid', type: 'string' },
15917
- ends_daily_at: { type: 'string' },
15918
- name: { type: 'string' },
15919
- noise_threshold_decibels: { format: 'float', type: 'number' },
15920
- noise_threshold_id: { format: 'uuid', type: 'string' },
15921
- noise_threshold_nrs: { format: 'float', type: 'number' },
15922
- 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
+ },
15923
15989
  },
15924
15990
  required: [
15925
15991
  'noise_threshold_id',
@@ -18358,6 +18424,12 @@ export default {
18358
18424
  format: 'uuid',
18359
18425
  type: 'string',
18360
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
+ },
18361
18433
  created_at: {
18362
18434
  description: 'Date and time at which the access group was created.',
18363
18435
  format: 'date-time',
@@ -18423,6 +18495,7 @@ export default {
18423
18495
  'acs_access_group_id',
18424
18496
  'acs_system_id',
18425
18497
  'workspace_id',
18498
+ 'connected_account_id',
18426
18499
  'name',
18427
18500
  'access_group_type',
18428
18501
  'access_group_type_display_name',
@@ -20708,6 +20781,7 @@ export default {
20708
20781
  401: { description: 'Unauthorized' },
20709
20782
  },
20710
20783
  security: [
20784
+ { client_session_with_customer: [] },
20711
20785
  { client_session: [] },
20712
20786
  { pat_with_workspace: [] },
20713
20787
  { console_session_with_workspace: [] },
@@ -21050,6 +21124,7 @@ export default {
21050
21124
  },
21051
21125
  security: [
21052
21126
  { client_session: [] },
21127
+ { client_session_with_customer: [] },
21053
21128
  { pat_with_workspace: [] },
21054
21129
  { console_session_with_workspace: [] },
21055
21130
  { api_key: [] },
@@ -21179,6 +21254,7 @@ export default {
21179
21254
  { access_token: [] },
21180
21255
  { console_session_with_workspace: [] },
21181
21256
  { client_session: [] },
21257
+ { client_session_with_customer: [] },
21182
21258
  ],
21183
21259
  summary: '/access_codes/get',
21184
21260
  tags: ['/access_codes'],
@@ -21205,6 +21281,10 @@ export default {
21205
21281
  items: { format: 'uuid', type: 'string' },
21206
21282
  type: 'array',
21207
21283
  },
21284
+ customer_ids: {
21285
+ items: { format: 'uuid', type: 'string' },
21286
+ type: 'array',
21287
+ },
21208
21288
  device_id: {
21209
21289
  description:
21210
21290
  'ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.',
@@ -21260,6 +21340,7 @@ export default {
21260
21340
  },
21261
21341
  security: [
21262
21342
  { client_session: [] },
21343
+ { client_session_with_customer: [] },
21263
21344
  { pat_with_workspace: [] },
21264
21345
  { console_session_with_workspace: [] },
21265
21346
  { api_key: [] },
@@ -28104,7 +28185,7 @@ export default {
28104
28185
  '/connected_accounts/sync': {
28105
28186
  post: {
28106
28187
  description:
28107
- '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`.',
28108
28189
  operationId: 'connectedAccountsSyncPost',
28109
28190
  requestBody: {
28110
28191
  content: {
@@ -30361,6 +30442,7 @@ export default {
30361
30442
  },
30362
30443
  security: [
30363
30444
  { client_session: [] },
30445
+ { client_session_with_customer: [] },
30364
30446
  { pat_with_workspace: [] },
30365
30447
  { console_session_with_workspace: [] },
30366
30448
  { api_key: [] },
@@ -30548,6 +30630,7 @@ export default {
30548
30630
  },
30549
30631
  security: [
30550
30632
  { client_session: [] },
30633
+ { client_session_with_customer: [] },
30551
30634
  { pat_with_workspace: [] },
30552
30635
  { console_session_with_workspace: [] },
30553
30636
  { api_key: [] },
@@ -30657,6 +30740,8 @@ export default {
30657
30740
  },
30658
30741
  '/noise_sensors/list': {
30659
30742
  post: {
30743
+ description:
30744
+ 'Returns a list of all [noise sensors](https://docs.seam.co/latest/capability-guides/noise-sensors).',
30660
30745
  operationId: 'noiseSensorsListPost',
30661
30746
  requestBody: {
30662
30747
  content: {
@@ -30706,13 +30791,14 @@ export default {
30706
30791
  type: 'array',
30707
30792
  },
30708
30793
  device_type: {
30709
- description: 'Device type by which to filter devices.',
30794
+ description:
30795
+ 'Device type of the noise sensors that you want to list.',
30710
30796
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
30711
30797
  type: 'string',
30712
30798
  },
30713
30799
  device_types: {
30714
30800
  description:
30715
- 'Array of device types by which to filter devices.',
30801
+ 'Device types of the noise sensors that you want to list.',
30716
30802
  items: {
30717
30803
  description: 'Device type for noise sensors.\n ',
30718
30804
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
@@ -30768,7 +30854,8 @@ export default {
30768
30854
  type: 'number',
30769
30855
  },
30770
30856
  manufacturer: {
30771
- description: 'Manufacturer by which to filter devices.',
30857
+ description:
30858
+ 'Manufacturers of the noise sensors that you want to list.',
30772
30859
  enum: ['minut', 'noiseaware'],
30773
30860
  type: 'string',
30774
30861
  },
@@ -30835,23 +30922,56 @@ export default {
30835
30922
  'x-fern-sdk-method-name': 'list',
30836
30923
  'x-fern-sdk-return-value': 'devices',
30837
30924
  'x-response-key': 'devices',
30925
+ 'x-title': 'List Noise Sensors',
30838
30926
  },
30839
30927
  },
30840
30928
  '/noise_sensors/noise_thresholds/create': {
30841
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.',
30842
30932
  operationId: 'noiseSensorsNoiseThresholdsCreatePost',
30843
30933
  requestBody: {
30844
30934
  content: {
30845
30935
  'application/json': {
30846
30936
  schema: {
30847
30937
  properties: {
30848
- device_id: { format: 'uuid', type: 'string' },
30849
- ends_daily_at: { type: 'string' },
30850
- name: { type: 'string' },
30851
- noise_threshold_decibels: { format: 'float', type: 'number' },
30852
- noise_threshold_nrs: { format: 'float', type: 'number' },
30853
- starts_daily_at: { type: 'string' },
30854
- 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
+ },
30855
30975
  },
30856
30976
  required: ['device_id', 'starts_daily_at', 'ends_daily_at'],
30857
30977
  type: 'object',
@@ -30895,19 +31015,36 @@ export default {
30895
31015
  'x-fern-sdk-method-name': 'create',
30896
31016
  'x-fern-sdk-return-value': 'noise_threshold',
30897
31017
  'x-response-key': 'noise_threshold',
31018
+ 'x-title': 'Create a Noise Threshold',
30898
31019
  },
30899
31020
  },
30900
31021
  '/noise_sensors/noise_thresholds/delete': {
30901
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).',
30902
31025
  operationId: 'noiseSensorsNoiseThresholdsDeletePost',
30903
31026
  requestBody: {
30904
31027
  content: {
30905
31028
  'application/json': {
30906
31029
  schema: {
30907
31030
  properties: {
30908
- device_id: { format: 'uuid', type: 'string' },
30909
- noise_threshold_id: { format: 'uuid', type: 'string' },
30910
- 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
+ },
30911
31048
  },
30912
31049
  required: ['noise_threshold_id', 'device_id'],
30913
31050
  type: 'object',
@@ -30947,17 +31084,25 @@ export default {
30947
31084
  'x-fern-sdk-group-name': ['noise_sensors', 'noise_thresholds'],
30948
31085
  'x-fern-sdk-method-name': 'delete',
30949
31086
  'x-response-key': null,
31087
+ 'x-title': 'Delete a Noise Threshold',
30950
31088
  },
30951
31089
  },
30952
31090
  '/noise_sensors/noise_thresholds/get': {
30953
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).',
30954
31094
  operationId: 'noiseSensorsNoiseThresholdsGetPost',
30955
31095
  requestBody: {
30956
31096
  content: {
30957
31097
  'application/json': {
30958
31098
  schema: {
30959
31099
  properties: {
30960
- 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
+ },
30961
31106
  },
30962
31107
  required: ['noise_threshold_id'],
30963
31108
  type: 'object',
@@ -30997,18 +31142,32 @@ export default {
30997
31142
  'x-fern-sdk-method-name': 'get',
30998
31143
  'x-fern-sdk-return-value': 'noise_threshold',
30999
31144
  'x-response-key': 'noise_threshold',
31145
+ 'x-title': 'Get a Noise Threshold',
31000
31146
  },
31001
31147
  },
31002
31148
  '/noise_sensors/noise_thresholds/list': {
31003
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).',
31004
31152
  operationId: 'noiseSensorsNoiseThresholdsListPost',
31005
31153
  requestBody: {
31006
31154
  content: {
31007
31155
  'application/json': {
31008
31156
  schema: {
31009
31157
  properties: {
31010
- device_id: { format: 'uuid', type: 'string' },
31011
- 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
+ },
31012
31171
  },
31013
31172
  required: ['device_id'],
31014
31173
  type: 'object',
@@ -31050,24 +31209,63 @@ export default {
31050
31209
  'x-fern-sdk-method-name': 'list',
31051
31210
  'x-fern-sdk-return-value': 'noise_thresholds',
31052
31211
  'x-response-key': 'noise_thresholds',
31212
+ 'x-title': 'List Noise Thresholds',
31053
31213
  },
31054
31214
  },
31055
31215
  '/noise_sensors/noise_thresholds/update': {
31056
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).',
31057
31219
  operationId: 'noiseSensorsNoiseThresholdsUpdatePatch',
31058
31220
  requestBody: {
31059
31221
  content: {
31060
31222
  'application/json': {
31061
31223
  schema: {
31062
31224
  properties: {
31063
- device_id: { format: 'uuid', type: 'string' },
31064
- ends_daily_at: { type: 'string' },
31065
- name: { type: 'string' },
31066
- noise_threshold_decibels: { format: 'float', type: 'number' },
31067
- noise_threshold_id: { format: 'uuid', type: 'string' },
31068
- noise_threshold_nrs: { format: 'float', type: 'number' },
31069
- starts_daily_at: { type: 'string' },
31070
- 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
+ },
31071
31269
  },
31072
31270
  required: ['noise_threshold_id', 'device_id'],
31073
31271
  type: 'object',
@@ -31106,22 +31304,61 @@ export default {
31106
31304
  'x-action-attempt-type': 'UPDATE_NOISE_THRESHOLD',
31107
31305
  'x-fern-ignore': true,
31108
31306
  'x-response-key': null,
31307
+ 'x-title': 'Update a Noise Threshold',
31109
31308
  },
31110
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).',
31111
31312
  operationId: 'noiseSensorsNoiseThresholdsUpdatePost',
31112
31313
  requestBody: {
31113
31314
  content: {
31114
31315
  'application/json': {
31115
31316
  schema: {
31116
31317
  properties: {
31117
- device_id: { format: 'uuid', type: 'string' },
31118
- ends_daily_at: { type: 'string' },
31119
- name: { type: 'string' },
31120
- noise_threshold_decibels: { format: 'float', type: 'number' },
31121
- noise_threshold_id: { format: 'uuid', type: 'string' },
31122
- noise_threshold_nrs: { format: 'float', type: 'number' },
31123
- starts_daily_at: { type: 'string' },
31124
- 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
+ },
31125
31362
  },
31126
31363
  required: ['noise_threshold_id', 'device_id'],
31127
31364
  type: 'object',
@@ -31161,22 +31398,61 @@ export default {
31161
31398
  'x-fern-sdk-group-name': ['noise_sensors', 'noise_thresholds'],
31162
31399
  'x-fern-sdk-method-name': 'update',
31163
31400
  'x-response-key': null,
31401
+ 'x-title': 'Update a Noise Threshold',
31164
31402
  },
31165
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).',
31166
31406
  operationId: 'noiseSensorsNoiseThresholdsUpdatePut',
31167
31407
  requestBody: {
31168
31408
  content: {
31169
31409
  'application/json': {
31170
31410
  schema: {
31171
31411
  properties: {
31172
- device_id: { format: 'uuid', type: 'string' },
31173
- ends_daily_at: { type: 'string' },
31174
- name: { type: 'string' },
31175
- noise_threshold_decibels: { format: 'float', type: 'number' },
31176
- noise_threshold_id: { format: 'uuid', type: 'string' },
31177
- noise_threshold_nrs: { format: 'float', type: 'number' },
31178
- starts_daily_at: { type: 'string' },
31179
- 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
+ },
31180
31456
  },
31181
31457
  required: ['noise_threshold_id', 'device_id'],
31182
31458
  type: 'object',
@@ -31215,16 +31491,26 @@ export default {
31215
31491
  'x-action-attempt-type': 'UPDATE_NOISE_THRESHOLD',
31216
31492
  'x-fern-ignore': true,
31217
31493
  'x-response-key': null,
31494
+ 'x-title': 'Update a Noise Threshold',
31218
31495
  },
31219
31496
  },
31220
31497
  '/noise_sensors/simulate/trigger_noise_threshold': {
31221
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).',
31222
31501
  operationId: 'noiseSensorsSimulateTriggerNoiseThresholdPost',
31223
31502
  requestBody: {
31224
31503
  content: {
31225
31504
  'application/json': {
31226
31505
  schema: {
31227
- 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
+ },
31228
31514
  required: ['device_id'],
31229
31515
  type: 'object',
31230
31516
  },
@@ -31257,6 +31543,7 @@ export default {
31257
31543
  'x-fern-sdk-group-name': ['noise_sensors', 'simulate'],
31258
31544
  'x-fern-sdk-method-name': 'trigger_noise_threshold',
31259
31545
  'x-response-key': null,
31546
+ 'x-title': 'Simulate Triggering a Noise Threshold',
31260
31547
  },
31261
31548
  },
31262
31549
  '/phones/deactivate': {
@@ -32850,6 +33137,100 @@ export default {
32850
33137
  'x-undocumented': 'Mobile SDK only.',
32851
33138
  },
32852
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
+ },
32853
33234
  '/seam/partner/v1/resources/list': {
32854
33235
  post: {
32855
33236
  description: 'List partner resources that have been pushed to Seam.',
@@ -32904,6 +33285,8 @@ export default {
32904
33285
  'customer_key',
32905
33286
  ],
32906
33287
  type: 'object',
33288
+ 'x-route-path': '/unstable_partner/resources',
33289
+ 'x-undocumented': 'Unreleased.',
32907
33290
  },
32908
33291
  type: 'array',
32909
33292
  },
@@ -37430,25 +37813,72 @@ export default {
37430
37813
  'x-undocumented': 'Experimental locations.',
37431
37814
  },
37432
37815
  },
37433
- '/unstable_partner/building_blocks/generate_link': {
37816
+ '/unstable_partner/building_blocks/generate_magic_link': {
37434
37817
  post: {
37435
- description: 'Creates a new bridge client session.',
37436
- operationId: 'unstablePartnerBuildingBlocksGenerateLinkPost',
37818
+ description: 'Creates a new building block magic link.',
37819
+ operationId: 'unstablePartnerBuildingBlocksGenerateMagicLinkPost',
37437
37820
  requestBody: {
37438
37821
  content: {
37439
37822
  'application/json': {
37440
37823
  schema: {
37441
- properties: {
37442
- bridge_client_machine_identifier_key: { type: 'string' },
37443
- bridge_client_name: { type: 'string' },
37444
- bridge_client_time_zone: { type: 'string' },
37445
- },
37446
- required: [
37447
- 'bridge_client_name',
37448
- 'bridge_client_time_zone',
37449
- 'bridge_client_machine_identifier_key',
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',
37836
+ },
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
+ },
37450
37881
  ],
37451
- type: 'object',
37452
37882
  },
37453
37883
  },
37454
37884
  },
@@ -37459,152 +37889,10 @@ export default {
37459
37889
  'application/json': {
37460
37890
  schema: {
37461
37891
  properties: {
37462
- bridge_client_session: {
37463
- properties: {
37464
- bridge_client_machine_identifier_key: {
37465
- type: 'string',
37466
- },
37467
- bridge_client_name: { type: 'string' },
37468
- bridge_client_session_id: {
37469
- format: 'uuid',
37470
- type: 'string',
37471
- },
37472
- bridge_client_session_token: { type: 'string' },
37473
- bridge_client_time_zone: { type: 'string' },
37474
- created_at: { format: 'date-time', type: 'string' },
37475
- errors: {
37476
- items: {
37477
- description:
37478
- 'Error associated with the `bridge_client_session`.',
37479
- discriminator: { propertyName: 'error_code' },
37480
- oneOf: [
37481
- {
37482
- description:
37483
- "Seam cannot reach the bridge's LAN",
37484
- properties: {
37485
- can_tailscale_proxy_reach_bridge: {
37486
- description:
37487
- 'Tailscale proxy cannot reach the bridge',
37488
- nullable: true,
37489
- type: 'boolean',
37490
- },
37491
- can_tailscale_proxy_reach_tailscale_network: {
37492
- description:
37493
- 'Tailscale proxy cannot reach the Tailscale network',
37494
- nullable: true,
37495
- type: 'boolean',
37496
- },
37497
- created_at: {
37498
- format: 'date-time',
37499
- type: 'string',
37500
- },
37501
- error_code: {
37502
- description:
37503
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
37504
- enum: ['bridge_lan_unreachable'],
37505
- type: 'string',
37506
- },
37507
- is_bridge_socks_server_healthy: {
37508
- description:
37509
- "Bridge's SOCKS server is unhealthy",
37510
- nullable: true,
37511
- type: 'boolean',
37512
- },
37513
- is_tailscale_proxy_reachable: {
37514
- description:
37515
- 'Seam cannot reach the tailscale proxy',
37516
- nullable: true,
37517
- type: 'boolean',
37518
- },
37519
- is_tailscale_proxy_socks_server_healthy: {
37520
- description:
37521
- "Tailscale proxy's SOCKS server is unhealthy",
37522
- nullable: true,
37523
- type: 'boolean',
37524
- },
37525
- message: { type: 'string' },
37526
- },
37527
- required: [
37528
- 'message',
37529
- 'created_at',
37530
- 'error_code',
37531
- 'is_tailscale_proxy_reachable',
37532
- 'is_tailscale_proxy_socks_server_healthy',
37533
- 'can_tailscale_proxy_reach_tailscale_network',
37534
- 'can_tailscale_proxy_reach_bridge',
37535
- 'is_bridge_socks_server_healthy',
37536
- ],
37537
- type: 'object',
37538
- },
37539
- {
37540
- description:
37541
- 'Bridge has stopped communicating with Seam',
37542
- properties: {
37543
- created_at: {
37544
- format: 'date-time',
37545
- type: 'string',
37546
- },
37547
- error_code: {
37548
- description:
37549
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
37550
- enum: ['no_communication_from_bridge'],
37551
- type: 'string',
37552
- },
37553
- message: { type: 'string' },
37554
- },
37555
- required: [
37556
- 'message',
37557
- 'created_at',
37558
- 'error_code',
37559
- ],
37560
- type: 'object',
37561
- },
37562
- ],
37563
- },
37564
- type: 'array',
37565
- },
37566
- pairing_code: {
37567
- maxLength: 6,
37568
- minLength: 6,
37569
- type: 'string',
37570
- },
37571
- pairing_code_expires_at: {
37572
- format: 'date-time',
37573
- type: 'string',
37574
- },
37575
- tailscale_auth_key: { nullable: true, type: 'string' },
37576
- tailscale_hostname: { type: 'string' },
37577
- telemetry_token: { nullable: true, type: 'string' },
37578
- telemetry_token_expires_at: {
37579
- format: 'date-time',
37580
- nullable: true,
37581
- type: 'string',
37582
- },
37583
- telemetry_url: { nullable: true, type: 'string' },
37584
- },
37585
- required: [
37586
- 'created_at',
37587
- 'bridge_client_session_id',
37588
- 'bridge_client_session_token',
37589
- 'pairing_code',
37590
- 'pairing_code_expires_at',
37591
- 'tailscale_hostname',
37592
- 'tailscale_auth_key',
37593
- 'bridge_client_name',
37594
- 'bridge_client_time_zone',
37595
- 'bridge_client_machine_identifier_key',
37596
- 'errors',
37597
- 'telemetry_token',
37598
- 'telemetry_token_expires_at',
37599
- 'telemetry_url',
37600
- ],
37601
- type: 'object',
37602
- 'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
37603
- 'x-undocumented': 'Seam Bridge Client only.',
37604
- },
37892
+ magic_link: { $ref: '#/components/schemas/magic_link' },
37605
37893
  ok: { type: 'boolean' },
37606
37894
  },
37607
- required: ['bridge_client_session', 'ok'],
37895
+ required: ['magic_link', 'ok'],
37608
37896
  type: 'object',
37609
37897
  },
37610
37898
  },
@@ -37614,13 +37902,13 @@ export default {
37614
37902
  400: { description: 'Bad Request' },
37615
37903
  401: { description: 'Unauthorized' },
37616
37904
  },
37617
- security: [{ certified_client: [] }],
37618
- summary: '/unstable_partner/building_blocks/generate_link',
37905
+ security: [{ api_key: [] }],
37906
+ summary: '/unstable_partner/building_blocks/generate_magic_link',
37619
37907
  tags: [],
37620
37908
  'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
37621
- 'x-fern-sdk-method-name': 'generate_link',
37622
- 'x-fern-sdk-return-value': 'bridge_client_session',
37623
- 'x-response-key': 'bridge_client_session',
37909
+ 'x-fern-sdk-method-name': 'generate_magic_link',
37910
+ 'x-fern-sdk-return-value': 'magic_link',
37911
+ 'x-response-key': 'magic_link',
37624
37912
  'x-title': 'Generate a building block magic link',
37625
37913
  'x-undocumented': 'Experimental partner building blocks.',
37626
37914
  },
@@ -37657,6 +37945,8 @@ export default {
37657
37945
  user_identity_key: { type: 'string' },
37658
37946
  },
37659
37947
  type: 'object',
37948
+ 'x-route-path': '/unstable_partner/resources',
37949
+ 'x-undocumented': 'Unreleased.',
37660
37950
  },
37661
37951
  type: 'array',
37662
37952
  },
@@ -37682,6 +37972,8 @@ export default {
37682
37972
  user_identity_key: { type: 'string' },
37683
37973
  },
37684
37974
  type: 'object',
37975
+ 'x-route-path': '/unstable_partner/resources',
37976
+ 'x-undocumented': 'Unreleased.',
37685
37977
  },
37686
37978
  ],
37687
37979
  },