@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
package/dist/connect.cjs CHANGED
@@ -2403,6 +2403,9 @@ var common_acs_access_group = zod.z.object({
2403
2403
  workspace_id: zod.z.string().uuid().describe(
2404
2404
  "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group."
2405
2405
  ),
2406
+ connected_account_id: zod.z.string().uuid().describe(
2407
+ "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group."
2408
+ ),
2406
2409
  name: zod.z.string().describe("Name of the access group."),
2407
2410
  access_group_type: acs_access_group_external_type.describe(`
2408
2411
  ---
@@ -2431,7 +2434,7 @@ var acs_access_group = common_acs_access_group.extend({
2431
2434
  route_path: /acs/access_groups
2432
2435
  ---
2433
2436
  Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
2434
-
2437
+
2435
2438
  Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
2436
2439
 
2437
2440
  To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).
@@ -2762,6 +2765,9 @@ var acs_encoder = zod.z.object({
2762
2765
  acs_system_id: zod.z.string().uuid().describe(
2763
2766
  "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners)."
2764
2767
  ),
2768
+ connected_account_id: zod.z.string().uuid().describe(
2769
+ "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)."
2770
+ ),
2765
2771
  workspace_id: zod.z.string().uuid().describe(
2766
2772
  "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners)."
2767
2773
  ),
@@ -5024,19 +5030,26 @@ var instant_key = zod.z.object({
5024
5030
  ---
5025
5031
  `);
5026
5032
  var noise_threshold = zod.z.object({
5027
- noise_threshold_id: zod.z.string().uuid(),
5028
- device_id: zod.z.string().uuid(),
5029
- name: zod.z.string(),
5030
- noise_threshold_nrs: zod.z.number().optional(),
5031
- starts_daily_at: zod.z.string(),
5033
+ noise_threshold_id: zod.z.string().uuid().describe("Unique identifier for the noise threshold."),
5034
+ device_id: zod.z.string().uuid().describe(
5035
+ "Unique identifier for the device that contains the noise threshold."
5036
+ ),
5037
+ name: zod.z.string().describe("Name of the noise threshold."),
5038
+ noise_threshold_nrs: zod.z.number().optional().describe(
5039
+ "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)."
5040
+ ),
5041
+ starts_daily_at: zod.z.string().describe("Time at which the noise threshold should become active daily."),
5032
5042
  // TODO: zoned_time
5033
- ends_daily_at: zod.z.string(),
5043
+ ends_daily_at: zod.z.string().describe(
5044
+ "Time at which the noise threshold should become inactive daily."
5045
+ ),
5034
5046
  // TODO: zoned_time
5035
- noise_threshold_decibels: zod.z.number()
5047
+ noise_threshold_decibels: zod.z.number().describe("Noise level in decibels for the noise threshold.")
5036
5048
  }).describe(`
5037
5049
  ---
5038
5050
  route_path: /noise_sensors/noise_thresholds
5039
5051
  ---
5052
+ 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.
5040
5053
  `);
5041
5054
  var pagination = zod.z.object({
5042
5055
  next_page_cursor: zod.z.string().base64().nullable().describe(
@@ -6514,6 +6527,11 @@ var openapi_default = {
6514
6527
  format: "uuid",
6515
6528
  type: "string"
6516
6529
  },
6530
+ connected_account_id: {
6531
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group.",
6532
+ format: "uuid",
6533
+ type: "string"
6534
+ },
6517
6535
  created_at: {
6518
6536
  description: "Date and time at which the access group was created.",
6519
6537
  format: "date-time",
@@ -6573,6 +6591,7 @@ var openapi_default = {
6573
6591
  "acs_access_group_id",
6574
6592
  "acs_system_id",
6575
6593
  "workspace_id",
6594
+ "connected_account_id",
6576
6595
  "name",
6577
6596
  "access_group_type",
6578
6597
  "access_group_type_display_name",
@@ -6954,6 +6973,11 @@ var openapi_default = {
6954
6973
  format: "uuid",
6955
6974
  type: "string"
6956
6975
  },
6976
+ connected_account_id: {
6977
+ 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).",
6978
+ format: "uuid",
6979
+ type: "string"
6980
+ },
6957
6981
  created_at: {
6958
6982
  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.",
6959
6983
  format: "date-time",
@@ -6997,6 +7021,7 @@ var openapi_default = {
6997
7021
  required: [
6998
7022
  "acs_encoder_id",
6999
7023
  "acs_system_id",
7024
+ "connected_account_id",
7000
7025
  "workspace_id",
7001
7026
  "errors",
7002
7027
  "created_at",
@@ -19636,11 +19661,10 @@ var openapi_default = {
19636
19661
  magic_link: {
19637
19662
  properties: {
19638
19663
  building_block_type: {
19639
- enum: ["connect_account", "manage_devices"],
19664
+ enum: ["connect_account", "manage_devices", "organize_spaces"],
19640
19665
  type: "string"
19641
19666
  },
19642
19667
  created_at: { format: "date-time", type: "string" },
19643
- customer_id: { format: "uuid", type: "string" },
19644
19668
  customer_key: { type: "string" },
19645
19669
  expires_at: { format: "date-time", type: "string" },
19646
19670
  url: { format: "uri", type: "string" },
@@ -19649,7 +19673,6 @@ var openapi_default = {
19649
19673
  required: [
19650
19674
  "url",
19651
19675
  "building_block_type",
19652
- "customer_id",
19653
19676
  "customer_key",
19654
19677
  "expires_at",
19655
19678
  "workspace_id",
@@ -19671,14 +19694,37 @@ var openapi_default = {
19671
19694
  "x-route-path": "/networks"
19672
19695
  },
19673
19696
  noise_threshold: {
19697
+ 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.",
19674
19698
  properties: {
19675
- device_id: { format: "uuid", type: "string" },
19676
- ends_daily_at: { type: "string" },
19677
- name: { type: "string" },
19678
- noise_threshold_decibels: { format: "float", type: "number" },
19679
- noise_threshold_id: { format: "uuid", type: "string" },
19680
- noise_threshold_nrs: { format: "float", type: "number" },
19681
- starts_daily_at: { type: "string" }
19699
+ device_id: {
19700
+ description: "Unique identifier for the device that contains the noise threshold.",
19701
+ format: "uuid",
19702
+ type: "string"
19703
+ },
19704
+ ends_daily_at: {
19705
+ description: "Time at which the noise threshold should become inactive daily.",
19706
+ type: "string"
19707
+ },
19708
+ name: { description: "Name of the noise threshold.", type: "string" },
19709
+ noise_threshold_decibels: {
19710
+ description: "Noise level in decibels for the noise threshold.",
19711
+ format: "float",
19712
+ type: "number"
19713
+ },
19714
+ noise_threshold_id: {
19715
+ description: "Unique identifier for the noise threshold.",
19716
+ format: "uuid",
19717
+ type: "string"
19718
+ },
19719
+ noise_threshold_nrs: {
19720
+ 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).",
19721
+ format: "float",
19722
+ type: "number"
19723
+ },
19724
+ starts_daily_at: {
19725
+ description: "Time at which the noise threshold should become active daily.",
19726
+ type: "string"
19727
+ }
19682
19728
  },
19683
19729
  required: [
19684
19730
  "noise_threshold_id",
@@ -21843,6 +21889,11 @@ var openapi_default = {
21843
21889
  format: "uuid",
21844
21890
  type: "string"
21845
21891
  },
21892
+ connected_account_id: {
21893
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group.",
21894
+ format: "uuid",
21895
+ type: "string"
21896
+ },
21846
21897
  created_at: {
21847
21898
  description: "Date and time at which the access group was created.",
21848
21899
  format: "date-time",
@@ -21902,6 +21953,7 @@ var openapi_default = {
21902
21953
  "acs_access_group_id",
21903
21954
  "acs_system_id",
21904
21955
  "workspace_id",
21956
+ "connected_account_id",
21905
21957
  "name",
21906
21958
  "access_group_type",
21907
21959
  "access_group_type_display_name",
@@ -23980,6 +24032,7 @@ var openapi_default = {
23980
24032
  401: { description: "Unauthorized" }
23981
24033
  },
23982
24034
  security: [
24035
+ { client_session_with_customer: [] },
23983
24036
  { client_session: [] },
23984
24037
  { pat_with_workspace: [] },
23985
24038
  { console_session_with_workspace: [] },
@@ -24291,6 +24344,7 @@ var openapi_default = {
24291
24344
  },
24292
24345
  security: [
24293
24346
  { client_session: [] },
24347
+ { client_session_with_customer: [] },
24294
24348
  { pat_with_workspace: [] },
24295
24349
  { console_session_with_workspace: [] },
24296
24350
  { api_key: [] }
@@ -24413,7 +24467,8 @@ var openapi_default = {
24413
24467
  { api_key: [] },
24414
24468
  { access_token: [] },
24415
24469
  { console_session_with_workspace: [] },
24416
- { client_session: [] }
24470
+ { client_session: [] },
24471
+ { client_session_with_customer: [] }
24417
24472
  ],
24418
24473
  summary: "/access_codes/get",
24419
24474
  tags: ["/access_codes"],
@@ -24438,6 +24493,10 @@ var openapi_default = {
24438
24493
  items: { format: "uuid", type: "string" },
24439
24494
  type: "array"
24440
24495
  },
24496
+ customer_ids: {
24497
+ items: { format: "uuid", type: "string" },
24498
+ type: "array"
24499
+ },
24441
24500
  device_id: {
24442
24501
  description: "ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.",
24443
24502
  format: "uuid",
@@ -24489,6 +24548,7 @@ var openapi_default = {
24489
24548
  },
24490
24549
  security: [
24491
24550
  { client_session: [] },
24551
+ { client_session_with_customer: [] },
24492
24552
  { pat_with_workspace: [] },
24493
24553
  { console_session_with_workspace: [] },
24494
24554
  { api_key: [] }
@@ -30927,7 +30987,7 @@ var openapi_default = {
30927
30987
  },
30928
30988
  "/connected_accounts/sync": {
30929
30989
  post: {
30930
- description: "Request a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) sync attempt for the specified connected_account_id.",
30990
+ description: "Request a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`.",
30931
30991
  operationId: "connectedAccountsSyncPost",
30932
30992
  requestBody: {
30933
30993
  content: {
@@ -33084,6 +33144,7 @@ var openapi_default = {
33084
33144
  },
33085
33145
  security: [
33086
33146
  { client_session: [] },
33147
+ { client_session_with_customer: [] },
33087
33148
  { pat_with_workspace: [] },
33088
33149
  { console_session_with_workspace: [] },
33089
33150
  { api_key: [] }
@@ -33265,6 +33326,7 @@ var openapi_default = {
33265
33326
  },
33266
33327
  security: [
33267
33328
  { client_session: [] },
33329
+ { client_session_with_customer: [] },
33268
33330
  { pat_with_workspace: [] },
33269
33331
  { console_session_with_workspace: [] },
33270
33332
  { api_key: [] }
@@ -33374,6 +33436,7 @@ var openapi_default = {
33374
33436
  },
33375
33437
  "/noise_sensors/list": {
33376
33438
  post: {
33439
+ description: "Returns a list of all [noise sensors](https://docs.seam.co/latest/capability-guides/noise-sensors).",
33377
33440
  operationId: "noiseSensorsListPost",
33378
33441
  requestBody: {
33379
33442
  content: {
@@ -33417,12 +33480,12 @@ var openapi_default = {
33417
33480
  type: "array"
33418
33481
  },
33419
33482
  device_type: {
33420
- description: "Device type by which to filter devices.",
33483
+ description: "Device type of the noise sensors that you want to list.",
33421
33484
  enum: ["noiseaware_activity_zone", "minut_sensor"],
33422
33485
  type: "string"
33423
33486
  },
33424
33487
  device_types: {
33425
- description: "Array of device types by which to filter devices.",
33488
+ description: "Device types of the noise sensors that you want to list.",
33426
33489
  items: {
33427
33490
  description: "Device type for noise sensors.\n ",
33428
33491
  enum: ["noiseaware_activity_zone", "minut_sensor"],
@@ -33477,7 +33540,7 @@ var openapi_default = {
33477
33540
  type: "number"
33478
33541
  },
33479
33542
  manufacturer: {
33480
- description: "Manufacturer by which to filter devices.",
33543
+ description: "Manufacturers of the noise sensors that you want to list.",
33481
33544
  enum: ["minut", "noiseaware"],
33482
33545
  type: "string"
33483
33546
  },
@@ -33540,24 +33603,51 @@ var openapi_default = {
33540
33603
  "x-fern-sdk-group-name": ["noise_sensors"],
33541
33604
  "x-fern-sdk-method-name": "list",
33542
33605
  "x-fern-sdk-return-value": "devices",
33543
- "x-response-key": "devices"
33606
+ "x-response-key": "devices",
33607
+ "x-title": "List Noise Sensors"
33544
33608
  }
33545
33609
  },
33546
33610
  "/noise_sensors/noise_thresholds/create": {
33547
33611
  post: {
33612
+ 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.",
33548
33613
  operationId: "noiseSensorsNoiseThresholdsCreatePost",
33549
33614
  requestBody: {
33550
33615
  content: {
33551
33616
  "application/json": {
33552
33617
  schema: {
33553
33618
  properties: {
33554
- device_id: { format: "uuid", type: "string" },
33555
- ends_daily_at: { type: "string" },
33556
- name: { type: "string" },
33557
- noise_threshold_decibels: { format: "float", type: "number" },
33558
- noise_threshold_nrs: { format: "float", type: "number" },
33559
- starts_daily_at: { type: "string" },
33560
- sync: { default: false, type: "boolean" }
33619
+ device_id: {
33620
+ description: "ID of the device for which you want to create a noise threshold.",
33621
+ format: "uuid",
33622
+ type: "string"
33623
+ },
33624
+ ends_daily_at: {
33625
+ description: "Time at which the new noise threshold should become inactive daily.",
33626
+ type: "string"
33627
+ },
33628
+ name: {
33629
+ description: "Name of the new noise threshold.",
33630
+ type: "string"
33631
+ },
33632
+ noise_threshold_decibels: {
33633
+ description: "Noise level in decibels for the new noise threshold.",
33634
+ format: "float",
33635
+ type: "number"
33636
+ },
33637
+ noise_threshold_nrs: {
33638
+ 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).",
33639
+ format: "float",
33640
+ type: "number"
33641
+ },
33642
+ starts_daily_at: {
33643
+ description: "Time at which the new noise threshold should become active daily.",
33644
+ type: "string"
33645
+ },
33646
+ sync: {
33647
+ default: false,
33648
+ type: "boolean",
33649
+ "x-undocumented": "Only used internally."
33650
+ }
33561
33651
  },
33562
33652
  required: ["device_id", "starts_daily_at", "ends_daily_at"],
33563
33653
  type: "object"
@@ -33600,20 +33690,34 @@ var openapi_default = {
33600
33690
  "x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"],
33601
33691
  "x-fern-sdk-method-name": "create",
33602
33692
  "x-fern-sdk-return-value": "noise_threshold",
33603
- "x-response-key": "noise_threshold"
33693
+ "x-response-key": "noise_threshold",
33694
+ "x-title": "Create a Noise Threshold"
33604
33695
  }
33605
33696
  },
33606
33697
  "/noise_sensors/noise_thresholds/delete": {
33607
33698
  post: {
33699
+ 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).",
33608
33700
  operationId: "noiseSensorsNoiseThresholdsDeletePost",
33609
33701
  requestBody: {
33610
33702
  content: {
33611
33703
  "application/json": {
33612
33704
  schema: {
33613
33705
  properties: {
33614
- device_id: { format: "uuid", type: "string" },
33615
- noise_threshold_id: { format: "uuid", type: "string" },
33616
- sync: { default: false, type: "boolean" }
33706
+ device_id: {
33707
+ description: "ID of the device that contains the noise threshold that you want to delete.",
33708
+ format: "uuid",
33709
+ type: "string"
33710
+ },
33711
+ noise_threshold_id: {
33712
+ description: "ID of the noise threshold that you want to delete.",
33713
+ format: "uuid",
33714
+ type: "string"
33715
+ },
33716
+ sync: {
33717
+ default: false,
33718
+ type: "boolean",
33719
+ "x-undocumented": "Only used internally."
33720
+ }
33617
33721
  },
33618
33722
  required: ["noise_threshold_id", "device_id"],
33619
33723
  type: "object"
@@ -33652,18 +33756,24 @@ var openapi_default = {
33652
33756
  "x-action-attempt-type": "DELETE_NOISE_THRESHOLD",
33653
33757
  "x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"],
33654
33758
  "x-fern-sdk-method-name": "delete",
33655
- "x-response-key": null
33759
+ "x-response-key": null,
33760
+ "x-title": "Delete a Noise Threshold"
33656
33761
  }
33657
33762
  },
33658
33763
  "/noise_sensors/noise_thresholds/get": {
33659
33764
  post: {
33765
+ 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).",
33660
33766
  operationId: "noiseSensorsNoiseThresholdsGetPost",
33661
33767
  requestBody: {
33662
33768
  content: {
33663
33769
  "application/json": {
33664
33770
  schema: {
33665
33771
  properties: {
33666
- noise_threshold_id: { format: "uuid", type: "string" }
33772
+ noise_threshold_id: {
33773
+ description: "ID of the noise threshold that you want to get.",
33774
+ format: "uuid",
33775
+ type: "string"
33776
+ }
33667
33777
  },
33668
33778
  required: ["noise_threshold_id"],
33669
33779
  type: "object"
@@ -33702,19 +33812,29 @@ var openapi_default = {
33702
33812
  "x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"],
33703
33813
  "x-fern-sdk-method-name": "get",
33704
33814
  "x-fern-sdk-return-value": "noise_threshold",
33705
- "x-response-key": "noise_threshold"
33815
+ "x-response-key": "noise_threshold",
33816
+ "x-title": "Get a Noise Threshold"
33706
33817
  }
33707
33818
  },
33708
33819
  "/noise_sensors/noise_thresholds/list": {
33709
33820
  post: {
33821
+ 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).",
33710
33822
  operationId: "noiseSensorsNoiseThresholdsListPost",
33711
33823
  requestBody: {
33712
33824
  content: {
33713
33825
  "application/json": {
33714
33826
  schema: {
33715
33827
  properties: {
33716
- device_id: { format: "uuid", type: "string" },
33717
- is_programmed: { type: "boolean" }
33828
+ device_id: {
33829
+ description: "ID of the device for which you want to list noise thresholds.",
33830
+ format: "uuid",
33831
+ type: "string"
33832
+ },
33833
+ is_programmed: {
33834
+ 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`.",
33835
+ type: "boolean",
33836
+ "x-undocumented": "Not sure if this parameter is supported or what it does."
33837
+ }
33718
33838
  },
33719
33839
  required: ["device_id"],
33720
33840
  type: "object"
@@ -33755,25 +33875,56 @@ var openapi_default = {
33755
33875
  "x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"],
33756
33876
  "x-fern-sdk-method-name": "list",
33757
33877
  "x-fern-sdk-return-value": "noise_thresholds",
33758
- "x-response-key": "noise_thresholds"
33878
+ "x-response-key": "noise_thresholds",
33879
+ "x-title": "List Noise Thresholds"
33759
33880
  }
33760
33881
  },
33761
33882
  "/noise_sensors/noise_thresholds/update": {
33762
33883
  patch: {
33884
+ 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).",
33763
33885
  operationId: "noiseSensorsNoiseThresholdsUpdatePatch",
33764
33886
  requestBody: {
33765
33887
  content: {
33766
33888
  "application/json": {
33767
33889
  schema: {
33768
33890
  properties: {
33769
- device_id: { format: "uuid", type: "string" },
33770
- ends_daily_at: { type: "string" },
33771
- name: { type: "string" },
33772
- noise_threshold_decibels: { format: "float", type: "number" },
33773
- noise_threshold_id: { format: "uuid", type: "string" },
33774
- noise_threshold_nrs: { format: "float", type: "number" },
33775
- starts_daily_at: { type: "string" },
33776
- sync: { default: false, type: "boolean" }
33891
+ device_id: {
33892
+ description: "ID of the device that contains the noise threshold that you want to update.",
33893
+ format: "uuid",
33894
+ type: "string"
33895
+ },
33896
+ ends_daily_at: {
33897
+ description: "Time at which the noise threshold should become inactive daily.",
33898
+ type: "string"
33899
+ },
33900
+ name: {
33901
+ description: "Name of the noise threshold that you want to update.",
33902
+ type: "string"
33903
+ },
33904
+ noise_threshold_decibels: {
33905
+ description: "Noise level in decibels for the noise threshold.",
33906
+ format: "float",
33907
+ type: "number"
33908
+ },
33909
+ noise_threshold_id: {
33910
+ description: "ID of the noise threshold that you want to update.",
33911
+ format: "uuid",
33912
+ type: "string"
33913
+ },
33914
+ noise_threshold_nrs: {
33915
+ 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).",
33916
+ format: "float",
33917
+ type: "number"
33918
+ },
33919
+ starts_daily_at: {
33920
+ description: "Time at which the noise threshold should become active daily.",
33921
+ type: "string"
33922
+ },
33923
+ sync: {
33924
+ default: false,
33925
+ type: "boolean",
33926
+ "x-undocumented": "Only used internally."
33927
+ }
33777
33928
  },
33778
33929
  required: ["noise_threshold_id", "device_id"],
33779
33930
  type: "object"
@@ -33811,23 +33962,54 @@ var openapi_default = {
33811
33962
  tags: ["/noise_sensors"],
33812
33963
  "x-action-attempt-type": "UPDATE_NOISE_THRESHOLD",
33813
33964
  "x-fern-ignore": true,
33814
- "x-response-key": null
33965
+ "x-response-key": null,
33966
+ "x-title": "Update a Noise Threshold"
33815
33967
  },
33816
33968
  post: {
33969
+ 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).",
33817
33970
  operationId: "noiseSensorsNoiseThresholdsUpdatePost",
33818
33971
  requestBody: {
33819
33972
  content: {
33820
33973
  "application/json": {
33821
33974
  schema: {
33822
33975
  properties: {
33823
- device_id: { format: "uuid", type: "string" },
33824
- ends_daily_at: { type: "string" },
33825
- name: { type: "string" },
33826
- noise_threshold_decibels: { format: "float", type: "number" },
33827
- noise_threshold_id: { format: "uuid", type: "string" },
33828
- noise_threshold_nrs: { format: "float", type: "number" },
33829
- starts_daily_at: { type: "string" },
33830
- sync: { default: false, type: "boolean" }
33976
+ device_id: {
33977
+ description: "ID of the device that contains the noise threshold that you want to update.",
33978
+ format: "uuid",
33979
+ type: "string"
33980
+ },
33981
+ ends_daily_at: {
33982
+ description: "Time at which the noise threshold should become inactive daily.",
33983
+ type: "string"
33984
+ },
33985
+ name: {
33986
+ description: "Name of the noise threshold that you want to update.",
33987
+ type: "string"
33988
+ },
33989
+ noise_threshold_decibels: {
33990
+ description: "Noise level in decibels for the noise threshold.",
33991
+ format: "float",
33992
+ type: "number"
33993
+ },
33994
+ noise_threshold_id: {
33995
+ description: "ID of the noise threshold that you want to update.",
33996
+ format: "uuid",
33997
+ type: "string"
33998
+ },
33999
+ noise_threshold_nrs: {
34000
+ 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).",
34001
+ format: "float",
34002
+ type: "number"
34003
+ },
34004
+ starts_daily_at: {
34005
+ description: "Time at which the noise threshold should become active daily.",
34006
+ type: "string"
34007
+ },
34008
+ sync: {
34009
+ default: false,
34010
+ type: "boolean",
34011
+ "x-undocumented": "Only used internally."
34012
+ }
33831
34013
  },
33832
34014
  required: ["noise_threshold_id", "device_id"],
33833
34015
  type: "object"
@@ -33866,23 +34048,54 @@ var openapi_default = {
33866
34048
  "x-action-attempt-type": "UPDATE_NOISE_THRESHOLD",
33867
34049
  "x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"],
33868
34050
  "x-fern-sdk-method-name": "update",
33869
- "x-response-key": null
34051
+ "x-response-key": null,
34052
+ "x-title": "Update a Noise Threshold"
33870
34053
  },
33871
34054
  put: {
34055
+ 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).",
33872
34056
  operationId: "noiseSensorsNoiseThresholdsUpdatePut",
33873
34057
  requestBody: {
33874
34058
  content: {
33875
34059
  "application/json": {
33876
34060
  schema: {
33877
34061
  properties: {
33878
- device_id: { format: "uuid", type: "string" },
33879
- ends_daily_at: { type: "string" },
33880
- name: { type: "string" },
33881
- noise_threshold_decibels: { format: "float", type: "number" },
33882
- noise_threshold_id: { format: "uuid", type: "string" },
33883
- noise_threshold_nrs: { format: "float", type: "number" },
33884
- starts_daily_at: { type: "string" },
33885
- sync: { default: false, type: "boolean" }
34062
+ device_id: {
34063
+ description: "ID of the device that contains the noise threshold that you want to update.",
34064
+ format: "uuid",
34065
+ type: "string"
34066
+ },
34067
+ ends_daily_at: {
34068
+ description: "Time at which the noise threshold should become inactive daily.",
34069
+ type: "string"
34070
+ },
34071
+ name: {
34072
+ description: "Name of the noise threshold that you want to update.",
34073
+ type: "string"
34074
+ },
34075
+ noise_threshold_decibels: {
34076
+ description: "Noise level in decibels for the noise threshold.",
34077
+ format: "float",
34078
+ type: "number"
34079
+ },
34080
+ noise_threshold_id: {
34081
+ description: "ID of the noise threshold that you want to update.",
34082
+ format: "uuid",
34083
+ type: "string"
34084
+ },
34085
+ noise_threshold_nrs: {
34086
+ 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).",
34087
+ format: "float",
34088
+ type: "number"
34089
+ },
34090
+ starts_daily_at: {
34091
+ description: "Time at which the noise threshold should become active daily.",
34092
+ type: "string"
34093
+ },
34094
+ sync: {
34095
+ default: false,
34096
+ type: "boolean",
34097
+ "x-undocumented": "Only used internally."
34098
+ }
33886
34099
  },
33887
34100
  required: ["noise_threshold_id", "device_id"],
33888
34101
  type: "object"
@@ -33920,17 +34133,25 @@ var openapi_default = {
33920
34133
  tags: ["/noise_sensors"],
33921
34134
  "x-action-attempt-type": "UPDATE_NOISE_THRESHOLD",
33922
34135
  "x-fern-ignore": true,
33923
- "x-response-key": null
34136
+ "x-response-key": null,
34137
+ "x-title": "Update a Noise Threshold"
33924
34138
  }
33925
34139
  },
33926
34140
  "/noise_sensors/simulate/trigger_noise_threshold": {
33927
34141
  post: {
34142
+ 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).",
33928
34143
  operationId: "noiseSensorsSimulateTriggerNoiseThresholdPost",
33929
34144
  requestBody: {
33930
34145
  content: {
33931
34146
  "application/json": {
33932
34147
  schema: {
33933
- properties: { device_id: { format: "uuid", type: "string" } },
34148
+ properties: {
34149
+ device_id: {
34150
+ description: "ID of the device for which you want to simulate the triggering of a noise threshold.",
34151
+ format: "uuid",
34152
+ type: "string"
34153
+ }
34154
+ },
33934
34155
  required: ["device_id"],
33935
34156
  type: "object"
33936
34157
  }
@@ -33962,7 +34183,8 @@ var openapi_default = {
33962
34183
  tags: ["/noise_sensors"],
33963
34184
  "x-fern-sdk-group-name": ["noise_sensors", "simulate"],
33964
34185
  "x-fern-sdk-method-name": "trigger_noise_threshold",
33965
- "x-response-key": null
34186
+ "x-response-key": null,
34187
+ "x-title": "Simulate Triggering a Noise Threshold"
33966
34188
  }
33967
34189
  },
33968
34190
  "/phones/deactivate": {
@@ -35472,6 +35694,99 @@ var openapi_default = {
35472
35694
  "x-undocumented": "Mobile SDK only."
35473
35695
  }
35474
35696
  },
35697
+ "/seam/partner/v1/building_blocks/spaces/auto_map": {
35698
+ post: {
35699
+ description: "Auto map partner resources that have been pushed to Seam.",
35700
+ operationId: "seamPartnerV1BuildingBlocksSpacesAutoMapPost",
35701
+ requestBody: {
35702
+ content: {
35703
+ "application/json": {
35704
+ schema: {
35705
+ properties: { collection_key: { type: "string" } },
35706
+ required: ["collection_key"],
35707
+ type: "object"
35708
+ }
35709
+ }
35710
+ }
35711
+ },
35712
+ responses: {
35713
+ 200: {
35714
+ content: {
35715
+ "application/json": {
35716
+ schema: {
35717
+ properties: {
35718
+ ok: { type: "boolean" },
35719
+ spaces: {
35720
+ items: {
35721
+ properties: {
35722
+ acs_entrances: {
35723
+ items: {
35724
+ properties: {
35725
+ acs_entrance_id: { type: "string" },
35726
+ name: { type: "string" }
35727
+ },
35728
+ required: ["acs_entrance_id", "name"],
35729
+ type: "object"
35730
+ },
35731
+ type: "array"
35732
+ },
35733
+ devices: {
35734
+ items: {
35735
+ properties: {
35736
+ device_id: { type: "string" },
35737
+ device_type: {
35738
+ enum: ["lock", "thermostat", "sensor"],
35739
+ type: "string"
35740
+ },
35741
+ name: { type: "string" }
35742
+ },
35743
+ required: ["device_id", "device_type", "name"],
35744
+ type: "object"
35745
+ },
35746
+ type: "array"
35747
+ },
35748
+ name: { type: "string" },
35749
+ needs_review: { type: "boolean" },
35750
+ partner_resource_key: { type: "string" }
35751
+ },
35752
+ required: [
35753
+ "name",
35754
+ "partner_resource_key",
35755
+ "devices",
35756
+ "acs_entrances"
35757
+ ],
35758
+ type: "object"
35759
+ },
35760
+ type: "array"
35761
+ }
35762
+ },
35763
+ required: ["spaces", "ok"],
35764
+ type: "object"
35765
+ }
35766
+ }
35767
+ },
35768
+ description: "OK"
35769
+ },
35770
+ 400: { description: "Bad Request" },
35771
+ 401: { description: "Unauthorized" }
35772
+ },
35773
+ security: [{ client_session_with_customer: [] }],
35774
+ summary: "/seam/partner/v1/building_blocks/spaces/auto_map",
35775
+ tags: [],
35776
+ "x-fern-sdk-group-name": [
35777
+ "seam",
35778
+ "partner",
35779
+ "v1",
35780
+ "building_blocks",
35781
+ "spaces"
35782
+ ],
35783
+ "x-fern-sdk-method-name": "auto_map",
35784
+ "x-fern-sdk-return-value": "spaces",
35785
+ "x-response-key": "spaces",
35786
+ "x-title": "Do auto mapping for partner resources that map to spaces",
35787
+ "x-undocumented": "Partner building blocks/UI only."
35788
+ }
35789
+ },
35475
35790
  "/seam/partner/v1/resources/list": {
35476
35791
  post: {
35477
35792
  description: "List partner resources that have been pushed to Seam.",
@@ -39802,15 +40117,64 @@ var openapi_default = {
39802
40117
  content: {
39803
40118
  "application/json": {
39804
40119
  schema: {
39805
- properties: {
39806
- building_block_type: {
39807
- enum: ["connect_account", "manage_devices"],
39808
- type: "string"
40120
+ discriminator: { propertyName: "building_block_type" },
40121
+ oneOf: [
40122
+ {
40123
+ properties: {
40124
+ building_block_type: {
40125
+ enum: ["connect_account"],
40126
+ type: "string"
40127
+ },
40128
+ customer_key: { type: "string" }
40129
+ },
40130
+ required: ["building_block_type", "customer_key"],
40131
+ type: "object"
39809
40132
  },
39810
- customer_key: { type: "string" }
39811
- },
39812
- required: ["building_block_type", "customer_key"],
39813
- type: "object"
40133
+ {
40134
+ properties: {
40135
+ building_block_type: {
40136
+ enum: ["manage_devices"],
40137
+ type: "string"
40138
+ },
40139
+ customer_key: { type: "string" }
40140
+ },
40141
+ required: ["building_block_type", "customer_key"],
40142
+ type: "object"
40143
+ },
40144
+ {
40145
+ properties: {
40146
+ building_block_type: {
40147
+ enum: ["organize_spaces"],
40148
+ type: "string"
40149
+ },
40150
+ customer_key: { type: "string" },
40151
+ partner_resources: {
40152
+ items: {
40153
+ properties: {
40154
+ custom_metadata: {
40155
+ additionalProperties: { type: "string" },
40156
+ type: "object"
40157
+ },
40158
+ description: { type: "string" },
40159
+ name: { type: "string" },
40160
+ partner_resource_key: { type: "string" }
40161
+ },
40162
+ required: ["partner_resource_key", "name"],
40163
+ type: "object",
40164
+ "x-route-path": "/unstable_partner/resources",
40165
+ "x-undocumented": "Unreleased."
40166
+ },
40167
+ type: "array"
40168
+ }
40169
+ },
40170
+ required: [
40171
+ "building_block_type",
40172
+ "customer_key",
40173
+ "partner_resources"
40174
+ ],
40175
+ type: "object"
40176
+ }
40177
+ ]
39814
40178
  }
39815
40179
  }
39816
40180
  }