@seamapi/types 1.406.6 → 1.406.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +485 -223
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +472 -192
- package/lib/seam/connect/internal/schemas.d.ts +1 -1
- package/lib/seam/connect/internal/schemas.js +1 -1
- package/lib/seam/connect/internal/schemas.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.d.ts +6 -0
- package/lib/seam/connect/models/acs/acs-access-group.js +5 -1
- package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-encoder.d.ts +3 -0
- package/lib/seam/connect/models/acs/acs-encoder.js +4 -0
- package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
- package/lib/seam/connect/models/noise-sensors/noise-threshold.js +23 -7
- package/lib/seam/connect/models/noise-sensors/noise-threshold.js.map +1 -1
- package/lib/seam/connect/models/partner/index.d.ts +1 -0
- package/lib/seam/connect/models/partner/index.js +1 -0
- package/lib/seam/connect/models/partner/index.js.map +1 -1
- package/lib/seam/connect/models/partner/magic-link.d.ts +24 -0
- package/lib/seam/connect/models/partner/magic-link.js +19 -0
- package/lib/seam/connect/models/partner/magic-link.js.map +1 -0
- package/lib/seam/connect/models/partner/resources.d.ts +18 -2
- package/lib/seam/connect/models/partner/resources.js +17 -1
- package/lib/seam/connect/models/partner/resources.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +351 -145
- package/lib/seam/connect/openapi.js +450 -201
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +112 -47
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +3 -0
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +7 -1
- package/src/lib/seam/connect/models/acs/acs-encoder.ts +6 -0
- package/src/lib/seam/connect/models/noise-sensors/noise-threshold.ts +29 -7
- package/src/lib/seam/connect/models/partner/index.ts +1 -0
- package/src/lib/seam/connect/models/partner/magic-link.ts +21 -0
- package/src/lib/seam/connect/models/partner/resources.ts +19 -1
- package/src/lib/seam/connect/openapi.ts +503 -211
- package/src/lib/seam/connect/route-types.ts +119 -51
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
|
-
|
|
5030
|
-
|
|
5031
|
-
|
|
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",
|
|
@@ -19633,6 +19658,30 @@ var openapi_default = {
|
|
|
19633
19658
|
"x-route-path": "/user_identities",
|
|
19634
19659
|
"x-undocumented": "Unreleased."
|
|
19635
19660
|
},
|
|
19661
|
+
magic_link: {
|
|
19662
|
+
properties: {
|
|
19663
|
+
building_block_type: {
|
|
19664
|
+
enum: ["connect_account", "manage_devices", "organize_spaces"],
|
|
19665
|
+
type: "string"
|
|
19666
|
+
},
|
|
19667
|
+
created_at: { format: "date-time", type: "string" },
|
|
19668
|
+
customer_key: { type: "string" },
|
|
19669
|
+
expires_at: { format: "date-time", type: "string" },
|
|
19670
|
+
url: { format: "uri", type: "string" },
|
|
19671
|
+
workspace_id: { format: "uuid", type: "string" }
|
|
19672
|
+
},
|
|
19673
|
+
required: [
|
|
19674
|
+
"url",
|
|
19675
|
+
"building_block_type",
|
|
19676
|
+
"customer_key",
|
|
19677
|
+
"expires_at",
|
|
19678
|
+
"workspace_id",
|
|
19679
|
+
"created_at"
|
|
19680
|
+
],
|
|
19681
|
+
type: "object",
|
|
19682
|
+
"x-route-path": "/unstable_partner/building_blocks",
|
|
19683
|
+
"x-undocumented": "Unreleased."
|
|
19684
|
+
},
|
|
19636
19685
|
network: {
|
|
19637
19686
|
properties: {
|
|
19638
19687
|
created_at: { format: "date-time", type: "string" },
|
|
@@ -19645,14 +19694,37 @@ var openapi_default = {
|
|
|
19645
19694
|
"x-route-path": "/networks"
|
|
19646
19695
|
},
|
|
19647
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.",
|
|
19648
19698
|
properties: {
|
|
19649
|
-
device_id: {
|
|
19650
|
-
|
|
19651
|
-
|
|
19652
|
-
|
|
19653
|
-
|
|
19654
|
-
|
|
19655
|
-
|
|
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
|
+
}
|
|
19656
19728
|
},
|
|
19657
19729
|
required: [
|
|
19658
19730
|
"noise_threshold_id",
|
|
@@ -21817,6 +21889,11 @@ var openapi_default = {
|
|
|
21817
21889
|
format: "uuid",
|
|
21818
21890
|
type: "string"
|
|
21819
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
|
+
},
|
|
21820
21897
|
created_at: {
|
|
21821
21898
|
description: "Date and time at which the access group was created.",
|
|
21822
21899
|
format: "date-time",
|
|
@@ -21876,6 +21953,7 @@ var openapi_default = {
|
|
|
21876
21953
|
"acs_access_group_id",
|
|
21877
21954
|
"acs_system_id",
|
|
21878
21955
|
"workspace_id",
|
|
21956
|
+
"connected_account_id",
|
|
21879
21957
|
"name",
|
|
21880
21958
|
"access_group_type",
|
|
21881
21959
|
"access_group_type_display_name",
|
|
@@ -23954,6 +24032,7 @@ var openapi_default = {
|
|
|
23954
24032
|
401: { description: "Unauthorized" }
|
|
23955
24033
|
},
|
|
23956
24034
|
security: [
|
|
24035
|
+
{ client_session_with_customer: [] },
|
|
23957
24036
|
{ client_session: [] },
|
|
23958
24037
|
{ pat_with_workspace: [] },
|
|
23959
24038
|
{ console_session_with_workspace: [] },
|
|
@@ -24265,6 +24344,7 @@ var openapi_default = {
|
|
|
24265
24344
|
},
|
|
24266
24345
|
security: [
|
|
24267
24346
|
{ client_session: [] },
|
|
24347
|
+
{ client_session_with_customer: [] },
|
|
24268
24348
|
{ pat_with_workspace: [] },
|
|
24269
24349
|
{ console_session_with_workspace: [] },
|
|
24270
24350
|
{ api_key: [] }
|
|
@@ -24387,7 +24467,8 @@ var openapi_default = {
|
|
|
24387
24467
|
{ api_key: [] },
|
|
24388
24468
|
{ access_token: [] },
|
|
24389
24469
|
{ console_session_with_workspace: [] },
|
|
24390
|
-
{ client_session: [] }
|
|
24470
|
+
{ client_session: [] },
|
|
24471
|
+
{ client_session_with_customer: [] }
|
|
24391
24472
|
],
|
|
24392
24473
|
summary: "/access_codes/get",
|
|
24393
24474
|
tags: ["/access_codes"],
|
|
@@ -24412,6 +24493,10 @@ var openapi_default = {
|
|
|
24412
24493
|
items: { format: "uuid", type: "string" },
|
|
24413
24494
|
type: "array"
|
|
24414
24495
|
},
|
|
24496
|
+
customer_ids: {
|
|
24497
|
+
items: { format: "uuid", type: "string" },
|
|
24498
|
+
type: "array"
|
|
24499
|
+
},
|
|
24415
24500
|
device_id: {
|
|
24416
24501
|
description: "ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.",
|
|
24417
24502
|
format: "uuid",
|
|
@@ -24463,6 +24548,7 @@ var openapi_default = {
|
|
|
24463
24548
|
},
|
|
24464
24549
|
security: [
|
|
24465
24550
|
{ client_session: [] },
|
|
24551
|
+
{ client_session_with_customer: [] },
|
|
24466
24552
|
{ pat_with_workspace: [] },
|
|
24467
24553
|
{ console_session_with_workspace: [] },
|
|
24468
24554
|
{ api_key: [] }
|
|
@@ -30901,7 +30987,7 @@ var openapi_default = {
|
|
|
30901
30987
|
},
|
|
30902
30988
|
"/connected_accounts/sync": {
|
|
30903
30989
|
post: {
|
|
30904
|
-
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`.",
|
|
30905
30991
|
operationId: "connectedAccountsSyncPost",
|
|
30906
30992
|
requestBody: {
|
|
30907
30993
|
content: {
|
|
@@ -33058,6 +33144,7 @@ var openapi_default = {
|
|
|
33058
33144
|
},
|
|
33059
33145
|
security: [
|
|
33060
33146
|
{ client_session: [] },
|
|
33147
|
+
{ client_session_with_customer: [] },
|
|
33061
33148
|
{ pat_with_workspace: [] },
|
|
33062
33149
|
{ console_session_with_workspace: [] },
|
|
33063
33150
|
{ api_key: [] }
|
|
@@ -33239,6 +33326,7 @@ var openapi_default = {
|
|
|
33239
33326
|
},
|
|
33240
33327
|
security: [
|
|
33241
33328
|
{ client_session: [] },
|
|
33329
|
+
{ client_session_with_customer: [] },
|
|
33242
33330
|
{ pat_with_workspace: [] },
|
|
33243
33331
|
{ console_session_with_workspace: [] },
|
|
33244
33332
|
{ api_key: [] }
|
|
@@ -33348,6 +33436,7 @@ var openapi_default = {
|
|
|
33348
33436
|
},
|
|
33349
33437
|
"/noise_sensors/list": {
|
|
33350
33438
|
post: {
|
|
33439
|
+
description: "Returns a list of all [noise sensors](https://docs.seam.co/latest/capability-guides/noise-sensors).",
|
|
33351
33440
|
operationId: "noiseSensorsListPost",
|
|
33352
33441
|
requestBody: {
|
|
33353
33442
|
content: {
|
|
@@ -33391,12 +33480,12 @@ var openapi_default = {
|
|
|
33391
33480
|
type: "array"
|
|
33392
33481
|
},
|
|
33393
33482
|
device_type: {
|
|
33394
|
-
description: "Device type
|
|
33483
|
+
description: "Device type of the noise sensors that you want to list.",
|
|
33395
33484
|
enum: ["noiseaware_activity_zone", "minut_sensor"],
|
|
33396
33485
|
type: "string"
|
|
33397
33486
|
},
|
|
33398
33487
|
device_types: {
|
|
33399
|
-
description: "
|
|
33488
|
+
description: "Device types of the noise sensors that you want to list.",
|
|
33400
33489
|
items: {
|
|
33401
33490
|
description: "Device type for noise sensors.\n ",
|
|
33402
33491
|
enum: ["noiseaware_activity_zone", "minut_sensor"],
|
|
@@ -33451,7 +33540,7 @@ var openapi_default = {
|
|
|
33451
33540
|
type: "number"
|
|
33452
33541
|
},
|
|
33453
33542
|
manufacturer: {
|
|
33454
|
-
description: "
|
|
33543
|
+
description: "Manufacturers of the noise sensors that you want to list.",
|
|
33455
33544
|
enum: ["minut", "noiseaware"],
|
|
33456
33545
|
type: "string"
|
|
33457
33546
|
},
|
|
@@ -33514,24 +33603,51 @@ var openapi_default = {
|
|
|
33514
33603
|
"x-fern-sdk-group-name": ["noise_sensors"],
|
|
33515
33604
|
"x-fern-sdk-method-name": "list",
|
|
33516
33605
|
"x-fern-sdk-return-value": "devices",
|
|
33517
|
-
"x-response-key": "devices"
|
|
33606
|
+
"x-response-key": "devices",
|
|
33607
|
+
"x-title": "List Noise Sensors"
|
|
33518
33608
|
}
|
|
33519
33609
|
},
|
|
33520
33610
|
"/noise_sensors/noise_thresholds/create": {
|
|
33521
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.",
|
|
33522
33613
|
operationId: "noiseSensorsNoiseThresholdsCreatePost",
|
|
33523
33614
|
requestBody: {
|
|
33524
33615
|
content: {
|
|
33525
33616
|
"application/json": {
|
|
33526
33617
|
schema: {
|
|
33527
33618
|
properties: {
|
|
33528
|
-
device_id: {
|
|
33529
|
-
|
|
33530
|
-
|
|
33531
|
-
|
|
33532
|
-
|
|
33533
|
-
|
|
33534
|
-
|
|
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
|
+
}
|
|
33535
33651
|
},
|
|
33536
33652
|
required: ["device_id", "starts_daily_at", "ends_daily_at"],
|
|
33537
33653
|
type: "object"
|
|
@@ -33574,20 +33690,34 @@ var openapi_default = {
|
|
|
33574
33690
|
"x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"],
|
|
33575
33691
|
"x-fern-sdk-method-name": "create",
|
|
33576
33692
|
"x-fern-sdk-return-value": "noise_threshold",
|
|
33577
|
-
"x-response-key": "noise_threshold"
|
|
33693
|
+
"x-response-key": "noise_threshold",
|
|
33694
|
+
"x-title": "Create a Noise Threshold"
|
|
33578
33695
|
}
|
|
33579
33696
|
},
|
|
33580
33697
|
"/noise_sensors/noise_thresholds/delete": {
|
|
33581
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).",
|
|
33582
33700
|
operationId: "noiseSensorsNoiseThresholdsDeletePost",
|
|
33583
33701
|
requestBody: {
|
|
33584
33702
|
content: {
|
|
33585
33703
|
"application/json": {
|
|
33586
33704
|
schema: {
|
|
33587
33705
|
properties: {
|
|
33588
|
-
device_id: {
|
|
33589
|
-
|
|
33590
|
-
|
|
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
|
+
}
|
|
33591
33721
|
},
|
|
33592
33722
|
required: ["noise_threshold_id", "device_id"],
|
|
33593
33723
|
type: "object"
|
|
@@ -33626,18 +33756,24 @@ var openapi_default = {
|
|
|
33626
33756
|
"x-action-attempt-type": "DELETE_NOISE_THRESHOLD",
|
|
33627
33757
|
"x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"],
|
|
33628
33758
|
"x-fern-sdk-method-name": "delete",
|
|
33629
|
-
"x-response-key": null
|
|
33759
|
+
"x-response-key": null,
|
|
33760
|
+
"x-title": "Delete a Noise Threshold"
|
|
33630
33761
|
}
|
|
33631
33762
|
},
|
|
33632
33763
|
"/noise_sensors/noise_thresholds/get": {
|
|
33633
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).",
|
|
33634
33766
|
operationId: "noiseSensorsNoiseThresholdsGetPost",
|
|
33635
33767
|
requestBody: {
|
|
33636
33768
|
content: {
|
|
33637
33769
|
"application/json": {
|
|
33638
33770
|
schema: {
|
|
33639
33771
|
properties: {
|
|
33640
|
-
noise_threshold_id: {
|
|
33772
|
+
noise_threshold_id: {
|
|
33773
|
+
description: "ID of the noise threshold that you want to get.",
|
|
33774
|
+
format: "uuid",
|
|
33775
|
+
type: "string"
|
|
33776
|
+
}
|
|
33641
33777
|
},
|
|
33642
33778
|
required: ["noise_threshold_id"],
|
|
33643
33779
|
type: "object"
|
|
@@ -33676,19 +33812,29 @@ var openapi_default = {
|
|
|
33676
33812
|
"x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"],
|
|
33677
33813
|
"x-fern-sdk-method-name": "get",
|
|
33678
33814
|
"x-fern-sdk-return-value": "noise_threshold",
|
|
33679
|
-
"x-response-key": "noise_threshold"
|
|
33815
|
+
"x-response-key": "noise_threshold",
|
|
33816
|
+
"x-title": "Get a Noise Threshold"
|
|
33680
33817
|
}
|
|
33681
33818
|
},
|
|
33682
33819
|
"/noise_sensors/noise_thresholds/list": {
|
|
33683
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).",
|
|
33684
33822
|
operationId: "noiseSensorsNoiseThresholdsListPost",
|
|
33685
33823
|
requestBody: {
|
|
33686
33824
|
content: {
|
|
33687
33825
|
"application/json": {
|
|
33688
33826
|
schema: {
|
|
33689
33827
|
properties: {
|
|
33690
|
-
device_id: {
|
|
33691
|
-
|
|
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
|
+
}
|
|
33692
33838
|
},
|
|
33693
33839
|
required: ["device_id"],
|
|
33694
33840
|
type: "object"
|
|
@@ -33729,25 +33875,56 @@ var openapi_default = {
|
|
|
33729
33875
|
"x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"],
|
|
33730
33876
|
"x-fern-sdk-method-name": "list",
|
|
33731
33877
|
"x-fern-sdk-return-value": "noise_thresholds",
|
|
33732
|
-
"x-response-key": "noise_thresholds"
|
|
33878
|
+
"x-response-key": "noise_thresholds",
|
|
33879
|
+
"x-title": "List Noise Thresholds"
|
|
33733
33880
|
}
|
|
33734
33881
|
},
|
|
33735
33882
|
"/noise_sensors/noise_thresholds/update": {
|
|
33736
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).",
|
|
33737
33885
|
operationId: "noiseSensorsNoiseThresholdsUpdatePatch",
|
|
33738
33886
|
requestBody: {
|
|
33739
33887
|
content: {
|
|
33740
33888
|
"application/json": {
|
|
33741
33889
|
schema: {
|
|
33742
33890
|
properties: {
|
|
33743
|
-
device_id: {
|
|
33744
|
-
|
|
33745
|
-
|
|
33746
|
-
|
|
33747
|
-
|
|
33748
|
-
|
|
33749
|
-
|
|
33750
|
-
|
|
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
|
+
}
|
|
33751
33928
|
},
|
|
33752
33929
|
required: ["noise_threshold_id", "device_id"],
|
|
33753
33930
|
type: "object"
|
|
@@ -33785,23 +33962,54 @@ var openapi_default = {
|
|
|
33785
33962
|
tags: ["/noise_sensors"],
|
|
33786
33963
|
"x-action-attempt-type": "UPDATE_NOISE_THRESHOLD",
|
|
33787
33964
|
"x-fern-ignore": true,
|
|
33788
|
-
"x-response-key": null
|
|
33965
|
+
"x-response-key": null,
|
|
33966
|
+
"x-title": "Update a Noise Threshold"
|
|
33789
33967
|
},
|
|
33790
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).",
|
|
33791
33970
|
operationId: "noiseSensorsNoiseThresholdsUpdatePost",
|
|
33792
33971
|
requestBody: {
|
|
33793
33972
|
content: {
|
|
33794
33973
|
"application/json": {
|
|
33795
33974
|
schema: {
|
|
33796
33975
|
properties: {
|
|
33797
|
-
device_id: {
|
|
33798
|
-
|
|
33799
|
-
|
|
33800
|
-
|
|
33801
|
-
|
|
33802
|
-
|
|
33803
|
-
|
|
33804
|
-
|
|
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
|
+
}
|
|
33805
34013
|
},
|
|
33806
34014
|
required: ["noise_threshold_id", "device_id"],
|
|
33807
34015
|
type: "object"
|
|
@@ -33840,23 +34048,54 @@ var openapi_default = {
|
|
|
33840
34048
|
"x-action-attempt-type": "UPDATE_NOISE_THRESHOLD",
|
|
33841
34049
|
"x-fern-sdk-group-name": ["noise_sensors", "noise_thresholds"],
|
|
33842
34050
|
"x-fern-sdk-method-name": "update",
|
|
33843
|
-
"x-response-key": null
|
|
34051
|
+
"x-response-key": null,
|
|
34052
|
+
"x-title": "Update a Noise Threshold"
|
|
33844
34053
|
},
|
|
33845
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).",
|
|
33846
34056
|
operationId: "noiseSensorsNoiseThresholdsUpdatePut",
|
|
33847
34057
|
requestBody: {
|
|
33848
34058
|
content: {
|
|
33849
34059
|
"application/json": {
|
|
33850
34060
|
schema: {
|
|
33851
34061
|
properties: {
|
|
33852
|
-
device_id: {
|
|
33853
|
-
|
|
33854
|
-
|
|
33855
|
-
|
|
33856
|
-
|
|
33857
|
-
|
|
33858
|
-
|
|
33859
|
-
|
|
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
|
+
}
|
|
33860
34099
|
},
|
|
33861
34100
|
required: ["noise_threshold_id", "device_id"],
|
|
33862
34101
|
type: "object"
|
|
@@ -33894,17 +34133,25 @@ var openapi_default = {
|
|
|
33894
34133
|
tags: ["/noise_sensors"],
|
|
33895
34134
|
"x-action-attempt-type": "UPDATE_NOISE_THRESHOLD",
|
|
33896
34135
|
"x-fern-ignore": true,
|
|
33897
|
-
"x-response-key": null
|
|
34136
|
+
"x-response-key": null,
|
|
34137
|
+
"x-title": "Update a Noise Threshold"
|
|
33898
34138
|
}
|
|
33899
34139
|
},
|
|
33900
34140
|
"/noise_sensors/simulate/trigger_noise_threshold": {
|
|
33901
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).",
|
|
33902
34143
|
operationId: "noiseSensorsSimulateTriggerNoiseThresholdPost",
|
|
33903
34144
|
requestBody: {
|
|
33904
34145
|
content: {
|
|
33905
34146
|
"application/json": {
|
|
33906
34147
|
schema: {
|
|
33907
|
-
properties: {
|
|
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
|
+
},
|
|
33908
34155
|
required: ["device_id"],
|
|
33909
34156
|
type: "object"
|
|
33910
34157
|
}
|
|
@@ -33936,7 +34183,8 @@ var openapi_default = {
|
|
|
33936
34183
|
tags: ["/noise_sensors"],
|
|
33937
34184
|
"x-fern-sdk-group-name": ["noise_sensors", "simulate"],
|
|
33938
34185
|
"x-fern-sdk-method-name": "trigger_noise_threshold",
|
|
33939
|
-
"x-response-key": null
|
|
34186
|
+
"x-response-key": null,
|
|
34187
|
+
"x-title": "Simulate Triggering a Noise Threshold"
|
|
33940
34188
|
}
|
|
33941
34189
|
},
|
|
33942
34190
|
"/phones/deactivate": {
|
|
@@ -35446,6 +35694,99 @@ var openapi_default = {
|
|
|
35446
35694
|
"x-undocumented": "Mobile SDK only."
|
|
35447
35695
|
}
|
|
35448
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
|
+
},
|
|
35449
35790
|
"/seam/partner/v1/resources/list": {
|
|
35450
35791
|
post: {
|
|
35451
35792
|
description: "List partner resources that have been pushed to Seam.",
|
|
@@ -35499,7 +35840,9 @@ var openapi_default = {
|
|
|
35499
35840
|
"partner_resource_key",
|
|
35500
35841
|
"customer_key"
|
|
35501
35842
|
],
|
|
35502
|
-
type: "object"
|
|
35843
|
+
type: "object",
|
|
35844
|
+
"x-route-path": "/unstable_partner/resources",
|
|
35845
|
+
"x-undocumented": "Unreleased."
|
|
35503
35846
|
},
|
|
35504
35847
|
type: "array"
|
|
35505
35848
|
}
|
|
@@ -39766,25 +40109,72 @@ var openapi_default = {
|
|
|
39766
40109
|
"x-undocumented": "Experimental locations."
|
|
39767
40110
|
}
|
|
39768
40111
|
},
|
|
39769
|
-
"/unstable_partner/building_blocks/
|
|
40112
|
+
"/unstable_partner/building_blocks/generate_magic_link": {
|
|
39770
40113
|
post: {
|
|
39771
|
-
description: "Creates a new
|
|
39772
|
-
operationId: "
|
|
40114
|
+
description: "Creates a new building block magic link.",
|
|
40115
|
+
operationId: "unstablePartnerBuildingBlocksGenerateMagicLinkPost",
|
|
39773
40116
|
requestBody: {
|
|
39774
40117
|
content: {
|
|
39775
40118
|
"application/json": {
|
|
39776
40119
|
schema: {
|
|
39777
|
-
|
|
39778
|
-
|
|
39779
|
-
|
|
39780
|
-
|
|
39781
|
-
|
|
39782
|
-
|
|
39783
|
-
|
|
39784
|
-
|
|
39785
|
-
|
|
39786
|
-
|
|
39787
|
-
|
|
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"
|
|
40132
|
+
},
|
|
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
|
+
]
|
|
39788
40178
|
}
|
|
39789
40179
|
}
|
|
39790
40180
|
}
|
|
@@ -39795,142 +40185,10 @@ var openapi_default = {
|
|
|
39795
40185
|
"application/json": {
|
|
39796
40186
|
schema: {
|
|
39797
40187
|
properties: {
|
|
39798
|
-
|
|
39799
|
-
properties: {
|
|
39800
|
-
bridge_client_machine_identifier_key: {
|
|
39801
|
-
type: "string"
|
|
39802
|
-
},
|
|
39803
|
-
bridge_client_name: { type: "string" },
|
|
39804
|
-
bridge_client_session_id: {
|
|
39805
|
-
format: "uuid",
|
|
39806
|
-
type: "string"
|
|
39807
|
-
},
|
|
39808
|
-
bridge_client_session_token: { type: "string" },
|
|
39809
|
-
bridge_client_time_zone: { type: "string" },
|
|
39810
|
-
created_at: { format: "date-time", type: "string" },
|
|
39811
|
-
errors: {
|
|
39812
|
-
items: {
|
|
39813
|
-
description: "Error associated with the `bridge_client_session`.",
|
|
39814
|
-
discriminator: { propertyName: "error_code" },
|
|
39815
|
-
oneOf: [
|
|
39816
|
-
{
|
|
39817
|
-
description: "Seam cannot reach the bridge's LAN",
|
|
39818
|
-
properties: {
|
|
39819
|
-
can_tailscale_proxy_reach_bridge: {
|
|
39820
|
-
description: "Tailscale proxy cannot reach the bridge",
|
|
39821
|
-
nullable: true,
|
|
39822
|
-
type: "boolean"
|
|
39823
|
-
},
|
|
39824
|
-
can_tailscale_proxy_reach_tailscale_network: {
|
|
39825
|
-
description: "Tailscale proxy cannot reach the Tailscale network",
|
|
39826
|
-
nullable: true,
|
|
39827
|
-
type: "boolean"
|
|
39828
|
-
},
|
|
39829
|
-
created_at: {
|
|
39830
|
-
format: "date-time",
|
|
39831
|
-
type: "string"
|
|
39832
|
-
},
|
|
39833
|
-
error_code: {
|
|
39834
|
-
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
39835
|
-
enum: ["bridge_lan_unreachable"],
|
|
39836
|
-
type: "string"
|
|
39837
|
-
},
|
|
39838
|
-
is_bridge_socks_server_healthy: {
|
|
39839
|
-
description: "Bridge's SOCKS server is unhealthy",
|
|
39840
|
-
nullable: true,
|
|
39841
|
-
type: "boolean"
|
|
39842
|
-
},
|
|
39843
|
-
is_tailscale_proxy_reachable: {
|
|
39844
|
-
description: "Seam cannot reach the tailscale proxy",
|
|
39845
|
-
nullable: true,
|
|
39846
|
-
type: "boolean"
|
|
39847
|
-
},
|
|
39848
|
-
is_tailscale_proxy_socks_server_healthy: {
|
|
39849
|
-
description: "Tailscale proxy's SOCKS server is unhealthy",
|
|
39850
|
-
nullable: true,
|
|
39851
|
-
type: "boolean"
|
|
39852
|
-
},
|
|
39853
|
-
message: { type: "string" }
|
|
39854
|
-
},
|
|
39855
|
-
required: [
|
|
39856
|
-
"message",
|
|
39857
|
-
"created_at",
|
|
39858
|
-
"error_code",
|
|
39859
|
-
"is_tailscale_proxy_reachable",
|
|
39860
|
-
"is_tailscale_proxy_socks_server_healthy",
|
|
39861
|
-
"can_tailscale_proxy_reach_tailscale_network",
|
|
39862
|
-
"can_tailscale_proxy_reach_bridge",
|
|
39863
|
-
"is_bridge_socks_server_healthy"
|
|
39864
|
-
],
|
|
39865
|
-
type: "object"
|
|
39866
|
-
},
|
|
39867
|
-
{
|
|
39868
|
-
description: "Bridge has stopped communicating with Seam",
|
|
39869
|
-
properties: {
|
|
39870
|
-
created_at: {
|
|
39871
|
-
format: "date-time",
|
|
39872
|
-
type: "string"
|
|
39873
|
-
},
|
|
39874
|
-
error_code: {
|
|
39875
|
-
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
39876
|
-
enum: ["no_communication_from_bridge"],
|
|
39877
|
-
type: "string"
|
|
39878
|
-
},
|
|
39879
|
-
message: { type: "string" }
|
|
39880
|
-
},
|
|
39881
|
-
required: [
|
|
39882
|
-
"message",
|
|
39883
|
-
"created_at",
|
|
39884
|
-
"error_code"
|
|
39885
|
-
],
|
|
39886
|
-
type: "object"
|
|
39887
|
-
}
|
|
39888
|
-
]
|
|
39889
|
-
},
|
|
39890
|
-
type: "array"
|
|
39891
|
-
},
|
|
39892
|
-
pairing_code: {
|
|
39893
|
-
maxLength: 6,
|
|
39894
|
-
minLength: 6,
|
|
39895
|
-
type: "string"
|
|
39896
|
-
},
|
|
39897
|
-
pairing_code_expires_at: {
|
|
39898
|
-
format: "date-time",
|
|
39899
|
-
type: "string"
|
|
39900
|
-
},
|
|
39901
|
-
tailscale_auth_key: { nullable: true, type: "string" },
|
|
39902
|
-
tailscale_hostname: { type: "string" },
|
|
39903
|
-
telemetry_token: { nullable: true, type: "string" },
|
|
39904
|
-
telemetry_token_expires_at: {
|
|
39905
|
-
format: "date-time",
|
|
39906
|
-
nullable: true,
|
|
39907
|
-
type: "string"
|
|
39908
|
-
},
|
|
39909
|
-
telemetry_url: { nullable: true, type: "string" }
|
|
39910
|
-
},
|
|
39911
|
-
required: [
|
|
39912
|
-
"created_at",
|
|
39913
|
-
"bridge_client_session_id",
|
|
39914
|
-
"bridge_client_session_token",
|
|
39915
|
-
"pairing_code",
|
|
39916
|
-
"pairing_code_expires_at",
|
|
39917
|
-
"tailscale_hostname",
|
|
39918
|
-
"tailscale_auth_key",
|
|
39919
|
-
"bridge_client_name",
|
|
39920
|
-
"bridge_client_time_zone",
|
|
39921
|
-
"bridge_client_machine_identifier_key",
|
|
39922
|
-
"errors",
|
|
39923
|
-
"telemetry_token",
|
|
39924
|
-
"telemetry_token_expires_at",
|
|
39925
|
-
"telemetry_url"
|
|
39926
|
-
],
|
|
39927
|
-
type: "object",
|
|
39928
|
-
"x-route-path": "/seam/bridge/v1/bridge_client_sessions",
|
|
39929
|
-
"x-undocumented": "Seam Bridge Client only."
|
|
39930
|
-
},
|
|
40188
|
+
magic_link: { $ref: "#/components/schemas/magic_link" },
|
|
39931
40189
|
ok: { type: "boolean" }
|
|
39932
40190
|
},
|
|
39933
|
-
required: ["
|
|
40191
|
+
required: ["magic_link", "ok"],
|
|
39934
40192
|
type: "object"
|
|
39935
40193
|
}
|
|
39936
40194
|
}
|
|
@@ -39940,13 +40198,13 @@ var openapi_default = {
|
|
|
39940
40198
|
400: { description: "Bad Request" },
|
|
39941
40199
|
401: { description: "Unauthorized" }
|
|
39942
40200
|
},
|
|
39943
|
-
security: [{
|
|
39944
|
-
summary: "/unstable_partner/building_blocks/
|
|
40201
|
+
security: [{ api_key: [] }],
|
|
40202
|
+
summary: "/unstable_partner/building_blocks/generate_magic_link",
|
|
39945
40203
|
tags: [],
|
|
39946
40204
|
"x-fern-sdk-group-name": ["unstable_partner", "building_blocks"],
|
|
39947
|
-
"x-fern-sdk-method-name": "
|
|
39948
|
-
"x-fern-sdk-return-value": "
|
|
39949
|
-
"x-response-key": "
|
|
40205
|
+
"x-fern-sdk-method-name": "generate_magic_link",
|
|
40206
|
+
"x-fern-sdk-return-value": "magic_link",
|
|
40207
|
+
"x-response-key": "magic_link",
|
|
39950
40208
|
"x-title": "Generate a building block magic link",
|
|
39951
40209
|
"x-undocumented": "Experimental partner building blocks."
|
|
39952
40210
|
}
|
|
@@ -39982,7 +40240,9 @@ var openapi_default = {
|
|
|
39982
40240
|
starts_at: { type: "string" },
|
|
39983
40241
|
user_identity_key: { type: "string" }
|
|
39984
40242
|
},
|
|
39985
|
-
type: "object"
|
|
40243
|
+
type: "object",
|
|
40244
|
+
"x-route-path": "/unstable_partner/resources",
|
|
40245
|
+
"x-undocumented": "Unreleased."
|
|
39986
40246
|
},
|
|
39987
40247
|
type: "array"
|
|
39988
40248
|
},
|
|
@@ -40007,7 +40267,9 @@ var openapi_default = {
|
|
|
40007
40267
|
starts_at: { type: "string" },
|
|
40008
40268
|
user_identity_key: { type: "string" }
|
|
40009
40269
|
},
|
|
40010
|
-
type: "object"
|
|
40270
|
+
type: "object",
|
|
40271
|
+
"x-route-path": "/unstable_partner/resources",
|
|
40272
|
+
"x-undocumented": "Unreleased."
|
|
40011
40273
|
}
|
|
40012
40274
|
]
|
|
40013
40275
|
}
|