@seamapi/types 1.410.1 → 1.410.2
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 +653 -304
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +447 -111
- package/lib/seam/connect/openapi.d.ts +254 -0
- package/lib/seam/connect/openapi.js +632 -283
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +193 -111
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +763 -294
- package/src/lib/seam/connect/route-types.ts +193 -111
package/dist/connect.cjs
CHANGED
|
@@ -25446,6 +25446,7 @@ var openapi_default = {
|
|
|
25446
25446
|
},
|
|
25447
25447
|
security: [
|
|
25448
25448
|
{ client_session: [] },
|
|
25449
|
+
{ client_session_with_customer: [] },
|
|
25449
25450
|
{ pat_with_workspace: [] },
|
|
25450
25451
|
{ console_session_with_workspace: [] },
|
|
25451
25452
|
{ api_key: [] }
|
|
@@ -25578,6 +25579,7 @@ var openapi_default = {
|
|
|
25578
25579
|
},
|
|
25579
25580
|
security: [
|
|
25580
25581
|
{ client_session: [] },
|
|
25582
|
+
{ client_session_with_customer: [] },
|
|
25581
25583
|
{ pat_with_workspace: [] },
|
|
25582
25584
|
{ console_session_with_workspace: [] },
|
|
25583
25585
|
{ api_key: [] }
|
|
@@ -25711,6 +25713,7 @@ var openapi_default = {
|
|
|
25711
25713
|
},
|
|
25712
25714
|
security: [
|
|
25713
25715
|
{ client_session: [] },
|
|
25716
|
+
{ client_session_with_customer: [] },
|
|
25714
25717
|
{ pat_with_workspace: [] },
|
|
25715
25718
|
{ console_session_with_workspace: [] },
|
|
25716
25719
|
{ api_key: [] }
|
|
@@ -31920,6 +31923,7 @@ var openapi_default = {
|
|
|
31920
31923
|
},
|
|
31921
31924
|
security: [
|
|
31922
31925
|
{ client_session: [] },
|
|
31926
|
+
{ client_session_with_customer: [] },
|
|
31923
31927
|
{ api_key: [] },
|
|
31924
31928
|
{ pat_with_workspace: [] },
|
|
31925
31929
|
{ console_session_with_workspace: [] }
|
|
@@ -32672,7 +32676,8 @@ var openapi_default = {
|
|
|
32672
32676
|
security: [
|
|
32673
32677
|
{ api_key: [] },
|
|
32674
32678
|
{ pat_with_workspace: [] },
|
|
32675
|
-
{ console_session_with_workspace: [] }
|
|
32679
|
+
{ console_session_with_workspace: [] },
|
|
32680
|
+
{ client_session_with_customer: [] }
|
|
32676
32681
|
],
|
|
32677
32682
|
summary: "/devices/simulate/connect",
|
|
32678
32683
|
tags: ["/devices"],
|
|
@@ -32722,7 +32727,8 @@ var openapi_default = {
|
|
|
32722
32727
|
security: [
|
|
32723
32728
|
{ api_key: [] },
|
|
32724
32729
|
{ pat_with_workspace: [] },
|
|
32725
|
-
{ console_session_with_workspace: [] }
|
|
32730
|
+
{ console_session_with_workspace: [] },
|
|
32731
|
+
{ client_session_with_customer: [] }
|
|
32726
32732
|
],
|
|
32727
32733
|
summary: "/devices/simulate/disconnect",
|
|
32728
32734
|
tags: ["/devices"],
|
|
@@ -32772,7 +32778,8 @@ var openapi_default = {
|
|
|
32772
32778
|
security: [
|
|
32773
32779
|
{ api_key: [] },
|
|
32774
32780
|
{ pat_with_workspace: [] },
|
|
32775
|
-
{ console_session_with_workspace: [] }
|
|
32781
|
+
{ console_session_with_workspace: [] },
|
|
32782
|
+
{ client_session_with_customer: [] }
|
|
32776
32783
|
],
|
|
32777
32784
|
summary: "/devices/simulate/remove",
|
|
32778
32785
|
tags: ["/devices"],
|
|
@@ -33341,7 +33348,8 @@ var openapi_default = {
|
|
|
33341
33348
|
{ api_key: [] },
|
|
33342
33349
|
{ pat_with_workspace: [] },
|
|
33343
33350
|
{ console_session_with_workspace: [] },
|
|
33344
|
-
{ client_session: [] }
|
|
33351
|
+
{ client_session: [] },
|
|
33352
|
+
{ client_session_with_customer: [] }
|
|
33345
33353
|
],
|
|
33346
33354
|
summary: "/devices/update",
|
|
33347
33355
|
tags: ["/devices"],
|
|
@@ -33420,7 +33428,8 @@ var openapi_default = {
|
|
|
33420
33428
|
{ api_key: [] },
|
|
33421
33429
|
{ pat_with_workspace: [] },
|
|
33422
33430
|
{ console_session_with_workspace: [] },
|
|
33423
|
-
{ client_session: [] }
|
|
33431
|
+
{ client_session: [] },
|
|
33432
|
+
{ client_session_with_customer: [] }
|
|
33424
33433
|
],
|
|
33425
33434
|
summary: "/devices/update",
|
|
33426
33435
|
tags: ["/devices"],
|
|
@@ -33483,7 +33492,8 @@ var openapi_default = {
|
|
|
33483
33492
|
{ client_session: [] },
|
|
33484
33493
|
{ api_key: [] },
|
|
33485
33494
|
{ pat_with_workspace: [] },
|
|
33486
|
-
{ console_session_with_workspace: [] }
|
|
33495
|
+
{ console_session_with_workspace: [] },
|
|
33496
|
+
{ client_session_with_customer: [] }
|
|
33487
33497
|
],
|
|
33488
33498
|
summary: "/events/get",
|
|
33489
33499
|
tags: ["/events"],
|
|
@@ -35277,7 +35287,7 @@ var openapi_default = {
|
|
|
35277
35287
|
schema: {
|
|
35278
35288
|
properties: {
|
|
35279
35289
|
device_id: {
|
|
35280
|
-
description: "Device ID of the
|
|
35290
|
+
description: "Device ID of the phone that you want to deactivate.",
|
|
35281
35291
|
type: "string"
|
|
35282
35292
|
}
|
|
35283
35293
|
},
|
|
@@ -35319,7 +35329,7 @@ var openapi_default = {
|
|
|
35319
35329
|
},
|
|
35320
35330
|
"/phones/get": {
|
|
35321
35331
|
post: {
|
|
35322
|
-
description: "Returns a
|
|
35332
|
+
description: "Returns a specified [phone](https://docs.seam.co/latest/capability-guides/mobile-access/managing-phones-for-a-user-identity).",
|
|
35323
35333
|
operationId: "phonesGetPost",
|
|
35324
35334
|
requestBody: {
|
|
35325
35335
|
content: {
|
|
@@ -35327,7 +35337,7 @@ var openapi_default = {
|
|
|
35327
35337
|
schema: {
|
|
35328
35338
|
properties: {
|
|
35329
35339
|
device_id: {
|
|
35330
|
-
description: "Device ID of the
|
|
35340
|
+
description: "Device ID of the phone that you want to get.",
|
|
35331
35341
|
format: "uuid",
|
|
35332
35342
|
type: "string"
|
|
35333
35343
|
}
|
|
@@ -35368,12 +35378,12 @@ var openapi_default = {
|
|
|
35368
35378
|
"x-fern-sdk-method-name": "get",
|
|
35369
35379
|
"x-fern-sdk-return-value": "phone",
|
|
35370
35380
|
"x-response-key": "phone",
|
|
35371
|
-
"x-title": "Get Phone"
|
|
35381
|
+
"x-title": "Get a Phone"
|
|
35372
35382
|
}
|
|
35373
35383
|
},
|
|
35374
35384
|
"/phones/list": {
|
|
35375
35385
|
post: {
|
|
35376
|
-
description: "Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.",
|
|
35386
|
+
description: "Returns a list of all [phones](https://docs.seam.co/latest/capability-guides/mobile-access/managing-phones-for-a-user-identity). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.",
|
|
35377
35387
|
operationId: "phonesListPost",
|
|
35378
35388
|
requestBody: {
|
|
35379
35389
|
content: {
|
|
@@ -35381,12 +35391,12 @@ var openapi_default = {
|
|
|
35381
35391
|
schema: {
|
|
35382
35392
|
properties: {
|
|
35383
35393
|
acs_credential_id: {
|
|
35384
|
-
description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which to filter the list of returned phones.",
|
|
35394
|
+
description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which you want to filter the list of returned phones.",
|
|
35385
35395
|
format: "uuid",
|
|
35386
35396
|
type: "string"
|
|
35387
35397
|
},
|
|
35388
35398
|
owner_user_identity_id: {
|
|
35389
|
-
description: "ID of the user identity that represents the owner by which to filter the list of returned phones.",
|
|
35399
|
+
description: "ID of the user identity that represents the owner by which you want to filter the list of returned phones.",
|
|
35390
35400
|
format: "uuid",
|
|
35391
35401
|
type: "string"
|
|
35392
35402
|
}
|
|
@@ -35434,7 +35444,7 @@ var openapi_default = {
|
|
|
35434
35444
|
},
|
|
35435
35445
|
"/phones/simulate/create_sandbox_phone": {
|
|
35436
35446
|
post: {
|
|
35437
|
-
description: "Creates a new simulated phone in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).
|
|
35447
|
+
description: "Creates a new simulated phone in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](https://docs.seam.co/latest/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity).",
|
|
35438
35448
|
operationId: "phonesSimulateCreateSandboxPhonePost",
|
|
35439
35449
|
requestBody: {
|
|
35440
35450
|
content: {
|
|
@@ -35443,7 +35453,7 @@ var openapi_default = {
|
|
|
35443
35453
|
properties: {
|
|
35444
35454
|
assa_abloy_metadata: {
|
|
35445
35455
|
default: {},
|
|
35446
|
-
description: "ASSA ABLOY metadata to associate with the simulated phone.",
|
|
35456
|
+
description: "ASSA ABLOY metadata that you want to associate with the simulated phone.",
|
|
35447
35457
|
properties: {
|
|
35448
35458
|
application_version: {
|
|
35449
35459
|
default: "1.0.0",
|
|
@@ -35480,12 +35490,12 @@ var openapi_default = {
|
|
|
35480
35490
|
type: "object"
|
|
35481
35491
|
},
|
|
35482
35492
|
custom_sdk_installation_id: {
|
|
35483
|
-
description: "ID of the custom SDK installation to use for the simulated phone.",
|
|
35493
|
+
description: "ID of the custom SDK installation that you want to use for the simulated phone.",
|
|
35484
35494
|
type: "string"
|
|
35485
35495
|
},
|
|
35486
35496
|
phone_metadata: {
|
|
35487
35497
|
default: {},
|
|
35488
|
-
description: "Metadata to associate with the simulated phone.",
|
|
35498
|
+
description: "Metadata that you want to associate with the simulated phone.",
|
|
35489
35499
|
properties: {
|
|
35490
35500
|
device_manufacturer: {
|
|
35491
35501
|
default: "Samsung",
|
|
@@ -35512,7 +35522,7 @@ var openapi_default = {
|
|
|
35512
35522
|
type: "object"
|
|
35513
35523
|
},
|
|
35514
35524
|
user_identity_id: {
|
|
35515
|
-
description: "ID of the user identity to associate with the simulated phone.",
|
|
35525
|
+
description: "ID of the user identity that you want to associate with the simulated phone.",
|
|
35516
35526
|
format: "uuid",
|
|
35517
35527
|
type: "string"
|
|
35518
35528
|
}
|
|
@@ -35558,16 +35568,25 @@ var openapi_default = {
|
|
|
35558
35568
|
},
|
|
35559
35569
|
"/seam/bridge/v1/bridge_client_sessions/create": {
|
|
35560
35570
|
post: {
|
|
35561
|
-
description: "Creates a new bridge client session.",
|
|
35571
|
+
description: "Creates a new [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.",
|
|
35562
35572
|
operationId: "seamBridgeV1BridgeClientSessionsCreatePost",
|
|
35563
35573
|
requestBody: {
|
|
35564
35574
|
content: {
|
|
35565
35575
|
"application/json": {
|
|
35566
35576
|
schema: {
|
|
35567
35577
|
properties: {
|
|
35568
|
-
bridge_client_machine_identifier_key: {
|
|
35569
|
-
|
|
35570
|
-
|
|
35578
|
+
bridge_client_machine_identifier_key: {
|
|
35579
|
+
description: "Identifier key of the client machine for the Seam Bridge client that you want to create.",
|
|
35580
|
+
type: "string"
|
|
35581
|
+
},
|
|
35582
|
+
bridge_client_name: {
|
|
35583
|
+
description: "Name of the Seam Bridge client that you want to create.",
|
|
35584
|
+
type: "string"
|
|
35585
|
+
},
|
|
35586
|
+
bridge_client_time_zone: {
|
|
35587
|
+
description: "Time zone for the Seam Bridge that you want to create.",
|
|
35588
|
+
type: "string"
|
|
35589
|
+
}
|
|
35571
35590
|
},
|
|
35572
35591
|
required: [
|
|
35573
35592
|
"bridge_client_name",
|
|
@@ -35743,12 +35762,12 @@ var openapi_default = {
|
|
|
35743
35762
|
"x-fern-sdk-return-value": "bridge_client_session",
|
|
35744
35763
|
"x-response-key": "bridge_client_session",
|
|
35745
35764
|
"x-title": "Create a Bridge Client Session",
|
|
35746
|
-
"x-undocumented": "Seam Bridge
|
|
35765
|
+
"x-undocumented": "Seam Bridge client only."
|
|
35747
35766
|
}
|
|
35748
35767
|
},
|
|
35749
35768
|
"/seam/bridge/v1/bridge_client_sessions/get": {
|
|
35750
35769
|
get: {
|
|
35751
|
-
description: "Returns the bridge client session associated with the session token used.",
|
|
35770
|
+
description: "Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session associated with the client session token used for authentication.",
|
|
35752
35771
|
operationId: "seamBridgeV1BridgeClientSessionsGetGet",
|
|
35753
35772
|
responses: {
|
|
35754
35773
|
200: {
|
|
@@ -35906,11 +35925,11 @@ var openapi_default = {
|
|
|
35906
35925
|
tags: [],
|
|
35907
35926
|
"x-fern-ignore": true,
|
|
35908
35927
|
"x-response-key": "bridge_client_session",
|
|
35909
|
-
"x-title": "Get a Bridge Client Session",
|
|
35928
|
+
"x-title": "Get a Seam Bridge Client Session",
|
|
35910
35929
|
"x-undocumented": "Seam Bridge Client only."
|
|
35911
35930
|
},
|
|
35912
35931
|
post: {
|
|
35913
|
-
description: "Returns the bridge client session associated with the session token used.",
|
|
35932
|
+
description: "Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session associated with the client session token used for authentication.",
|
|
35914
35933
|
operationId: "seamBridgeV1BridgeClientSessionsGetPost",
|
|
35915
35934
|
responses: {
|
|
35916
35935
|
200: {
|
|
@@ -36075,13 +36094,13 @@ var openapi_default = {
|
|
|
36075
36094
|
"x-fern-sdk-method-name": "get",
|
|
36076
36095
|
"x-fern-sdk-return-value": "bridge_client_session",
|
|
36077
36096
|
"x-response-key": "bridge_client_session",
|
|
36078
|
-
"x-title": "Get a Bridge Client Session",
|
|
36097
|
+
"x-title": "Get a Seam Bridge Client Session",
|
|
36079
36098
|
"x-undocumented": "Seam Bridge Client only."
|
|
36080
36099
|
}
|
|
36081
36100
|
},
|
|
36082
36101
|
"/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token": {
|
|
36083
36102
|
post: {
|
|
36084
|
-
description: "Returns the bridge client session associated with the session token and refreshed telemetry token.",
|
|
36103
|
+
description: "Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session associated with the client session token used for authentication and refreshed telemetry token.",
|
|
36085
36104
|
operationId: "seamBridgeV1BridgeClientSessionsRefreshTelemetryTokenPost",
|
|
36086
36105
|
responses: {
|
|
36087
36106
|
200: {
|
|
@@ -36246,13 +36265,13 @@ var openapi_default = {
|
|
|
36246
36265
|
"x-fern-sdk-method-name": "refresh_telemetry_token",
|
|
36247
36266
|
"x-fern-sdk-return-value": "bridge_client_session",
|
|
36248
36267
|
"x-response-key": "bridge_client_session",
|
|
36249
|
-
"x-title": "Refresh
|
|
36268
|
+
"x-title": "Refresh the Telemetry Token for a Seam Bridge Client Session",
|
|
36250
36269
|
"x-undocumented": "Seam Bridge Client only."
|
|
36251
36270
|
}
|
|
36252
36271
|
},
|
|
36253
36272
|
"/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code": {
|
|
36254
36273
|
post: {
|
|
36255
|
-
description: "Generate a new pairing code and return the updated bridge client session.",
|
|
36274
|
+
description: "Generate a new pairing code and return the updated [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.",
|
|
36256
36275
|
operationId: "seamBridgeV1BridgeClientSessionsRegeneratePairingCodePost",
|
|
36257
36276
|
responses: {
|
|
36258
36277
|
200: {
|
|
@@ -36417,21 +36436,29 @@ var openapi_default = {
|
|
|
36417
36436
|
"x-fern-sdk-method-name": "regenerate_pairing_code",
|
|
36418
36437
|
"x-fern-sdk-return-value": "bridge_client_session",
|
|
36419
36438
|
"x-response-key": "bridge_client_session",
|
|
36420
|
-
"x-title": "Regenerate a Bridge Client Session Pairing Code",
|
|
36439
|
+
"x-title": "Regenerate a Seam Bridge Client Session Pairing Code",
|
|
36421
36440
|
"x-undocumented": "Seam Bridge Client only."
|
|
36422
36441
|
}
|
|
36423
36442
|
},
|
|
36424
36443
|
"/seam/bridge/v1/bridge_client_sessions/report_status": {
|
|
36425
36444
|
post: {
|
|
36426
|
-
description: "Report a Seam Bridge
|
|
36445
|
+
description: "Report the status of a [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client.",
|
|
36427
36446
|
operationId: "seamBridgeV1BridgeClientSessionsReportStatusPost",
|
|
36428
36447
|
requestBody: {
|
|
36429
36448
|
content: {
|
|
36430
36449
|
"application/json": {
|
|
36431
36450
|
schema: {
|
|
36432
36451
|
properties: {
|
|
36433
|
-
is_tailscale_connected: {
|
|
36434
|
-
|
|
36452
|
+
is_tailscale_connected: {
|
|
36453
|
+
description: "Indicates whether Tailscale is connected.",
|
|
36454
|
+
nullable: true,
|
|
36455
|
+
type: "boolean"
|
|
36456
|
+
},
|
|
36457
|
+
tailscale_ip_v4: {
|
|
36458
|
+
description: "Tailscale IPv4 address.",
|
|
36459
|
+
nullable: true,
|
|
36460
|
+
type: "string"
|
|
36461
|
+
}
|
|
36435
36462
|
},
|
|
36436
36463
|
required: ["is_tailscale_connected", "tailscale_ip_v4"],
|
|
36437
36464
|
type: "object"
|
|
@@ -36466,13 +36493,13 @@ var openapi_default = {
|
|
|
36466
36493
|
],
|
|
36467
36494
|
"x-fern-sdk-method-name": "report_status",
|
|
36468
36495
|
"x-response-key": null,
|
|
36469
|
-
"x-title": "Report a Bridge Client
|
|
36496
|
+
"x-title": "Report the Status of a Seam Bridge Client",
|
|
36470
36497
|
"x-undocumented": "Seam Bridge Client only."
|
|
36471
36498
|
}
|
|
36472
36499
|
},
|
|
36473
36500
|
"/seam/bridge/v1/bridge_connected_systems/list": {
|
|
36474
36501
|
get: {
|
|
36475
|
-
description: "Returns the bridge
|
|
36502
|
+
description: "Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)-connected systems associated with the client session token used for authentication.",
|
|
36476
36503
|
operationId: "seamBridgeV1BridgeConnectedSystemsListGet",
|
|
36477
36504
|
responses: {
|
|
36478
36505
|
200: {
|
|
@@ -36534,11 +36561,11 @@ var openapi_default = {
|
|
|
36534
36561
|
tags: [],
|
|
36535
36562
|
"x-fern-ignore": true,
|
|
36536
36563
|
"x-response-key": "bridge_connected_systems",
|
|
36537
|
-
"x-title": "List Bridge
|
|
36564
|
+
"x-title": "List Bridge-Connected Systems",
|
|
36538
36565
|
"x-undocumented": "Seam Bridge Client only."
|
|
36539
36566
|
},
|
|
36540
36567
|
post: {
|
|
36541
|
-
description: "Returns the bridge
|
|
36568
|
+
description: "Returns the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge)-connected systems associated with the client session token used for authentication.",
|
|
36542
36569
|
operationId: "seamBridgeV1BridgeConnectedSystemsListPost",
|
|
36543
36570
|
responses: {
|
|
36544
36571
|
200: {
|
|
@@ -36607,13 +36634,13 @@ var openapi_default = {
|
|
|
36607
36634
|
"x-fern-sdk-method-name": "list",
|
|
36608
36635
|
"x-fern-sdk-return-value": "bridge_connected_systems",
|
|
36609
36636
|
"x-response-key": "bridge_connected_systems",
|
|
36610
|
-
"x-title": "List Bridge
|
|
36637
|
+
"x-title": "List Bridge-Connected Systems",
|
|
36611
36638
|
"x-undocumented": "Seam Bridge Client only."
|
|
36612
36639
|
}
|
|
36613
36640
|
},
|
|
36614
36641
|
"/seam/instant_key/v1/client_sessions/exchange_short_code": {
|
|
36615
36642
|
post: {
|
|
36616
|
-
description: "Exchanges a short code for a
|
|
36643
|
+
description: "Exchanges a short code for a client session token. Mobile apps use this endpoint to retrieve a client session token securely using a short code obtained from an Instant Key URL.",
|
|
36617
36644
|
operationId: "seamInstantKeyV1ClientSessionsExchangeShortCodePost",
|
|
36618
36645
|
requestBody: {
|
|
36619
36646
|
content: {
|
|
@@ -36621,7 +36648,7 @@ var openapi_default = {
|
|
|
36621
36648
|
schema: {
|
|
36622
36649
|
properties: {
|
|
36623
36650
|
short_code: {
|
|
36624
|
-
description: "
|
|
36651
|
+
description: "Short code that you want to exchange for a client session token.",
|
|
36625
36652
|
type: "string"
|
|
36626
36653
|
}
|
|
36627
36654
|
},
|
|
@@ -36670,7 +36697,7 @@ var openapi_default = {
|
|
|
36670
36697
|
},
|
|
36671
36698
|
"/seam/mobile_sdk/v1/acs/credentials/list": {
|
|
36672
36699
|
post: {
|
|
36673
|
-
description: "Returns a list of all
|
|
36700
|
+
description: "Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
36674
36701
|
operationId: "seamMobileSdkV1AcsCredentialsListPost",
|
|
36675
36702
|
requestBody: {
|
|
36676
36703
|
content: {
|
|
@@ -36718,15 +36745,19 @@ var openapi_default = {
|
|
|
36718
36745
|
},
|
|
36719
36746
|
"/seam/mobile_sdk/v1/phone_sessions/get_or_create": {
|
|
36720
36747
|
post: {
|
|
36721
|
-
description: "
|
|
36748
|
+
description: "Gets or creates a session for a mobile SDK phone.",
|
|
36722
36749
|
operationId: "seamMobileSdkV1PhoneSessionsGetOrCreatePost",
|
|
36723
36750
|
requestBody: {
|
|
36724
36751
|
content: {
|
|
36725
36752
|
"application/json": {
|
|
36726
36753
|
schema: {
|
|
36727
36754
|
properties: {
|
|
36728
|
-
custom_sdk_installation_id: {
|
|
36755
|
+
custom_sdk_installation_id: {
|
|
36756
|
+
description: "ID of the custom SDK installation that you want to use for the new session.",
|
|
36757
|
+
type: "string"
|
|
36758
|
+
},
|
|
36729
36759
|
phone_device_metadata: {
|
|
36760
|
+
description: "Phone device metadata that you want to use for the new session.",
|
|
36730
36761
|
properties: {
|
|
36731
36762
|
manufacturer: { type: "string" },
|
|
36732
36763
|
model: { type: "string" },
|
|
@@ -36734,7 +36765,11 @@ var openapi_default = {
|
|
|
36734
36765
|
},
|
|
36735
36766
|
type: "object"
|
|
36736
36767
|
},
|
|
36737
|
-
phone_os: {
|
|
36768
|
+
phone_os: {
|
|
36769
|
+
description: "Phone operating system that you want to use for the new session.",
|
|
36770
|
+
enum: ["ios", "android"],
|
|
36771
|
+
type: "string"
|
|
36772
|
+
}
|
|
36738
36773
|
},
|
|
36739
36774
|
required: ["custom_sdk_installation_id", "phone_os"],
|
|
36740
36775
|
type: "object"
|
|
@@ -36776,13 +36811,18 @@ var openapi_default = {
|
|
|
36776
36811
|
},
|
|
36777
36812
|
"/seam/partner/v1/building_blocks/spaces/auto_map": {
|
|
36778
36813
|
post: {
|
|
36779
|
-
description: "Auto
|
|
36814
|
+
description: "Auto-maps partner resources that have been pushed to Seam.",
|
|
36780
36815
|
operationId: "seamPartnerV1BuildingBlocksSpacesAutoMapPost",
|
|
36781
36816
|
requestBody: {
|
|
36782
36817
|
content: {
|
|
36783
36818
|
"application/json": {
|
|
36784
36819
|
schema: {
|
|
36785
|
-
properties: {
|
|
36820
|
+
properties: {
|
|
36821
|
+
collection_key: {
|
|
36822
|
+
description: "Collection key.",
|
|
36823
|
+
type: "string"
|
|
36824
|
+
}
|
|
36825
|
+
},
|
|
36786
36826
|
required: ["collection_key"],
|
|
36787
36827
|
type: "object"
|
|
36788
36828
|
}
|
|
@@ -36863,13 +36903,13 @@ var openapi_default = {
|
|
|
36863
36903
|
"x-fern-sdk-method-name": "auto_map",
|
|
36864
36904
|
"x-fern-sdk-return-value": "spaces",
|
|
36865
36905
|
"x-response-key": "spaces",
|
|
36866
|
-
"x-title": "Do
|
|
36906
|
+
"x-title": "Do Auto-Mapping for Partner Resources that Map to Spaces",
|
|
36867
36907
|
"x-undocumented": "Partner building blocks/UI only."
|
|
36868
36908
|
}
|
|
36869
36909
|
},
|
|
36870
36910
|
"/seam/partner/v1/resources/list": {
|
|
36871
36911
|
post: {
|
|
36872
|
-
description: "
|
|
36912
|
+
description: "Lists partner resources that have been pushed to Seam.",
|
|
36873
36913
|
operationId: "seamPartnerV1ResourcesListPost",
|
|
36874
36914
|
requestBody: {
|
|
36875
36915
|
content: {
|
|
@@ -36877,7 +36917,7 @@ var openapi_default = {
|
|
|
36877
36917
|
schema: {
|
|
36878
36918
|
properties: {
|
|
36879
36919
|
resource_type_alias: {
|
|
36880
|
-
description: "
|
|
36920
|
+
description: "Resource type alias by which you want to filter partner resources.",
|
|
36881
36921
|
type: "string"
|
|
36882
36922
|
}
|
|
36883
36923
|
},
|
|
@@ -36944,13 +36984,13 @@ var openapi_default = {
|
|
|
36944
36984
|
"x-fern-sdk-method-name": "list",
|
|
36945
36985
|
"x-fern-sdk-return-value": "partner_resources",
|
|
36946
36986
|
"x-response-key": "partner_resources",
|
|
36947
|
-
"x-title": "List
|
|
36987
|
+
"x-title": "List Partner Resources at Seam",
|
|
36948
36988
|
"x-undocumented": "Partner building blocks/UI only."
|
|
36949
36989
|
}
|
|
36950
36990
|
},
|
|
36951
36991
|
"/spaces/add_acs_entrances": {
|
|
36952
36992
|
post: {
|
|
36953
|
-
description: "
|
|
36993
|
+
description: "Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.",
|
|
36954
36994
|
operationId: "spacesAddAcsEntrancesPost",
|
|
36955
36995
|
requestBody: {
|
|
36956
36996
|
content: {
|
|
@@ -36958,11 +36998,16 @@ var openapi_default = {
|
|
|
36958
36998
|
schema: {
|
|
36959
36999
|
properties: {
|
|
36960
37000
|
acs_entrance_ids: {
|
|
37001
|
+
description: "IDs of the entrances that you want to add to the space.",
|
|
36961
37002
|
items: { format: "uuid", type: "string" },
|
|
36962
37003
|
minItems: 1,
|
|
36963
37004
|
type: "array"
|
|
36964
37005
|
},
|
|
36965
|
-
space_id: {
|
|
37006
|
+
space_id: {
|
|
37007
|
+
description: "ID of the space to which you want to add entrances.",
|
|
37008
|
+
format: "uuid",
|
|
37009
|
+
type: "string"
|
|
37010
|
+
}
|
|
36966
37011
|
},
|
|
36967
37012
|
required: ["space_id", "acs_entrance_ids"],
|
|
36968
37013
|
type: "object"
|
|
@@ -36997,10 +37042,10 @@ var openapi_default = {
|
|
|
36997
37042
|
"x-fern-sdk-group-name": ["spaces"],
|
|
36998
37043
|
"x-fern-sdk-method-name": "add_acs_entrances",
|
|
36999
37044
|
"x-response-key": null,
|
|
37000
|
-
"x-title": "Add
|
|
37045
|
+
"x-title": "Add Entrances to a Space"
|
|
37001
37046
|
},
|
|
37002
37047
|
put: {
|
|
37003
|
-
description: "
|
|
37048
|
+
description: "Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.",
|
|
37004
37049
|
operationId: "spacesAddAcsEntrancesPut",
|
|
37005
37050
|
requestBody: {
|
|
37006
37051
|
content: {
|
|
@@ -37008,11 +37053,16 @@ var openapi_default = {
|
|
|
37008
37053
|
schema: {
|
|
37009
37054
|
properties: {
|
|
37010
37055
|
acs_entrance_ids: {
|
|
37056
|
+
description: "IDs of the entrances that you want to add to the space.",
|
|
37011
37057
|
items: { format: "uuid", type: "string" },
|
|
37012
37058
|
minItems: 1,
|
|
37013
37059
|
type: "array"
|
|
37014
37060
|
},
|
|
37015
|
-
space_id: {
|
|
37061
|
+
space_id: {
|
|
37062
|
+
description: "ID of the space to which you want to add entrances.",
|
|
37063
|
+
format: "uuid",
|
|
37064
|
+
type: "string"
|
|
37065
|
+
}
|
|
37016
37066
|
},
|
|
37017
37067
|
required: ["space_id", "acs_entrance_ids"],
|
|
37018
37068
|
type: "object"
|
|
@@ -37046,12 +37096,12 @@ var openapi_default = {
|
|
|
37046
37096
|
"x-draft": "Early access.",
|
|
37047
37097
|
"x-fern-ignore": true,
|
|
37048
37098
|
"x-response-key": null,
|
|
37049
|
-
"x-title": "Add
|
|
37099
|
+
"x-title": "Add Entrances to a Space"
|
|
37050
37100
|
}
|
|
37051
37101
|
},
|
|
37052
37102
|
"/spaces/add_devices": {
|
|
37053
37103
|
post: {
|
|
37054
|
-
description: "
|
|
37104
|
+
description: "Adds devices to a specific space.",
|
|
37055
37105
|
operationId: "spacesAddDevicesPost",
|
|
37056
37106
|
requestBody: {
|
|
37057
37107
|
content: {
|
|
@@ -37059,11 +37109,16 @@ var openapi_default = {
|
|
|
37059
37109
|
schema: {
|
|
37060
37110
|
properties: {
|
|
37061
37111
|
device_ids: {
|
|
37112
|
+
description: "IDs of the devices that you want to add to the space.",
|
|
37062
37113
|
items: { format: "uuid", type: "string" },
|
|
37063
37114
|
minItems: 1,
|
|
37064
37115
|
type: "array"
|
|
37065
37116
|
},
|
|
37066
|
-
space_id: {
|
|
37117
|
+
space_id: {
|
|
37118
|
+
description: "ID of the space to which you want to add devices.",
|
|
37119
|
+
format: "uuid",
|
|
37120
|
+
type: "string"
|
|
37121
|
+
}
|
|
37067
37122
|
},
|
|
37068
37123
|
required: ["space_id", "device_ids"],
|
|
37069
37124
|
type: "object"
|
|
@@ -37098,10 +37153,10 @@ var openapi_default = {
|
|
|
37098
37153
|
"x-fern-sdk-group-name": ["spaces"],
|
|
37099
37154
|
"x-fern-sdk-method-name": "add_devices",
|
|
37100
37155
|
"x-response-key": null,
|
|
37101
|
-
"x-title": "Add Space
|
|
37156
|
+
"x-title": "Add Devices to a Space"
|
|
37102
37157
|
},
|
|
37103
37158
|
put: {
|
|
37104
|
-
description: "
|
|
37159
|
+
description: "Adds devices to a specific space.",
|
|
37105
37160
|
operationId: "spacesAddDevicesPut",
|
|
37106
37161
|
requestBody: {
|
|
37107
37162
|
content: {
|
|
@@ -37109,11 +37164,16 @@ var openapi_default = {
|
|
|
37109
37164
|
schema: {
|
|
37110
37165
|
properties: {
|
|
37111
37166
|
device_ids: {
|
|
37167
|
+
description: "IDs of the devices that you want to add to the space.",
|
|
37112
37168
|
items: { format: "uuid", type: "string" },
|
|
37113
37169
|
minItems: 1,
|
|
37114
37170
|
type: "array"
|
|
37115
37171
|
},
|
|
37116
|
-
space_id: {
|
|
37172
|
+
space_id: {
|
|
37173
|
+
description: "ID of the space to which you want to add devices.",
|
|
37174
|
+
format: "uuid",
|
|
37175
|
+
type: "string"
|
|
37176
|
+
}
|
|
37117
37177
|
},
|
|
37118
37178
|
required: ["space_id", "device_ids"],
|
|
37119
37179
|
type: "object"
|
|
@@ -37147,12 +37207,12 @@ var openapi_default = {
|
|
|
37147
37207
|
"x-draft": "Early access.",
|
|
37148
37208
|
"x-fern-ignore": true,
|
|
37149
37209
|
"x-response-key": null,
|
|
37150
|
-
"x-title": "Add Space
|
|
37210
|
+
"x-title": "Add Devices to a Space"
|
|
37151
37211
|
}
|
|
37152
37212
|
},
|
|
37153
37213
|
"/spaces/create": {
|
|
37154
37214
|
post: {
|
|
37155
|
-
description: "
|
|
37215
|
+
description: "Creates a new space.",
|
|
37156
37216
|
operationId: "spacesCreatePost",
|
|
37157
37217
|
requestBody: {
|
|
37158
37218
|
content: {
|
|
@@ -37160,14 +37220,19 @@ var openapi_default = {
|
|
|
37160
37220
|
schema: {
|
|
37161
37221
|
properties: {
|
|
37162
37222
|
acs_entrance_ids: {
|
|
37223
|
+
description: "IDs of the entrances that you want to add to the new space.",
|
|
37163
37224
|
items: { format: "uuid", type: "string" },
|
|
37164
37225
|
type: "array"
|
|
37165
37226
|
},
|
|
37166
37227
|
device_ids: {
|
|
37228
|
+
description: "IDs of the devices that you want to add to the new space.",
|
|
37167
37229
|
items: { format: "uuid", type: "string" },
|
|
37168
37230
|
type: "array"
|
|
37169
37231
|
},
|
|
37170
|
-
name: {
|
|
37232
|
+
name: {
|
|
37233
|
+
description: "Name of the space that you want to create.",
|
|
37234
|
+
type: "string"
|
|
37235
|
+
}
|
|
37171
37236
|
},
|
|
37172
37237
|
required: ["name"],
|
|
37173
37238
|
type: "object"
|
|
@@ -37206,18 +37271,24 @@ var openapi_default = {
|
|
|
37206
37271
|
"x-fern-sdk-method-name": "create",
|
|
37207
37272
|
"x-fern-sdk-return-value": "space",
|
|
37208
37273
|
"x-response-key": "space",
|
|
37209
|
-
"x-title": "Create Space"
|
|
37274
|
+
"x-title": "Create a Space"
|
|
37210
37275
|
}
|
|
37211
37276
|
},
|
|
37212
37277
|
"/spaces/delete": {
|
|
37213
37278
|
post: {
|
|
37214
|
-
description: "
|
|
37279
|
+
description: "Deletes a space.",
|
|
37215
37280
|
operationId: "spacesDeletePost",
|
|
37216
37281
|
requestBody: {
|
|
37217
37282
|
content: {
|
|
37218
37283
|
"application/json": {
|
|
37219
37284
|
schema: {
|
|
37220
|
-
properties: {
|
|
37285
|
+
properties: {
|
|
37286
|
+
space_id: {
|
|
37287
|
+
description: "ID of the space that you want to delete.",
|
|
37288
|
+
format: "uuid",
|
|
37289
|
+
type: "string"
|
|
37290
|
+
}
|
|
37291
|
+
},
|
|
37221
37292
|
required: ["space_id"],
|
|
37222
37293
|
type: "object"
|
|
37223
37294
|
}
|
|
@@ -37247,21 +37318,28 @@ var openapi_default = {
|
|
|
37247
37318
|
],
|
|
37248
37319
|
summary: "/spaces/delete",
|
|
37249
37320
|
tags: [],
|
|
37321
|
+
"x-draft": "Early access.",
|
|
37250
37322
|
"x-fern-sdk-group-name": ["spaces"],
|
|
37251
37323
|
"x-fern-sdk-method-name": "delete",
|
|
37252
37324
|
"x-response-key": null,
|
|
37253
|
-
"x-title": "Delete Space"
|
|
37325
|
+
"x-title": "Delete a Space"
|
|
37254
37326
|
}
|
|
37255
37327
|
},
|
|
37256
37328
|
"/spaces/get": {
|
|
37257
37329
|
post: {
|
|
37258
|
-
description: "
|
|
37330
|
+
description: "Gets a space.",
|
|
37259
37331
|
operationId: "spacesGetPost",
|
|
37260
37332
|
requestBody: {
|
|
37261
37333
|
content: {
|
|
37262
37334
|
"application/json": {
|
|
37263
37335
|
schema: {
|
|
37264
|
-
properties: {
|
|
37336
|
+
properties: {
|
|
37337
|
+
space_id: {
|
|
37338
|
+
description: "ID of the space that you want to get.",
|
|
37339
|
+
format: "uuid",
|
|
37340
|
+
type: "string"
|
|
37341
|
+
}
|
|
37342
|
+
},
|
|
37265
37343
|
required: ["space_id"],
|
|
37266
37344
|
type: "object"
|
|
37267
37345
|
}
|
|
@@ -37294,11 +37372,12 @@ var openapi_default = {
|
|
|
37294
37372
|
],
|
|
37295
37373
|
summary: "/spaces/get",
|
|
37296
37374
|
tags: [],
|
|
37375
|
+
"x-draft": "Early access.",
|
|
37297
37376
|
"x-fern-sdk-group-name": ["spaces"],
|
|
37298
37377
|
"x-fern-sdk-method-name": "get",
|
|
37299
37378
|
"x-fern-sdk-return-value": "space",
|
|
37300
37379
|
"x-response-key": "space",
|
|
37301
|
-
"x-title": "Get Space"
|
|
37380
|
+
"x-title": "Get a Space"
|
|
37302
37381
|
}
|
|
37303
37382
|
},
|
|
37304
37383
|
"/spaces/list": {
|
|
@@ -37381,7 +37460,7 @@ var openapi_default = {
|
|
|
37381
37460
|
},
|
|
37382
37461
|
"/spaces/remove_acs_entrances": {
|
|
37383
37462
|
post: {
|
|
37384
|
-
description: "
|
|
37463
|
+
description: "Removes [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) from a specific space.",
|
|
37385
37464
|
operationId: "spacesRemoveAcsEntrancesPost",
|
|
37386
37465
|
requestBody: {
|
|
37387
37466
|
content: {
|
|
@@ -37389,10 +37468,15 @@ var openapi_default = {
|
|
|
37389
37468
|
schema: {
|
|
37390
37469
|
properties: {
|
|
37391
37470
|
acs_entrance_ids: {
|
|
37471
|
+
description: "IDs of the entrances that you want to remove from the space.",
|
|
37392
37472
|
items: { format: "uuid", type: "string" },
|
|
37393
37473
|
type: "array"
|
|
37394
37474
|
},
|
|
37395
|
-
space_id: {
|
|
37475
|
+
space_id: {
|
|
37476
|
+
description: "ID of the space from which you want to remove entrances.",
|
|
37477
|
+
format: "uuid",
|
|
37478
|
+
type: "string"
|
|
37479
|
+
}
|
|
37396
37480
|
},
|
|
37397
37481
|
required: ["space_id", "acs_entrance_ids"],
|
|
37398
37482
|
type: "object"
|
|
@@ -37427,12 +37511,12 @@ var openapi_default = {
|
|
|
37427
37511
|
"x-fern-sdk-group-name": ["spaces"],
|
|
37428
37512
|
"x-fern-sdk-method-name": "remove_acs_entrances",
|
|
37429
37513
|
"x-response-key": null,
|
|
37430
|
-
"x-title": "Remove
|
|
37514
|
+
"x-title": "Remove Entrances from a Space"
|
|
37431
37515
|
}
|
|
37432
37516
|
},
|
|
37433
37517
|
"/spaces/remove_devices": {
|
|
37434
37518
|
post: {
|
|
37435
|
-
description: "
|
|
37519
|
+
description: "Removes devices from a specific space.",
|
|
37436
37520
|
operationId: "spacesRemoveDevicesPost",
|
|
37437
37521
|
requestBody: {
|
|
37438
37522
|
content: {
|
|
@@ -37440,10 +37524,15 @@ var openapi_default = {
|
|
|
37440
37524
|
schema: {
|
|
37441
37525
|
properties: {
|
|
37442
37526
|
device_ids: {
|
|
37527
|
+
description: "IDs of the devices that you want to remove from the space.",
|
|
37443
37528
|
items: { format: "uuid", type: "string" },
|
|
37444
37529
|
type: "array"
|
|
37445
37530
|
},
|
|
37446
|
-
space_id: {
|
|
37531
|
+
space_id: {
|
|
37532
|
+
description: "ID of the space from which you want to remove devices.",
|
|
37533
|
+
format: "uuid",
|
|
37534
|
+
type: "string"
|
|
37535
|
+
}
|
|
37447
37536
|
},
|
|
37448
37537
|
required: ["space_id", "device_ids"],
|
|
37449
37538
|
type: "object"
|
|
@@ -37478,20 +37567,24 @@ var openapi_default = {
|
|
|
37478
37567
|
"x-fern-sdk-group-name": ["spaces"],
|
|
37479
37568
|
"x-fern-sdk-method-name": "remove_devices",
|
|
37480
37569
|
"x-response-key": null,
|
|
37481
|
-
"x-title": "Remove Space
|
|
37570
|
+
"x-title": "Remove Devices from a Space"
|
|
37482
37571
|
}
|
|
37483
37572
|
},
|
|
37484
37573
|
"/spaces/update": {
|
|
37485
37574
|
patch: {
|
|
37486
|
-
description: "
|
|
37575
|
+
description: "Updates an existing space.",
|
|
37487
37576
|
operationId: "spacesUpdatePatch",
|
|
37488
37577
|
requestBody: {
|
|
37489
37578
|
content: {
|
|
37490
37579
|
"application/json": {
|
|
37491
37580
|
schema: {
|
|
37492
37581
|
properties: {
|
|
37493
|
-
name: { type: "string" },
|
|
37494
|
-
space_id: {
|
|
37582
|
+
name: { description: "Name of the space.", type: "string" },
|
|
37583
|
+
space_id: {
|
|
37584
|
+
description: "ID of the space that you want to update.",
|
|
37585
|
+
format: "uuid",
|
|
37586
|
+
type: "string"
|
|
37587
|
+
}
|
|
37495
37588
|
},
|
|
37496
37589
|
required: ["space_id"],
|
|
37497
37590
|
type: "object"
|
|
@@ -37528,18 +37621,22 @@ var openapi_default = {
|
|
|
37528
37621
|
"x-draft": "Early access.",
|
|
37529
37622
|
"x-fern-ignore": true,
|
|
37530
37623
|
"x-response-key": "space",
|
|
37531
|
-
"x-title": "Update Space"
|
|
37624
|
+
"x-title": "Update a Space"
|
|
37532
37625
|
},
|
|
37533
37626
|
post: {
|
|
37534
|
-
description: "
|
|
37627
|
+
description: "Updates an existing space.",
|
|
37535
37628
|
operationId: "spacesUpdatePost",
|
|
37536
37629
|
requestBody: {
|
|
37537
37630
|
content: {
|
|
37538
37631
|
"application/json": {
|
|
37539
37632
|
schema: {
|
|
37540
37633
|
properties: {
|
|
37541
|
-
name: { type: "string" },
|
|
37542
|
-
space_id: {
|
|
37634
|
+
name: { description: "Name of the space.", type: "string" },
|
|
37635
|
+
space_id: {
|
|
37636
|
+
description: "ID of the space that you want to update.",
|
|
37637
|
+
format: "uuid",
|
|
37638
|
+
type: "string"
|
|
37639
|
+
}
|
|
37543
37640
|
},
|
|
37544
37641
|
required: ["space_id"],
|
|
37545
37642
|
type: "object"
|
|
@@ -37578,7 +37675,7 @@ var openapi_default = {
|
|
|
37578
37675
|
"x-fern-sdk-method-name": "update",
|
|
37579
37676
|
"x-fern-sdk-return-value": "space",
|
|
37580
37677
|
"x-response-key": "space",
|
|
37581
|
-
"x-title": "Update Space"
|
|
37678
|
+
"x-title": "Update a Space"
|
|
37582
37679
|
}
|
|
37583
37680
|
},
|
|
37584
37681
|
"/thermostats/activate_climate_preset": {
|
|
@@ -37652,12 +37749,12 @@ var openapi_default = {
|
|
|
37652
37749
|
schema: {
|
|
37653
37750
|
properties: {
|
|
37654
37751
|
cooling_set_point_celsius: {
|
|
37655
|
-
description: "
|
|
37752
|
+
description: "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.",
|
|
37656
37753
|
format: "float",
|
|
37657
37754
|
type: "number"
|
|
37658
37755
|
},
|
|
37659
37756
|
cooling_set_point_fahrenheit: {
|
|
37660
|
-
description: "
|
|
37757
|
+
description: "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.",
|
|
37661
37758
|
format: "float",
|
|
37662
37759
|
type: "number"
|
|
37663
37760
|
},
|
|
@@ -37815,7 +37912,7 @@ var openapi_default = {
|
|
|
37815
37912
|
},
|
|
37816
37913
|
"/thermostats/daily_programs/create": {
|
|
37817
37914
|
post: {
|
|
37818
|
-
description: "Creates a thermostat daily program. A daily program consists of a set of periods, where each period includes a start time and the key of a configured climate preset. Once you have defined a daily program, you can assign it to one or more days within a weekly program.",
|
|
37915
|
+
description: "Creates a new thermostat daily program. A daily program consists of a set of periods, where each period includes a start time and the key of a configured climate preset. Once you have defined a daily program, you can assign it to one or more days within a weekly program.",
|
|
37819
37916
|
operationId: "thermostatsDailyProgramsCreatePost",
|
|
37820
37917
|
requestBody: {
|
|
37821
37918
|
content: {
|
|
@@ -37828,7 +37925,7 @@ var openapi_default = {
|
|
|
37828
37925
|
type: "string"
|
|
37829
37926
|
},
|
|
37830
37927
|
name: {
|
|
37831
|
-
description: "
|
|
37928
|
+
description: "Name of the thermostat daily program.",
|
|
37832
37929
|
type: "string"
|
|
37833
37930
|
},
|
|
37834
37931
|
periods: {
|
|
@@ -38012,7 +38109,7 @@ var openapi_default = {
|
|
|
38012
38109
|
schema: {
|
|
38013
38110
|
properties: {
|
|
38014
38111
|
name: {
|
|
38015
|
-
description: "
|
|
38112
|
+
description: "Name of the thermostat daily program that you want to update.",
|
|
38016
38113
|
type: "string"
|
|
38017
38114
|
},
|
|
38018
38115
|
periods: {
|
|
@@ -38090,7 +38187,7 @@ var openapi_default = {
|
|
|
38090
38187
|
schema: {
|
|
38091
38188
|
properties: {
|
|
38092
38189
|
name: {
|
|
38093
|
-
description: "
|
|
38190
|
+
description: "Name of the thermostat daily program that you want to update.",
|
|
38094
38191
|
type: "string"
|
|
38095
38192
|
},
|
|
38096
38193
|
periods: {
|
|
@@ -38219,7 +38316,7 @@ var openapi_default = {
|
|
|
38219
38316
|
},
|
|
38220
38317
|
"/thermostats/get": {
|
|
38221
38318
|
post: {
|
|
38222
|
-
description: "Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
|
|
38319
|
+
description: "Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). **Deprecated:** Will be removed. Use `/devices/get` instead.",
|
|
38223
38320
|
operationId: "thermostatsGetPost",
|
|
38224
38321
|
requestBody: {
|
|
38225
38322
|
content: {
|
|
@@ -38227,12 +38324,12 @@ var openapi_default = {
|
|
|
38227
38324
|
schema: {
|
|
38228
38325
|
properties: {
|
|
38229
38326
|
device_id: {
|
|
38230
|
-
description: "ID of the thermostat device that you want to
|
|
38327
|
+
description: "ID of the thermostat device that you want to get.",
|
|
38231
38328
|
format: "uuid",
|
|
38232
38329
|
type: "string"
|
|
38233
38330
|
},
|
|
38234
38331
|
name: {
|
|
38235
|
-
description: "
|
|
38332
|
+
description: "Name of the thermostat device that you want to retrieve.",
|
|
38236
38333
|
type: "string"
|
|
38237
38334
|
}
|
|
38238
38335
|
},
|
|
@@ -38292,12 +38389,12 @@ var openapi_default = {
|
|
|
38292
38389
|
type: "string"
|
|
38293
38390
|
},
|
|
38294
38391
|
heating_set_point_celsius: {
|
|
38295
|
-
description: "
|
|
38392
|
+
description: "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.",
|
|
38296
38393
|
format: "float",
|
|
38297
38394
|
type: "number"
|
|
38298
38395
|
},
|
|
38299
38396
|
heating_set_point_fahrenheit: {
|
|
38300
|
-
description: "
|
|
38397
|
+
description: "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.",
|
|
38301
38398
|
format: "float",
|
|
38302
38399
|
type: "number"
|
|
38303
38400
|
},
|
|
@@ -38360,12 +38457,12 @@ var openapi_default = {
|
|
|
38360
38457
|
schema: {
|
|
38361
38458
|
properties: {
|
|
38362
38459
|
cooling_set_point_celsius: {
|
|
38363
|
-
description: "
|
|
38460
|
+
description: "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.",
|
|
38364
38461
|
format: "float",
|
|
38365
38462
|
type: "number"
|
|
38366
38463
|
},
|
|
38367
38464
|
cooling_set_point_fahrenheit: {
|
|
38368
|
-
description: "
|
|
38465
|
+
description: "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.",
|
|
38369
38466
|
format: "float",
|
|
38370
38467
|
type: "number"
|
|
38371
38468
|
},
|
|
@@ -38375,12 +38472,12 @@ var openapi_default = {
|
|
|
38375
38472
|
type: "string"
|
|
38376
38473
|
},
|
|
38377
38474
|
heating_set_point_celsius: {
|
|
38378
|
-
description: "
|
|
38475
|
+
description: "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.",
|
|
38379
38476
|
format: "float",
|
|
38380
38477
|
type: "number"
|
|
38381
38478
|
},
|
|
38382
38479
|
heating_set_point_fahrenheit: {
|
|
38383
|
-
description: "
|
|
38480
|
+
description: "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.",
|
|
38384
38481
|
format: "float",
|
|
38385
38482
|
type: "number"
|
|
38386
38483
|
},
|
|
@@ -38479,7 +38576,7 @@ var openapi_default = {
|
|
|
38479
38576
|
type: "array"
|
|
38480
38577
|
},
|
|
38481
38578
|
device_type: {
|
|
38482
|
-
description: "Device type by which to filter thermostat devices.",
|
|
38579
|
+
description: "Device type by which you want to filter thermostat devices.",
|
|
38483
38580
|
enum: [
|
|
38484
38581
|
"ecobee_thermostat",
|
|
38485
38582
|
"nest_thermostat",
|
|
@@ -38491,7 +38588,7 @@ var openapi_default = {
|
|
|
38491
38588
|
type: "string"
|
|
38492
38589
|
},
|
|
38493
38590
|
device_types: {
|
|
38494
|
-
description: "Array of device types by which to filter thermostat devices.",
|
|
38591
|
+
description: "Array of device types by which you want to filter thermostat devices.",
|
|
38495
38592
|
items: {
|
|
38496
38593
|
description: "Device type for thermostats.\n ",
|
|
38497
38594
|
enum: [
|
|
@@ -38553,7 +38650,7 @@ var openapi_default = {
|
|
|
38553
38650
|
type: "number"
|
|
38554
38651
|
},
|
|
38555
38652
|
manufacturer: {
|
|
38556
|
-
description: "Manufacturer by which to filter thermostat devices.",
|
|
38653
|
+
description: "Manufacturer by which you want to filter thermostat devices.",
|
|
38557
38654
|
enum: [
|
|
38558
38655
|
"ecobee",
|
|
38559
38656
|
"honeywell_resideo",
|
|
@@ -38697,7 +38794,7 @@ var openapi_default = {
|
|
|
38697
38794
|
},
|
|
38698
38795
|
"/thermostats/schedules/create": {
|
|
38699
38796
|
post: {
|
|
38700
|
-
description: "Creates a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
|
|
38797
|
+
description: "Creates a new [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
|
|
38701
38798
|
operationId: "thermostatsSchedulesCreatePost",
|
|
38702
38799
|
requestBody: {
|
|
38703
38800
|
content: {
|
|
@@ -38705,19 +38802,19 @@ var openapi_default = {
|
|
|
38705
38802
|
schema: {
|
|
38706
38803
|
properties: {
|
|
38707
38804
|
climate_preset_key: {
|
|
38708
|
-
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
|
|
38805
|
+
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the new thermostat schedule.",
|
|
38709
38806
|
type: "string"
|
|
38710
38807
|
},
|
|
38711
38808
|
device_id: {
|
|
38712
|
-
description: "ID of the
|
|
38809
|
+
description: "ID of the thermostat device for which you want to create a schedule.",
|
|
38713
38810
|
type: "string"
|
|
38714
38811
|
},
|
|
38715
38812
|
ends_at: {
|
|
38716
|
-
description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
38813
|
+
description: "Date and time at which the new thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
38717
38814
|
type: "string"
|
|
38718
38815
|
},
|
|
38719
38816
|
is_override_allowed: {
|
|
38720
|
-
description: "Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
|
|
38817
|
+
description: "Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the new schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
|
|
38721
38818
|
type: "boolean"
|
|
38722
38819
|
},
|
|
38723
38820
|
max_override_period_minutes: {
|
|
@@ -38728,11 +38825,11 @@ var openapi_default = {
|
|
|
38728
38825
|
type: "integer"
|
|
38729
38826
|
},
|
|
38730
38827
|
name: {
|
|
38731
|
-
description: "
|
|
38828
|
+
description: "Name of the thermostat schedule.",
|
|
38732
38829
|
type: "string"
|
|
38733
38830
|
},
|
|
38734
38831
|
starts_at: {
|
|
38735
|
-
description: "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
38832
|
+
description: "Date and time at which the new thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
38736
38833
|
type: "string"
|
|
38737
38834
|
}
|
|
38738
38835
|
},
|
|
@@ -38793,7 +38890,7 @@ var openapi_default = {
|
|
|
38793
38890
|
schema: {
|
|
38794
38891
|
properties: {
|
|
38795
38892
|
thermostat_schedule_id: {
|
|
38796
|
-
description: "ID of the
|
|
38893
|
+
description: "ID of the thermostat schedule that you want to delete.",
|
|
38797
38894
|
format: "uuid",
|
|
38798
38895
|
type: "string"
|
|
38799
38896
|
}
|
|
@@ -38844,7 +38941,7 @@ var openapi_default = {
|
|
|
38844
38941
|
schema: {
|
|
38845
38942
|
properties: {
|
|
38846
38943
|
thermostat_schedule_id: {
|
|
38847
|
-
description: "ID of the
|
|
38944
|
+
description: "ID of the thermostat schedule that you want to get.",
|
|
38848
38945
|
format: "uuid",
|
|
38849
38946
|
type: "string"
|
|
38850
38947
|
}
|
|
@@ -38901,7 +38998,7 @@ var openapi_default = {
|
|
|
38901
38998
|
schema: {
|
|
38902
38999
|
properties: {
|
|
38903
39000
|
device_id: {
|
|
38904
|
-
description: "ID of the
|
|
39001
|
+
description: "ID of the thermostat device for which you want to list schedules.",
|
|
38905
39002
|
format: "uuid",
|
|
38906
39003
|
type: "string"
|
|
38907
39004
|
},
|
|
@@ -38984,7 +39081,7 @@ var openapi_default = {
|
|
|
38984
39081
|
type: "integer"
|
|
38985
39082
|
},
|
|
38986
39083
|
name: {
|
|
38987
|
-
description: "
|
|
39084
|
+
description: "Name of the thermostat schedule.",
|
|
38988
39085
|
type: "string"
|
|
38989
39086
|
},
|
|
38990
39087
|
starts_at: {
|
|
@@ -38992,7 +39089,7 @@ var openapi_default = {
|
|
|
38992
39089
|
type: "string"
|
|
38993
39090
|
},
|
|
38994
39091
|
thermostat_schedule_id: {
|
|
38995
|
-
description: "ID of the
|
|
39092
|
+
description: "ID of the thermostat schedule that you want to update.",
|
|
38996
39093
|
format: "uuid",
|
|
38997
39094
|
type: "string"
|
|
38998
39095
|
}
|
|
@@ -39059,7 +39156,7 @@ var openapi_default = {
|
|
|
39059
39156
|
type: "integer"
|
|
39060
39157
|
},
|
|
39061
39158
|
name: {
|
|
39062
|
-
description: "
|
|
39159
|
+
description: "Name of the thermostat schedule.",
|
|
39063
39160
|
type: "string"
|
|
39064
39161
|
},
|
|
39065
39162
|
starts_at: {
|
|
@@ -39067,7 +39164,7 @@ var openapi_default = {
|
|
|
39067
39164
|
type: "string"
|
|
39068
39165
|
},
|
|
39069
39166
|
thermostat_schedule_id: {
|
|
39070
|
-
description: "ID of the
|
|
39167
|
+
description: "ID of the thermostat schedule that you want to update.",
|
|
39071
39168
|
format: "uuid",
|
|
39072
39169
|
type: "string"
|
|
39073
39170
|
}
|
|
@@ -39183,7 +39280,7 @@ var openapi_default = {
|
|
|
39183
39280
|
"x-deprecated": "Use `fan_mode_setting` instead."
|
|
39184
39281
|
},
|
|
39185
39282
|
fan_mode_setting: {
|
|
39186
|
-
description: "
|
|
39283
|
+
description: "[Fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) that you want to set for the thermostat.",
|
|
39187
39284
|
enum: ["auto", "on", "circulate"],
|
|
39188
39285
|
type: "string"
|
|
39189
39286
|
},
|
|
@@ -39261,12 +39358,12 @@ var openapi_default = {
|
|
|
39261
39358
|
{
|
|
39262
39359
|
properties: {
|
|
39263
39360
|
cooling_set_point_celsius: {
|
|
39264
|
-
description: "
|
|
39361
|
+
description: "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.",
|
|
39265
39362
|
format: "float",
|
|
39266
39363
|
type: "number"
|
|
39267
39364
|
},
|
|
39268
39365
|
cooling_set_point_fahrenheit: {
|
|
39269
|
-
description: "
|
|
39366
|
+
description: "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.",
|
|
39270
39367
|
format: "float",
|
|
39271
39368
|
type: "number"
|
|
39272
39369
|
},
|
|
@@ -39288,12 +39385,12 @@ var openapi_default = {
|
|
|
39288
39385
|
type: "string"
|
|
39289
39386
|
},
|
|
39290
39387
|
heating_set_point_celsius: {
|
|
39291
|
-
description: "
|
|
39388
|
+
description: "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.",
|
|
39292
39389
|
format: "float",
|
|
39293
39390
|
type: "number"
|
|
39294
39391
|
},
|
|
39295
39392
|
heating_set_point_fahrenheit: {
|
|
39296
|
-
description: "
|
|
39393
|
+
description: "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.",
|
|
39297
39394
|
format: "float",
|
|
39298
39395
|
type: "number"
|
|
39299
39396
|
},
|
|
@@ -39305,12 +39402,12 @@ var openapi_default = {
|
|
|
39305
39402
|
{
|
|
39306
39403
|
properties: {
|
|
39307
39404
|
cooling_set_point_celsius: {
|
|
39308
|
-
description: "
|
|
39405
|
+
description: "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.",
|
|
39309
39406
|
format: "float",
|
|
39310
39407
|
type: "number"
|
|
39311
39408
|
},
|
|
39312
39409
|
cooling_set_point_fahrenheit: {
|
|
39313
|
-
description: "
|
|
39410
|
+
description: "[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.",
|
|
39314
39411
|
format: "float",
|
|
39315
39412
|
type: "number"
|
|
39316
39413
|
},
|
|
@@ -39320,12 +39417,12 @@ var openapi_default = {
|
|
|
39320
39417
|
type: "string"
|
|
39321
39418
|
},
|
|
39322
39419
|
heating_set_point_celsius: {
|
|
39323
|
-
description: "
|
|
39420
|
+
description: "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.",
|
|
39324
39421
|
format: "float",
|
|
39325
39422
|
type: "number"
|
|
39326
39423
|
},
|
|
39327
39424
|
heating_set_point_fahrenheit: {
|
|
39328
|
-
description: "
|
|
39425
|
+
description: "[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.",
|
|
39329
39426
|
format: "float",
|
|
39330
39427
|
type: "number"
|
|
39331
39428
|
},
|
|
@@ -39545,12 +39642,12 @@ var openapi_default = {
|
|
|
39545
39642
|
{
|
|
39546
39643
|
properties: {
|
|
39547
39644
|
device_id: {
|
|
39548
|
-
description: "ID of the
|
|
39645
|
+
description: "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.",
|
|
39549
39646
|
format: "uuid",
|
|
39550
39647
|
type: "string"
|
|
39551
39648
|
},
|
|
39552
39649
|
hvac_mode: {
|
|
39553
|
-
description: "
|
|
39650
|
+
description: "HVAC mode that you want to simulate.",
|
|
39554
39651
|
enum: ["off"],
|
|
39555
39652
|
type: "string"
|
|
39556
39653
|
}
|
|
@@ -39561,22 +39658,22 @@ var openapi_default = {
|
|
|
39561
39658
|
{
|
|
39562
39659
|
properties: {
|
|
39563
39660
|
cooling_set_point_celsius: {
|
|
39564
|
-
description: "
|
|
39661
|
+
description: "Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.",
|
|
39565
39662
|
format: "float",
|
|
39566
39663
|
type: "number"
|
|
39567
39664
|
},
|
|
39568
39665
|
cooling_set_point_fahrenheit: {
|
|
39569
|
-
description: "
|
|
39666
|
+
description: "Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.",
|
|
39570
39667
|
format: "float",
|
|
39571
39668
|
type: "number"
|
|
39572
39669
|
},
|
|
39573
39670
|
device_id: {
|
|
39574
|
-
description: "ID of the
|
|
39671
|
+
description: "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.",
|
|
39575
39672
|
format: "uuid",
|
|
39576
39673
|
type: "string"
|
|
39577
39674
|
},
|
|
39578
39675
|
hvac_mode: {
|
|
39579
|
-
description: "
|
|
39676
|
+
description: "HVAC mode that you want to simulate.",
|
|
39580
39677
|
enum: ["cool"],
|
|
39581
39678
|
type: "string"
|
|
39582
39679
|
}
|
|
@@ -39587,22 +39684,22 @@ var openapi_default = {
|
|
|
39587
39684
|
{
|
|
39588
39685
|
properties: {
|
|
39589
39686
|
device_id: {
|
|
39590
|
-
description: "ID of the
|
|
39687
|
+
description: "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.",
|
|
39591
39688
|
format: "uuid",
|
|
39592
39689
|
type: "string"
|
|
39593
39690
|
},
|
|
39594
39691
|
heating_set_point_celsius: {
|
|
39595
|
-
description: "
|
|
39692
|
+
description: "Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.",
|
|
39596
39693
|
format: "float",
|
|
39597
39694
|
type: "number"
|
|
39598
39695
|
},
|
|
39599
39696
|
heating_set_point_fahrenheit: {
|
|
39600
|
-
description: "
|
|
39697
|
+
description: "Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.",
|
|
39601
39698
|
format: "float",
|
|
39602
39699
|
type: "number"
|
|
39603
39700
|
},
|
|
39604
39701
|
hvac_mode: {
|
|
39605
|
-
description: "
|
|
39702
|
+
description: "HVAC mode that you want to simulate.",
|
|
39606
39703
|
enum: ["heat"],
|
|
39607
39704
|
type: "string"
|
|
39608
39705
|
}
|
|
@@ -39613,32 +39710,32 @@ var openapi_default = {
|
|
|
39613
39710
|
{
|
|
39614
39711
|
properties: {
|
|
39615
39712
|
cooling_set_point_celsius: {
|
|
39616
|
-
description: "
|
|
39713
|
+
description: "Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.",
|
|
39617
39714
|
format: "float",
|
|
39618
39715
|
type: "number"
|
|
39619
39716
|
},
|
|
39620
39717
|
cooling_set_point_fahrenheit: {
|
|
39621
|
-
description: "
|
|
39718
|
+
description: "Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.",
|
|
39622
39719
|
format: "float",
|
|
39623
39720
|
type: "number"
|
|
39624
39721
|
},
|
|
39625
39722
|
device_id: {
|
|
39626
|
-
description: "ID of the
|
|
39723
|
+
description: "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.",
|
|
39627
39724
|
format: "uuid",
|
|
39628
39725
|
type: "string"
|
|
39629
39726
|
},
|
|
39630
39727
|
heating_set_point_celsius: {
|
|
39631
|
-
description: "
|
|
39728
|
+
description: "Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.",
|
|
39632
39729
|
format: "float",
|
|
39633
39730
|
type: "number"
|
|
39634
39731
|
},
|
|
39635
39732
|
heating_set_point_fahrenheit: {
|
|
39636
|
-
description: "
|
|
39733
|
+
description: "Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.",
|
|
39637
39734
|
format: "float",
|
|
39638
39735
|
type: "number"
|
|
39639
39736
|
},
|
|
39640
39737
|
hvac_mode: {
|
|
39641
|
-
description: "
|
|
39738
|
+
description: "HVAC mode that you want to simulate.",
|
|
39642
39739
|
enum: ["heat_cool"],
|
|
39643
39740
|
type: "string"
|
|
39644
39741
|
}
|
|
@@ -39690,17 +39787,17 @@ var openapi_default = {
|
|
|
39690
39787
|
schema: {
|
|
39691
39788
|
properties: {
|
|
39692
39789
|
device_id: {
|
|
39693
|
-
description: "ID of the
|
|
39790
|
+
description: "ID of the thermostat device that you want to simulate reaching a specified temperature.",
|
|
39694
39791
|
format: "uuid",
|
|
39695
39792
|
type: "string"
|
|
39696
39793
|
},
|
|
39697
39794
|
temperature_celsius: {
|
|
39698
|
-
description: "
|
|
39795
|
+
description: "Temperature in \xB0C that you want simulate the thermostat reaching. You must set `temperature_celsius` or `temperature_fahrenheit`.",
|
|
39699
39796
|
format: "float",
|
|
39700
39797
|
type: "number"
|
|
39701
39798
|
},
|
|
39702
39799
|
temperature_fahrenheit: {
|
|
39703
|
-
description: "
|
|
39800
|
+
description: "Temperature in \xB0F that you want simulate the thermostat reaching. You must set `temperature_fahrenheit` or `temperature_celsius`.",
|
|
39704
39801
|
format: "float",
|
|
39705
39802
|
type: "number"
|
|
39706
39803
|
}
|
|
@@ -40045,7 +40142,7 @@ var openapi_default = {
|
|
|
40045
40142
|
{
|
|
40046
40143
|
properties: {
|
|
40047
40144
|
user_identity_id: {
|
|
40048
|
-
description: "ID of user identity for whom
|
|
40145
|
+
description: "ID of user identity for whom you want to grant access.",
|
|
40049
40146
|
format: "uuid",
|
|
40050
40147
|
type: "string"
|
|
40051
40148
|
}
|
|
@@ -40056,7 +40153,7 @@ var openapi_default = {
|
|
|
40056
40153
|
{
|
|
40057
40154
|
properties: {
|
|
40058
40155
|
user_identity: {
|
|
40059
|
-
description: "When used, creates a new user identity with the
|
|
40156
|
+
description: "User identity. When used, creates a new user identity with the specified details and grants them access.",
|
|
40060
40157
|
properties: {
|
|
40061
40158
|
email_address: {
|
|
40062
40159
|
description: "Unique email address for the user identity.",
|
|
@@ -40087,13 +40184,13 @@ var openapi_default = {
|
|
|
40087
40184
|
properties: {
|
|
40088
40185
|
acs_entrance_ids: {
|
|
40089
40186
|
default: [],
|
|
40090
|
-
description: "
|
|
40187
|
+
description: "IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to which you want to grant access.",
|
|
40091
40188
|
items: { format: "uuid", type: "string" },
|
|
40092
40189
|
type: "array"
|
|
40093
40190
|
},
|
|
40094
40191
|
device_ids: {
|
|
40095
40192
|
default: [],
|
|
40096
|
-
description: "
|
|
40193
|
+
description: "IDs of the devices to which you want to grant access.",
|
|
40097
40194
|
items: { format: "uuid", type: "string" },
|
|
40098
40195
|
type: "array"
|
|
40099
40196
|
},
|
|
@@ -40103,7 +40200,7 @@ var openapi_default = {
|
|
|
40103
40200
|
type: "string"
|
|
40104
40201
|
},
|
|
40105
40202
|
location: {
|
|
40106
|
-
description: "When used, creates a new location with the
|
|
40203
|
+
description: "Location. When used, creates a new location with the specified entrances and devices, and gives the user access to this location.",
|
|
40107
40204
|
properties: {
|
|
40108
40205
|
acs_entrance_ids: {
|
|
40109
40206
|
default: [],
|
|
@@ -40136,7 +40233,7 @@ var openapi_default = {
|
|
|
40136
40233
|
items: {
|
|
40137
40234
|
properties: {
|
|
40138
40235
|
mode: {
|
|
40139
|
-
description: "Access method mode.
|
|
40236
|
+
description: "Access method mode.",
|
|
40140
40237
|
enum: ["code", "card", "mobile_key"],
|
|
40141
40238
|
type: "string"
|
|
40142
40239
|
}
|
|
@@ -40147,7 +40244,7 @@ var openapi_default = {
|
|
|
40147
40244
|
type: "array"
|
|
40148
40245
|
},
|
|
40149
40246
|
space_ids: {
|
|
40150
|
-
description: "
|
|
40247
|
+
description: "IDs of the existing spaces to which you want to grant access.",
|
|
40151
40248
|
items: { format: "uuid", type: "string" },
|
|
40152
40249
|
type: "array"
|
|
40153
40250
|
},
|
|
@@ -40293,7 +40390,7 @@ var openapi_default = {
|
|
|
40293
40390
|
},
|
|
40294
40391
|
"/unstable_access_grants/delete": {
|
|
40295
40392
|
post: {
|
|
40296
|
-
description: "
|
|
40393
|
+
description: "Deletes an access grant.",
|
|
40297
40394
|
operationId: "unstableAccessGrantsDeletePost",
|
|
40298
40395
|
requestBody: {
|
|
40299
40396
|
content: {
|
|
@@ -40301,7 +40398,7 @@ var openapi_default = {
|
|
|
40301
40398
|
schema: {
|
|
40302
40399
|
properties: {
|
|
40303
40400
|
access_grant_id: {
|
|
40304
|
-
description: "ID of access grant to delete.",
|
|
40401
|
+
description: "ID of access grant that you want to delete.",
|
|
40305
40402
|
format: "uuid",
|
|
40306
40403
|
type: "string"
|
|
40307
40404
|
}
|
|
@@ -40345,7 +40442,7 @@ var openapi_default = {
|
|
|
40345
40442
|
},
|
|
40346
40443
|
"/unstable_access_grants/get": {
|
|
40347
40444
|
post: {
|
|
40348
|
-
description: "
|
|
40445
|
+
description: "Gets an access grant.",
|
|
40349
40446
|
operationId: "unstableAccessGrantsGetPost",
|
|
40350
40447
|
requestBody: {
|
|
40351
40448
|
content: {
|
|
@@ -40353,7 +40450,7 @@ var openapi_default = {
|
|
|
40353
40450
|
schema: {
|
|
40354
40451
|
properties: {
|
|
40355
40452
|
access_grant_id: {
|
|
40356
|
-
description: "ID of access grant to get.",
|
|
40453
|
+
description: "ID of access grant that you want to get.",
|
|
40357
40454
|
format: "uuid",
|
|
40358
40455
|
type: "string"
|
|
40359
40456
|
}
|
|
@@ -40492,7 +40589,7 @@ var openapi_default = {
|
|
|
40492
40589
|
},
|
|
40493
40590
|
"/unstable_access_grants/list": {
|
|
40494
40591
|
post: {
|
|
40495
|
-
description: "
|
|
40592
|
+
description: "Returns a list of all access grants.",
|
|
40496
40593
|
operationId: "unstableAccessGrantsListPost",
|
|
40497
40594
|
requestBody: {
|
|
40498
40595
|
content: {
|
|
@@ -40500,12 +40597,12 @@ var openapi_default = {
|
|
|
40500
40597
|
schema: {
|
|
40501
40598
|
properties: {
|
|
40502
40599
|
acs_entrance_id: {
|
|
40503
|
-
description: "ID of entrance to filter list of access grants
|
|
40600
|
+
description: "ID of the entrance by which you want to filter the list of access grants.",
|
|
40504
40601
|
format: "uuid",
|
|
40505
40602
|
type: "string"
|
|
40506
40603
|
},
|
|
40507
40604
|
acs_system_id: {
|
|
40508
|
-
description: "ID of system to filter list of access grants
|
|
40605
|
+
description: "ID of the access system by which you want to filter the list of access grants.",
|
|
40509
40606
|
format: "uuid",
|
|
40510
40607
|
type: "string"
|
|
40511
40608
|
},
|
|
@@ -40516,12 +40613,12 @@ var openapi_default = {
|
|
|
40516
40613
|
"x-deprecated": "Use `space_id`."
|
|
40517
40614
|
},
|
|
40518
40615
|
space_id: {
|
|
40519
|
-
description: "ID of space to filter list of access grants
|
|
40616
|
+
description: "ID of the space by which you want to filter the list of access grants.",
|
|
40520
40617
|
format: "uuid",
|
|
40521
40618
|
type: "string"
|
|
40522
40619
|
},
|
|
40523
40620
|
user_identity_id: {
|
|
40524
|
-
description: "ID of user identity to filter list of access grants
|
|
40621
|
+
description: "ID of the user identity by which you want to filter the list of access grants.",
|
|
40525
40622
|
format: "uuid",
|
|
40526
40623
|
type: "string"
|
|
40527
40624
|
}
|
|
@@ -40662,7 +40759,7 @@ var openapi_default = {
|
|
|
40662
40759
|
},
|
|
40663
40760
|
"/unstable_access_methods/delete": {
|
|
40664
40761
|
post: {
|
|
40665
|
-
description: "
|
|
40762
|
+
description: "Deletes an access method.",
|
|
40666
40763
|
operationId: "unstableAccessMethodsDeletePost",
|
|
40667
40764
|
requestBody: {
|
|
40668
40765
|
content: {
|
|
@@ -40670,7 +40767,7 @@ var openapi_default = {
|
|
|
40670
40767
|
schema: {
|
|
40671
40768
|
properties: {
|
|
40672
40769
|
access_method_id: {
|
|
40673
|
-
description: "ID of access method to
|
|
40770
|
+
description: "ID of the access method that you want to delete.",
|
|
40674
40771
|
format: "uuid",
|
|
40675
40772
|
type: "string"
|
|
40676
40773
|
}
|
|
@@ -40713,7 +40810,7 @@ var openapi_default = {
|
|
|
40713
40810
|
},
|
|
40714
40811
|
"/unstable_access_methods/get": {
|
|
40715
40812
|
post: {
|
|
40716
|
-
description: "
|
|
40813
|
+
description: "Gets an access method.",
|
|
40717
40814
|
operationId: "unstableAccessMethodsGetPost",
|
|
40718
40815
|
requestBody: {
|
|
40719
40816
|
content: {
|
|
@@ -40721,7 +40818,7 @@ var openapi_default = {
|
|
|
40721
40818
|
schema: {
|
|
40722
40819
|
properties: {
|
|
40723
40820
|
access_method_id: {
|
|
40724
|
-
description: "ID of access method to get.",
|
|
40821
|
+
description: "ID of the access method that you want to get.",
|
|
40725
40822
|
format: "uuid",
|
|
40726
40823
|
type: "string"
|
|
40727
40824
|
}
|
|
@@ -40818,7 +40915,7 @@ var openapi_default = {
|
|
|
40818
40915
|
},
|
|
40819
40916
|
"/unstable_access_methods/list": {
|
|
40820
40917
|
post: {
|
|
40821
|
-
description: "
|
|
40918
|
+
description: "Lists all access methods, usually filtered by access grant.",
|
|
40822
40919
|
operationId: "unstableAccessMethodsListPost",
|
|
40823
40920
|
requestBody: {
|
|
40824
40921
|
content: {
|
|
@@ -40826,7 +40923,7 @@ var openapi_default = {
|
|
|
40826
40923
|
schema: {
|
|
40827
40924
|
properties: {
|
|
40828
40925
|
access_grant_id: {
|
|
40829
|
-
description: "ID of access grant to list access methods
|
|
40926
|
+
description: "ID of the access grant by which to filter the list of access methods.",
|
|
40830
40927
|
format: "uuid",
|
|
40831
40928
|
type: "string"
|
|
40832
40929
|
}
|
|
@@ -40926,7 +41023,7 @@ var openapi_default = {
|
|
|
40926
41023
|
},
|
|
40927
41024
|
"/unstable_locations/add_acs_entrances": {
|
|
40928
41025
|
post: {
|
|
40929
|
-
description: "
|
|
41026
|
+
description: "Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.",
|
|
40930
41027
|
operationId: "unstableLocationsAddAcsEntrancesPost",
|
|
40931
41028
|
requestBody: {
|
|
40932
41029
|
content: {
|
|
@@ -40934,11 +41031,16 @@ var openapi_default = {
|
|
|
40934
41031
|
schema: {
|
|
40935
41032
|
properties: {
|
|
40936
41033
|
acs_entrance_ids: {
|
|
41034
|
+
description: "IDs of the entrances that you want to add to the location.",
|
|
40937
41035
|
items: { format: "uuid", type: "string" },
|
|
40938
41036
|
minItems: 1,
|
|
40939
41037
|
type: "array"
|
|
40940
41038
|
},
|
|
40941
|
-
location_id: {
|
|
41039
|
+
location_id: {
|
|
41040
|
+
description: "ID of the location to which you want to add entrances.",
|
|
41041
|
+
format: "uuid",
|
|
41042
|
+
type: "string"
|
|
41043
|
+
}
|
|
40942
41044
|
},
|
|
40943
41045
|
required: ["location_id", "acs_entrance_ids"],
|
|
40944
41046
|
type: "object"
|
|
@@ -40972,11 +41074,11 @@ var openapi_default = {
|
|
|
40972
41074
|
"x-fern-sdk-group-name": ["unstable_locations"],
|
|
40973
41075
|
"x-fern-sdk-method-name": "add_acs_entrances",
|
|
40974
41076
|
"x-response-key": null,
|
|
40975
|
-
"x-title": "Add
|
|
41077
|
+
"x-title": "Add Entrances to a Location",
|
|
40976
41078
|
"x-undocumented": "Experimental locations."
|
|
40977
41079
|
},
|
|
40978
41080
|
put: {
|
|
40979
|
-
description: "
|
|
41081
|
+
description: "Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.",
|
|
40980
41082
|
operationId: "unstableLocationsAddAcsEntrancesPut",
|
|
40981
41083
|
requestBody: {
|
|
40982
41084
|
content: {
|
|
@@ -40984,11 +41086,16 @@ var openapi_default = {
|
|
|
40984
41086
|
schema: {
|
|
40985
41087
|
properties: {
|
|
40986
41088
|
acs_entrance_ids: {
|
|
41089
|
+
description: "IDs of the entrances that you want to add to the location.",
|
|
40987
41090
|
items: { format: "uuid", type: "string" },
|
|
40988
41091
|
minItems: 1,
|
|
40989
41092
|
type: "array"
|
|
40990
41093
|
},
|
|
40991
|
-
location_id: {
|
|
41094
|
+
location_id: {
|
|
41095
|
+
description: "ID of the location to which you want to add entrances.",
|
|
41096
|
+
format: "uuid",
|
|
41097
|
+
type: "string"
|
|
41098
|
+
}
|
|
40992
41099
|
},
|
|
40993
41100
|
required: ["location_id", "acs_entrance_ids"],
|
|
40994
41101
|
type: "object"
|
|
@@ -41021,13 +41128,13 @@ var openapi_default = {
|
|
|
41021
41128
|
tags: [],
|
|
41022
41129
|
"x-fern-ignore": true,
|
|
41023
41130
|
"x-response-key": null,
|
|
41024
|
-
"x-title": "Add
|
|
41131
|
+
"x-title": "Add Entrances to a Location",
|
|
41025
41132
|
"x-undocumented": "Experimental locations."
|
|
41026
41133
|
}
|
|
41027
41134
|
},
|
|
41028
41135
|
"/unstable_locations/add_devices": {
|
|
41029
41136
|
post: {
|
|
41030
|
-
description: "
|
|
41137
|
+
description: "Adds devices to a specific location.",
|
|
41031
41138
|
operationId: "unstableLocationsAddDevicesPost",
|
|
41032
41139
|
requestBody: {
|
|
41033
41140
|
content: {
|
|
@@ -41035,11 +41142,16 @@ var openapi_default = {
|
|
|
41035
41142
|
schema: {
|
|
41036
41143
|
properties: {
|
|
41037
41144
|
device_ids: {
|
|
41145
|
+
description: "IDs of the devices that you want to add to the location.",
|
|
41038
41146
|
items: { format: "uuid", type: "string" },
|
|
41039
41147
|
minItems: 1,
|
|
41040
41148
|
type: "array"
|
|
41041
41149
|
},
|
|
41042
|
-
location_id: {
|
|
41150
|
+
location_id: {
|
|
41151
|
+
description: "ID of the location to which you want to add devices.",
|
|
41152
|
+
format: "uuid",
|
|
41153
|
+
type: "string"
|
|
41154
|
+
}
|
|
41043
41155
|
},
|
|
41044
41156
|
required: ["location_id", "device_ids"],
|
|
41045
41157
|
type: "object"
|
|
@@ -41073,11 +41185,11 @@ var openapi_default = {
|
|
|
41073
41185
|
"x-fern-sdk-group-name": ["unstable_locations"],
|
|
41074
41186
|
"x-fern-sdk-method-name": "add_devices",
|
|
41075
41187
|
"x-response-key": null,
|
|
41076
|
-
"x-title": "Add Location
|
|
41188
|
+
"x-title": "Add Devices to a Location",
|
|
41077
41189
|
"x-undocumented": "Experimental locations."
|
|
41078
41190
|
},
|
|
41079
41191
|
put: {
|
|
41080
|
-
description: "
|
|
41192
|
+
description: "Adds devices to a specific location.",
|
|
41081
41193
|
operationId: "unstableLocationsAddDevicesPut",
|
|
41082
41194
|
requestBody: {
|
|
41083
41195
|
content: {
|
|
@@ -41085,11 +41197,16 @@ var openapi_default = {
|
|
|
41085
41197
|
schema: {
|
|
41086
41198
|
properties: {
|
|
41087
41199
|
device_ids: {
|
|
41200
|
+
description: "IDs of the devices that you want to add to the location.",
|
|
41088
41201
|
items: { format: "uuid", type: "string" },
|
|
41089
41202
|
minItems: 1,
|
|
41090
41203
|
type: "array"
|
|
41091
41204
|
},
|
|
41092
|
-
location_id: {
|
|
41205
|
+
location_id: {
|
|
41206
|
+
description: "ID of the location to which you want to add devices.",
|
|
41207
|
+
format: "uuid",
|
|
41208
|
+
type: "string"
|
|
41209
|
+
}
|
|
41093
41210
|
},
|
|
41094
41211
|
required: ["location_id", "device_ids"],
|
|
41095
41212
|
type: "object"
|
|
@@ -41122,13 +41239,13 @@ var openapi_default = {
|
|
|
41122
41239
|
tags: [],
|
|
41123
41240
|
"x-fern-ignore": true,
|
|
41124
41241
|
"x-response-key": null,
|
|
41125
|
-
"x-title": "Add Location
|
|
41242
|
+
"x-title": "Add Devices to a Location",
|
|
41126
41243
|
"x-undocumented": "Experimental locations."
|
|
41127
41244
|
}
|
|
41128
41245
|
},
|
|
41129
41246
|
"/unstable_locations/create": {
|
|
41130
41247
|
post: {
|
|
41131
|
-
description: "
|
|
41248
|
+
description: "Creates a new location.",
|
|
41132
41249
|
operationId: "unstableLocationsCreatePost",
|
|
41133
41250
|
requestBody: {
|
|
41134
41251
|
content: {
|
|
@@ -41136,14 +41253,17 @@ var openapi_default = {
|
|
|
41136
41253
|
schema: {
|
|
41137
41254
|
properties: {
|
|
41138
41255
|
acs_entrance_ids: {
|
|
41256
|
+
description: "IDs of the entrances that you want to add to the new location.",
|
|
41139
41257
|
items: { format: "uuid", type: "string" },
|
|
41140
41258
|
type: "array"
|
|
41141
41259
|
},
|
|
41142
41260
|
device_ids: {
|
|
41261
|
+
description: "IDs of the devices that you want to add to the new location.",
|
|
41143
41262
|
items: { format: "uuid", type: "string" },
|
|
41144
41263
|
type: "array"
|
|
41145
41264
|
},
|
|
41146
41265
|
geolocation: {
|
|
41266
|
+
description: "Geolocation of the new location.",
|
|
41147
41267
|
properties: {
|
|
41148
41268
|
latitude: { format: "float", type: "number" },
|
|
41149
41269
|
longitude: { format: "float", type: "number" }
|
|
@@ -41151,8 +41271,14 @@ var openapi_default = {
|
|
|
41151
41271
|
required: ["latitude", "longitude"],
|
|
41152
41272
|
type: "object"
|
|
41153
41273
|
},
|
|
41154
|
-
name: {
|
|
41155
|
-
|
|
41274
|
+
name: {
|
|
41275
|
+
description: "Name of the new location.",
|
|
41276
|
+
type: "string"
|
|
41277
|
+
},
|
|
41278
|
+
time_zone: {
|
|
41279
|
+
description: "Time zone of the new location.",
|
|
41280
|
+
type: "string"
|
|
41281
|
+
}
|
|
41156
41282
|
},
|
|
41157
41283
|
required: ["name"],
|
|
41158
41284
|
type: "object"
|
|
@@ -41237,19 +41363,25 @@ var openapi_default = {
|
|
|
41237
41363
|
"x-fern-sdk-method-name": "create",
|
|
41238
41364
|
"x-fern-sdk-return-value": "location",
|
|
41239
41365
|
"x-response-key": "location",
|
|
41240
|
-
"x-title": "Create Location",
|
|
41366
|
+
"x-title": "Create a Location",
|
|
41241
41367
|
"x-undocumented": "Experimental locations."
|
|
41242
41368
|
}
|
|
41243
41369
|
},
|
|
41244
41370
|
"/unstable_locations/delete": {
|
|
41245
41371
|
post: {
|
|
41246
|
-
description: "
|
|
41372
|
+
description: "Deletes a location.",
|
|
41247
41373
|
operationId: "unstableLocationsDeletePost",
|
|
41248
41374
|
requestBody: {
|
|
41249
41375
|
content: {
|
|
41250
41376
|
"application/json": {
|
|
41251
41377
|
schema: {
|
|
41252
|
-
properties: {
|
|
41378
|
+
properties: {
|
|
41379
|
+
location_id: {
|
|
41380
|
+
description: "ID of the location that you want to delete.",
|
|
41381
|
+
format: "uuid",
|
|
41382
|
+
type: "string"
|
|
41383
|
+
}
|
|
41384
|
+
},
|
|
41253
41385
|
required: ["location_id"],
|
|
41254
41386
|
type: "object"
|
|
41255
41387
|
}
|
|
@@ -41282,19 +41414,25 @@ var openapi_default = {
|
|
|
41282
41414
|
"x-fern-sdk-group-name": ["unstable_locations"],
|
|
41283
41415
|
"x-fern-sdk-method-name": "delete",
|
|
41284
41416
|
"x-response-key": null,
|
|
41285
|
-
"x-title": "Delete Location",
|
|
41417
|
+
"x-title": "Delete a Location",
|
|
41286
41418
|
"x-undocumented": "Experimental locations."
|
|
41287
41419
|
}
|
|
41288
41420
|
},
|
|
41289
41421
|
"/unstable_locations/get": {
|
|
41290
41422
|
post: {
|
|
41291
|
-
description: "
|
|
41423
|
+
description: "Gets a location.",
|
|
41292
41424
|
operationId: "unstableLocationsGetPost",
|
|
41293
41425
|
requestBody: {
|
|
41294
41426
|
content: {
|
|
41295
41427
|
"application/json": {
|
|
41296
41428
|
schema: {
|
|
41297
|
-
properties: {
|
|
41429
|
+
properties: {
|
|
41430
|
+
location_id: {
|
|
41431
|
+
description: "ID of the location that you want to get.",
|
|
41432
|
+
format: "uuid",
|
|
41433
|
+
type: "string"
|
|
41434
|
+
}
|
|
41435
|
+
},
|
|
41298
41436
|
required: ["location_id"],
|
|
41299
41437
|
type: "object"
|
|
41300
41438
|
}
|
|
@@ -41378,7 +41516,7 @@ var openapi_default = {
|
|
|
41378
41516
|
"x-fern-sdk-method-name": "get",
|
|
41379
41517
|
"x-fern-sdk-return-value": "location",
|
|
41380
41518
|
"x-response-key": "location",
|
|
41381
|
-
"x-title": "Get Location",
|
|
41519
|
+
"x-title": "Get a Location",
|
|
41382
41520
|
"x-undocumented": "Experimental locations."
|
|
41383
41521
|
}
|
|
41384
41522
|
},
|
|
@@ -41556,7 +41694,7 @@ var openapi_default = {
|
|
|
41556
41694
|
},
|
|
41557
41695
|
"/unstable_locations/remove_acs_entrances": {
|
|
41558
41696
|
post: {
|
|
41559
|
-
description: "
|
|
41697
|
+
description: "Removes entrances from a specific location.",
|
|
41560
41698
|
operationId: "unstableLocationsRemoveAcsEntrancesPost",
|
|
41561
41699
|
requestBody: {
|
|
41562
41700
|
content: {
|
|
@@ -41564,10 +41702,15 @@ var openapi_default = {
|
|
|
41564
41702
|
schema: {
|
|
41565
41703
|
properties: {
|
|
41566
41704
|
acs_entrance_ids: {
|
|
41705
|
+
description: "IDs of the entrances that you want to remove from the location.",
|
|
41567
41706
|
items: { format: "uuid", type: "string" },
|
|
41568
41707
|
type: "array"
|
|
41569
41708
|
},
|
|
41570
|
-
location_id: {
|
|
41709
|
+
location_id: {
|
|
41710
|
+
description: "ID of the location from which you want to remove entrances.",
|
|
41711
|
+
format: "uuid",
|
|
41712
|
+
type: "string"
|
|
41713
|
+
}
|
|
41571
41714
|
},
|
|
41572
41715
|
required: ["location_id", "acs_entrance_ids"],
|
|
41573
41716
|
type: "object"
|
|
@@ -41601,13 +41744,13 @@ var openapi_default = {
|
|
|
41601
41744
|
"x-fern-sdk-group-name": ["unstable_locations"],
|
|
41602
41745
|
"x-fern-sdk-method-name": "remove_acs_entrances",
|
|
41603
41746
|
"x-response-key": null,
|
|
41604
|
-
"x-title": "Remove
|
|
41747
|
+
"x-title": "Remove Entrances from a Location",
|
|
41605
41748
|
"x-undocumented": "Experimental locations."
|
|
41606
41749
|
}
|
|
41607
41750
|
},
|
|
41608
41751
|
"/unstable_locations/remove_devices": {
|
|
41609
41752
|
post: {
|
|
41610
|
-
description: "
|
|
41753
|
+
description: "Removes devices from a specific location.",
|
|
41611
41754
|
operationId: "unstableLocationsRemoveDevicesPost",
|
|
41612
41755
|
requestBody: {
|
|
41613
41756
|
content: {
|
|
@@ -41615,10 +41758,15 @@ var openapi_default = {
|
|
|
41615
41758
|
schema: {
|
|
41616
41759
|
properties: {
|
|
41617
41760
|
device_ids: {
|
|
41761
|
+
description: "IDs of the devices that you want to remove from the location.",
|
|
41618
41762
|
items: { format: "uuid", type: "string" },
|
|
41619
41763
|
type: "array"
|
|
41620
41764
|
},
|
|
41621
|
-
location_id: {
|
|
41765
|
+
location_id: {
|
|
41766
|
+
description: "ID of the location from which you want to remove devices.",
|
|
41767
|
+
format: "uuid",
|
|
41768
|
+
type: "string"
|
|
41769
|
+
}
|
|
41622
41770
|
},
|
|
41623
41771
|
required: ["location_id", "device_ids"],
|
|
41624
41772
|
type: "object"
|
|
@@ -41652,13 +41800,13 @@ var openapi_default = {
|
|
|
41652
41800
|
"x-fern-sdk-group-name": ["unstable_locations"],
|
|
41653
41801
|
"x-fern-sdk-method-name": "remove_devices",
|
|
41654
41802
|
"x-response-key": null,
|
|
41655
|
-
"x-title": "Remove Location
|
|
41803
|
+
"x-title": "Remove Devices from a Location",
|
|
41656
41804
|
"x-undocumented": "Experimental locations."
|
|
41657
41805
|
}
|
|
41658
41806
|
},
|
|
41659
41807
|
"/unstable_locations/update": {
|
|
41660
41808
|
patch: {
|
|
41661
|
-
description: "
|
|
41809
|
+
description: "Updates a location.",
|
|
41662
41810
|
operationId: "unstableLocationsUpdatePatch",
|
|
41663
41811
|
requestBody: {
|
|
41664
41812
|
content: {
|
|
@@ -41666,6 +41814,7 @@ var openapi_default = {
|
|
|
41666
41814
|
schema: {
|
|
41667
41815
|
properties: {
|
|
41668
41816
|
geolocation: {
|
|
41817
|
+
description: "Geolocation of the location.",
|
|
41669
41818
|
properties: {
|
|
41670
41819
|
latitude: { format: "float", type: "number" },
|
|
41671
41820
|
longitude: { format: "float", type: "number" }
|
|
@@ -41673,9 +41822,19 @@ var openapi_default = {
|
|
|
41673
41822
|
required: ["latitude", "longitude"],
|
|
41674
41823
|
type: "object"
|
|
41675
41824
|
},
|
|
41676
|
-
location_id: {
|
|
41677
|
-
|
|
41678
|
-
|
|
41825
|
+
location_id: {
|
|
41826
|
+
description: "ID of the location that you want to update.",
|
|
41827
|
+
format: "uuid",
|
|
41828
|
+
type: "string"
|
|
41829
|
+
},
|
|
41830
|
+
name: {
|
|
41831
|
+
description: "Name of the location.",
|
|
41832
|
+
type: "string"
|
|
41833
|
+
},
|
|
41834
|
+
time_zone: {
|
|
41835
|
+
description: "Time zone of the the location.",
|
|
41836
|
+
type: "string"
|
|
41837
|
+
}
|
|
41679
41838
|
},
|
|
41680
41839
|
required: ["location_id"],
|
|
41681
41840
|
type: "object"
|
|
@@ -41758,11 +41917,11 @@ var openapi_default = {
|
|
|
41758
41917
|
tags: [],
|
|
41759
41918
|
"x-fern-ignore": true,
|
|
41760
41919
|
"x-response-key": "location",
|
|
41761
|
-
"x-title": "Update Location",
|
|
41920
|
+
"x-title": "Update a Location",
|
|
41762
41921
|
"x-undocumented": "Experimental locations."
|
|
41763
41922
|
},
|
|
41764
41923
|
post: {
|
|
41765
|
-
description: "
|
|
41924
|
+
description: "Updates a location.",
|
|
41766
41925
|
operationId: "unstableLocationsUpdatePost",
|
|
41767
41926
|
requestBody: {
|
|
41768
41927
|
content: {
|
|
@@ -41770,6 +41929,7 @@ var openapi_default = {
|
|
|
41770
41929
|
schema: {
|
|
41771
41930
|
properties: {
|
|
41772
41931
|
geolocation: {
|
|
41932
|
+
description: "Geolocation of the location.",
|
|
41773
41933
|
properties: {
|
|
41774
41934
|
latitude: { format: "float", type: "number" },
|
|
41775
41935
|
longitude: { format: "float", type: "number" }
|
|
@@ -41777,9 +41937,19 @@ var openapi_default = {
|
|
|
41777
41937
|
required: ["latitude", "longitude"],
|
|
41778
41938
|
type: "object"
|
|
41779
41939
|
},
|
|
41780
|
-
location_id: {
|
|
41781
|
-
|
|
41782
|
-
|
|
41940
|
+
location_id: {
|
|
41941
|
+
description: "ID of the location that you want to update.",
|
|
41942
|
+
format: "uuid",
|
|
41943
|
+
type: "string"
|
|
41944
|
+
},
|
|
41945
|
+
name: {
|
|
41946
|
+
description: "Name of the location.",
|
|
41947
|
+
type: "string"
|
|
41948
|
+
},
|
|
41949
|
+
time_zone: {
|
|
41950
|
+
description: "Time zone of the the location.",
|
|
41951
|
+
type: "string"
|
|
41952
|
+
}
|
|
41783
41953
|
},
|
|
41784
41954
|
required: ["location_id"],
|
|
41785
41955
|
type: "object"
|
|
@@ -41864,7 +42034,7 @@ var openapi_default = {
|
|
|
41864
42034
|
"x-fern-sdk-method-name": "update",
|
|
41865
42035
|
"x-fern-sdk-return-value": "location",
|
|
41866
42036
|
"x-response-key": "location",
|
|
41867
|
-
"x-title": "Update Location",
|
|
42037
|
+
"x-title": "Update a Location",
|
|
41868
42038
|
"x-undocumented": "Experimental locations."
|
|
41869
42039
|
}
|
|
41870
42040
|
},
|
|
@@ -41876,7 +42046,12 @@ var openapi_default = {
|
|
|
41876
42046
|
content: {
|
|
41877
42047
|
"application/json": {
|
|
41878
42048
|
schema: {
|
|
41879
|
-
properties: {
|
|
42049
|
+
properties: {
|
|
42050
|
+
customer_key: {
|
|
42051
|
+
description: "Customer key for which you want to connect accounts.",
|
|
42052
|
+
type: "string"
|
|
42053
|
+
}
|
|
42054
|
+
},
|
|
41880
42055
|
required: ["customer_key"],
|
|
41881
42056
|
type: "object"
|
|
41882
42057
|
}
|
|
@@ -41913,7 +42088,7 @@ var openapi_default = {
|
|
|
41913
42088
|
"x-fern-sdk-method-name": "connect_accounts",
|
|
41914
42089
|
"x-fern-sdk-return-value": "magic_link",
|
|
41915
42090
|
"x-response-key": "magic_link",
|
|
41916
|
-
"x-title": "Connect Accounts",
|
|
42091
|
+
"x-title": "Generate a Connect Accounts Building Block Magic Link",
|
|
41917
42092
|
"x-undocumented": "Experimental partner building blocks."
|
|
41918
42093
|
}
|
|
41919
42094
|
},
|
|
@@ -41929,10 +42104,14 @@ var openapi_default = {
|
|
|
41929
42104
|
{
|
|
41930
42105
|
properties: {
|
|
41931
42106
|
building_block_type: {
|
|
42107
|
+
description: "`connect_accounts` building block type.",
|
|
41932
42108
|
enum: ["connect_accounts"],
|
|
41933
42109
|
type: "string"
|
|
41934
42110
|
},
|
|
41935
|
-
customer_key: {
|
|
42111
|
+
customer_key: {
|
|
42112
|
+
description: "Customer key for which you want to create a new building block magic link.",
|
|
42113
|
+
type: "string"
|
|
42114
|
+
}
|
|
41936
42115
|
},
|
|
41937
42116
|
required: ["building_block_type", "customer_key"],
|
|
41938
42117
|
type: "object"
|
|
@@ -41940,10 +42119,14 @@ var openapi_default = {
|
|
|
41940
42119
|
{
|
|
41941
42120
|
properties: {
|
|
41942
42121
|
building_block_type: {
|
|
42122
|
+
description: "`manage_devices` building block type.",
|
|
41943
42123
|
enum: ["manage_devices"],
|
|
41944
42124
|
type: "string"
|
|
41945
42125
|
},
|
|
41946
|
-
customer_key: {
|
|
42126
|
+
customer_key: {
|
|
42127
|
+
description: "Customer key for which you want to create a new building block magic link.",
|
|
42128
|
+
type: "string"
|
|
42129
|
+
}
|
|
41947
42130
|
},
|
|
41948
42131
|
required: ["building_block_type", "customer_key"],
|
|
41949
42132
|
type: "object"
|
|
@@ -41951,12 +42134,16 @@ var openapi_default = {
|
|
|
41951
42134
|
{
|
|
41952
42135
|
properties: {
|
|
41953
42136
|
building_block_type: {
|
|
42137
|
+
description: "`organize_spaces` building block type.",
|
|
41954
42138
|
enum: ["organize_spaces"],
|
|
41955
42139
|
type: "string"
|
|
41956
42140
|
},
|
|
41957
|
-
customer_key: {
|
|
42141
|
+
customer_key: {
|
|
42142
|
+
description: "Customer key for which you want to create a new building block magic link.",
|
|
42143
|
+
type: "string"
|
|
42144
|
+
},
|
|
41958
42145
|
partner_resources: {
|
|
41959
|
-
description: "Optional list of partner resources to include in the magic link.",
|
|
42146
|
+
description: "Optional list of partner resources that you want to include in the new building block magic link.",
|
|
41960
42147
|
items: {
|
|
41961
42148
|
properties: {
|
|
41962
42149
|
custom_metadata: {
|
|
@@ -42013,7 +42200,7 @@ var openapi_default = {
|
|
|
42013
42200
|
"x-fern-sdk-method-name": "generate_magic_link",
|
|
42014
42201
|
"x-fern-sdk-return-value": "magic_link",
|
|
42015
42202
|
"x-response-key": "magic_link",
|
|
42016
|
-
"x-title": "Generate a
|
|
42203
|
+
"x-title": "Generate a Building Block Magic Link",
|
|
42017
42204
|
"x-undocumented": "Experimental partner building blocks."
|
|
42018
42205
|
}
|
|
42019
42206
|
},
|
|
@@ -42025,7 +42212,12 @@ var openapi_default = {
|
|
|
42025
42212
|
content: {
|
|
42026
42213
|
"application/json": {
|
|
42027
42214
|
schema: {
|
|
42028
|
-
properties: {
|
|
42215
|
+
properties: {
|
|
42216
|
+
customer_key: {
|
|
42217
|
+
description: "Customer key for which you want to manage devices.",
|
|
42218
|
+
type: "string"
|
|
42219
|
+
}
|
|
42220
|
+
},
|
|
42029
42221
|
required: ["customer_key"],
|
|
42030
42222
|
type: "object"
|
|
42031
42223
|
}
|
|
@@ -42062,7 +42254,7 @@ var openapi_default = {
|
|
|
42062
42254
|
"x-fern-sdk-method-name": "manage_devices",
|
|
42063
42255
|
"x-fern-sdk-return-value": "magic_link",
|
|
42064
42256
|
"x-response-key": "magic_link",
|
|
42065
|
-
"x-title": "Manage Devices",
|
|
42257
|
+
"x-title": "Generate a Manage Devices Building Block Magic Link",
|
|
42066
42258
|
"x-undocumented": "Experimental partner building blocks."
|
|
42067
42259
|
}
|
|
42068
42260
|
},
|
|
@@ -42075,8 +42267,12 @@ var openapi_default = {
|
|
|
42075
42267
|
"application/json": {
|
|
42076
42268
|
schema: {
|
|
42077
42269
|
properties: {
|
|
42078
|
-
customer_key: {
|
|
42270
|
+
customer_key: {
|
|
42271
|
+
description: "Customer key for which you want to organize spaces.",
|
|
42272
|
+
type: "string"
|
|
42273
|
+
},
|
|
42079
42274
|
partner_resources: {
|
|
42275
|
+
description: "Optional list of partner resources that you want to include in the new building block magic link.",
|
|
42080
42276
|
items: {
|
|
42081
42277
|
properties: {
|
|
42082
42278
|
custom_metadata: {
|
|
@@ -42131,13 +42327,13 @@ var openapi_default = {
|
|
|
42131
42327
|
"x-fern-sdk-method-name": "organize_spaces",
|
|
42132
42328
|
"x-fern-sdk-return-value": "magic_link",
|
|
42133
42329
|
"x-response-key": "magic_link",
|
|
42134
|
-
"x-title": "Organize Spaces",
|
|
42330
|
+
"x-title": "Generate an Organize Spaces Building Block Magic Link",
|
|
42135
42331
|
"x-undocumented": "Experimental partner building blocks."
|
|
42136
42332
|
}
|
|
42137
42333
|
},
|
|
42138
42334
|
"/unstable_partner/resources/push": {
|
|
42139
42335
|
post: {
|
|
42140
|
-
description: "
|
|
42336
|
+
description: "Sends Seam some of your resources.",
|
|
42141
42337
|
operationId: "unstablePartnerResourcesPushPost",
|
|
42142
42338
|
requestBody: {
|
|
42143
42339
|
content: {
|
|
@@ -42151,7 +42347,10 @@ var openapi_default = {
|
|
|
42151
42347
|
additionalProperties: { type: "string" },
|
|
42152
42348
|
type: "object"
|
|
42153
42349
|
},
|
|
42154
|
-
customer_key: {
|
|
42350
|
+
customer_key: {
|
|
42351
|
+
description: "Customer key associated with the resource that you want to push to Seam.",
|
|
42352
|
+
type: "string"
|
|
42353
|
+
},
|
|
42155
42354
|
description: { type: "string" },
|
|
42156
42355
|
email_address: { type: "string" },
|
|
42157
42356
|
ends_at: { type: "string" },
|
|
@@ -42160,8 +42359,14 @@ var openapi_default = {
|
|
|
42160
42359
|
type: "array"
|
|
42161
42360
|
},
|
|
42162
42361
|
name: { type: "string" },
|
|
42163
|
-
partner_resource_key: {
|
|
42164
|
-
|
|
42362
|
+
partner_resource_key: {
|
|
42363
|
+
description: "Key of the resource that you want to push to Seam.",
|
|
42364
|
+
type: "string"
|
|
42365
|
+
},
|
|
42366
|
+
partner_resource_type: {
|
|
42367
|
+
description: "Type of the resource that you want to push to Seam.",
|
|
42368
|
+
type: "string"
|
|
42369
|
+
},
|
|
42165
42370
|
phone_number: { type: "string" },
|
|
42166
42371
|
starts_at: { type: "string" },
|
|
42167
42372
|
user_identity_key: { type: "string" }
|
|
@@ -42178,7 +42383,10 @@ var openapi_default = {
|
|
|
42178
42383
|
additionalProperties: { type: "string" },
|
|
42179
42384
|
type: "object"
|
|
42180
42385
|
},
|
|
42181
|
-
customer_key: {
|
|
42386
|
+
customer_key: {
|
|
42387
|
+
description: "Customer key associated with the resource that you want to push to Seam.",
|
|
42388
|
+
type: "string"
|
|
42389
|
+
},
|
|
42182
42390
|
description: { type: "string" },
|
|
42183
42391
|
email_address: { type: "string" },
|
|
42184
42392
|
ends_at: { type: "string" },
|
|
@@ -42187,8 +42395,14 @@ var openapi_default = {
|
|
|
42187
42395
|
type: "array"
|
|
42188
42396
|
},
|
|
42189
42397
|
name: { type: "string" },
|
|
42190
|
-
partner_resource_key: {
|
|
42191
|
-
|
|
42398
|
+
partner_resource_key: {
|
|
42399
|
+
description: "Key of the resource that you want to push to Seam.",
|
|
42400
|
+
type: "string"
|
|
42401
|
+
},
|
|
42402
|
+
partner_resource_type: {
|
|
42403
|
+
description: "Type of the resource that you want to push to Seam.",
|
|
42404
|
+
type: "string"
|
|
42405
|
+
},
|
|
42192
42406
|
phone_number: { type: "string" },
|
|
42193
42407
|
starts_at: { type: "string" },
|
|
42194
42408
|
user_identity_key: { type: "string" }
|
|
@@ -42228,13 +42442,13 @@ var openapi_default = {
|
|
|
42228
42442
|
"x-fern-sdk-group-name": ["unstable_partner", "resources"],
|
|
42229
42443
|
"x-fern-sdk-method-name": "push",
|
|
42230
42444
|
"x-response-key": null,
|
|
42231
|
-
"x-title": "Push
|
|
42445
|
+
"x-title": "Push Partner Resources at Seam",
|
|
42232
42446
|
"x-undocumented": "Experimental partner resources."
|
|
42233
42447
|
}
|
|
42234
42448
|
},
|
|
42235
42449
|
"/user_identities/add_acs_user": {
|
|
42236
42450
|
post: {
|
|
42237
|
-
description: "Adds a specified [
|
|
42451
|
+
description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
|
|
42238
42452
|
operationId: "userIdentitiesAddAcsUserPost",
|
|
42239
42453
|
requestBody: {
|
|
42240
42454
|
content: {
|
|
@@ -42242,12 +42456,12 @@ var openapi_default = {
|
|
|
42242
42456
|
schema: {
|
|
42243
42457
|
properties: {
|
|
42244
42458
|
acs_user_id: {
|
|
42245
|
-
description: "ID of the
|
|
42459
|
+
description: "ID of the access system user that you want to add to the user identity.",
|
|
42246
42460
|
format: "uuid",
|
|
42247
42461
|
type: "string"
|
|
42248
42462
|
},
|
|
42249
42463
|
user_identity_id: {
|
|
42250
|
-
description: "ID of the
|
|
42464
|
+
description: "ID of the user identity to which you want to add an access system user.",
|
|
42251
42465
|
format: "uuid",
|
|
42252
42466
|
type: "string"
|
|
42253
42467
|
}
|
|
@@ -42287,7 +42501,7 @@ var openapi_default = {
|
|
|
42287
42501
|
"x-title": "Add an ACS User to a User Identity"
|
|
42288
42502
|
},
|
|
42289
42503
|
put: {
|
|
42290
|
-
description: "Adds a specified [
|
|
42504
|
+
description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
|
|
42291
42505
|
operationId: "userIdentitiesAddAcsUserPut",
|
|
42292
42506
|
requestBody: {
|
|
42293
42507
|
content: {
|
|
@@ -42295,12 +42509,12 @@ var openapi_default = {
|
|
|
42295
42509
|
schema: {
|
|
42296
42510
|
properties: {
|
|
42297
42511
|
acs_user_id: {
|
|
42298
|
-
description: "ID of the
|
|
42512
|
+
description: "ID of the access system user that you want to add to the user identity.",
|
|
42299
42513
|
format: "uuid",
|
|
42300
42514
|
type: "string"
|
|
42301
42515
|
},
|
|
42302
42516
|
user_identity_id: {
|
|
42303
|
-
description: "ID of the
|
|
42517
|
+
description: "ID of the user identity to which you want to add an access system user.",
|
|
42304
42518
|
format: "uuid",
|
|
42305
42519
|
type: "string"
|
|
42306
42520
|
}
|
|
@@ -42349,29 +42563,29 @@ var openapi_default = {
|
|
|
42349
42563
|
schema: {
|
|
42350
42564
|
properties: {
|
|
42351
42565
|
acs_system_ids: {
|
|
42352
|
-
description: "List of
|
|
42566
|
+
description: "List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity.",
|
|
42353
42567
|
items: { format: "uuid", type: "string" },
|
|
42354
42568
|
type: "array"
|
|
42355
42569
|
},
|
|
42356
42570
|
email_address: {
|
|
42357
|
-
description: "Unique email address for the user identity.",
|
|
42571
|
+
description: "Unique email address for the new user identity.",
|
|
42358
42572
|
format: "email",
|
|
42359
42573
|
nullable: true,
|
|
42360
42574
|
type: "string"
|
|
42361
42575
|
},
|
|
42362
42576
|
full_name: {
|
|
42363
|
-
description: "Full name of the user associated with the user identity.",
|
|
42577
|
+
description: "Full name of the user associated with the new user identity.",
|
|
42364
42578
|
minLength: 1,
|
|
42365
42579
|
nullable: true,
|
|
42366
42580
|
type: "string"
|
|
42367
42581
|
},
|
|
42368
42582
|
phone_number: {
|
|
42369
|
-
description: "Unique phone number for the user identity in E.164 format (for example, +15555550100).",
|
|
42583
|
+
description: "Unique phone number for the new user identity in E.164 format (for example, +15555550100).",
|
|
42370
42584
|
nullable: true,
|
|
42371
42585
|
type: "string"
|
|
42372
42586
|
},
|
|
42373
42587
|
user_identity_key: {
|
|
42374
|
-
description: "Unique key for the user identity.",
|
|
42588
|
+
description: "Unique key for the new user identity.",
|
|
42375
42589
|
minLength: 1,
|
|
42376
42590
|
nullable: true,
|
|
42377
42591
|
type: "string"
|
|
@@ -42427,7 +42641,7 @@ var openapi_default = {
|
|
|
42427
42641
|
schema: {
|
|
42428
42642
|
properties: {
|
|
42429
42643
|
user_identity_id: {
|
|
42430
|
-
description: "ID of the
|
|
42644
|
+
description: "ID of the user identity that you want to delete.",
|
|
42431
42645
|
format: "uuid",
|
|
42432
42646
|
type: "string"
|
|
42433
42647
|
}
|
|
@@ -42477,7 +42691,7 @@ var openapi_default = {
|
|
|
42477
42691
|
schema: {
|
|
42478
42692
|
properties: {
|
|
42479
42693
|
enrollment_automation_id: {
|
|
42480
|
-
description: "ID of the
|
|
42694
|
+
description: "ID of the enrollment automation that you want to delete.",
|
|
42481
42695
|
format: "uuid",
|
|
42482
42696
|
type: "string"
|
|
42483
42697
|
}
|
|
@@ -42527,7 +42741,7 @@ var openapi_default = {
|
|
|
42527
42741
|
schema: {
|
|
42528
42742
|
properties: {
|
|
42529
42743
|
enrollment_automation_id: {
|
|
42530
|
-
description: "ID of the
|
|
42744
|
+
description: "ID of the enrollment automation that you want to get.",
|
|
42531
42745
|
format: "uuid",
|
|
42532
42746
|
type: "string"
|
|
42533
42747
|
}
|
|
@@ -42584,7 +42798,7 @@ var openapi_default = {
|
|
|
42584
42798
|
schema: {
|
|
42585
42799
|
properties: {
|
|
42586
42800
|
acs_credential_pool_id: {
|
|
42587
|
-
description: "ID of the
|
|
42801
|
+
description: "ID of the credential pool from which to obtain credentials for the user identity.",
|
|
42588
42802
|
format: "uuid",
|
|
42589
42803
|
type: "string"
|
|
42590
42804
|
},
|
|
@@ -42593,17 +42807,17 @@ var openapi_default = {
|
|
|
42593
42807
|
type: "boolean"
|
|
42594
42808
|
},
|
|
42595
42809
|
credential_manager_acs_system_id: {
|
|
42596
|
-
description: "ID of the desired
|
|
42810
|
+
description: "ID of the desired access system that serves as the credential manager for the enrollment automation.",
|
|
42597
42811
|
format: "uuid",
|
|
42598
42812
|
type: "string"
|
|
42599
42813
|
},
|
|
42600
42814
|
credential_manager_acs_user_id: {
|
|
42601
|
-
description: "ID of the associated
|
|
42815
|
+
description: "ID of the associated access system user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`.",
|
|
42602
42816
|
format: "uuid",
|
|
42603
42817
|
type: "string"
|
|
42604
42818
|
},
|
|
42605
42819
|
user_identity_id: {
|
|
42606
|
-
description: "ID of the
|
|
42820
|
+
description: "ID of the user identity for which you want to launch an enrollment automation.",
|
|
42607
42821
|
format: "uuid",
|
|
42608
42822
|
type: "string"
|
|
42609
42823
|
}
|
|
@@ -42687,7 +42901,7 @@ var openapi_default = {
|
|
|
42687
42901
|
schema: {
|
|
42688
42902
|
properties: {
|
|
42689
42903
|
user_identity_id: {
|
|
42690
|
-
description: "ID of the user identity for which you want to retrieve
|
|
42904
|
+
description: "ID of the user identity for which you want to retrieve enrollment automations.",
|
|
42691
42905
|
format: "uuid",
|
|
42692
42906
|
type: "string"
|
|
42693
42907
|
}
|
|
@@ -42748,7 +42962,7 @@ var openapi_default = {
|
|
|
42748
42962
|
properties: {
|
|
42749
42963
|
max_use_count: {
|
|
42750
42964
|
default: 1,
|
|
42751
|
-
description: "
|
|
42965
|
+
description: "Maximum number of times the instant key can be used. Default: 1.",
|
|
42752
42966
|
format: "float",
|
|
42753
42967
|
type: "number"
|
|
42754
42968
|
},
|
|
@@ -42809,7 +43023,7 @@ var openapi_default = {
|
|
|
42809
43023
|
{
|
|
42810
43024
|
properties: {
|
|
42811
43025
|
user_identity_id: {
|
|
42812
|
-
description: "ID of the
|
|
43026
|
+
description: "ID of the user identity that you want to get.",
|
|
42813
43027
|
format: "uuid",
|
|
42814
43028
|
type: "string"
|
|
42815
43029
|
}
|
|
@@ -42872,12 +43086,12 @@ var openapi_default = {
|
|
|
42872
43086
|
schema: {
|
|
42873
43087
|
properties: {
|
|
42874
43088
|
device_id: {
|
|
42875
|
-
description: "ID of the
|
|
43089
|
+
description: "ID of the managed device to which you want to grant access to the user identity.",
|
|
42876
43090
|
format: "uuid",
|
|
42877
43091
|
type: "string"
|
|
42878
43092
|
},
|
|
42879
43093
|
user_identity_id: {
|
|
42880
|
-
description: "ID of the
|
|
43094
|
+
description: "ID of the user identity that you want to grant access to a device.",
|
|
42881
43095
|
format: "uuid",
|
|
42882
43096
|
type: "string"
|
|
42883
43097
|
}
|
|
@@ -42925,12 +43139,12 @@ var openapi_default = {
|
|
|
42925
43139
|
schema: {
|
|
42926
43140
|
properties: {
|
|
42927
43141
|
device_id: {
|
|
42928
|
-
description: "ID of the
|
|
43142
|
+
description: "ID of the managed device to which you want to grant access to the user identity.",
|
|
42929
43143
|
format: "uuid",
|
|
42930
43144
|
type: "string"
|
|
42931
43145
|
},
|
|
42932
43146
|
user_identity_id: {
|
|
42933
|
-
description: "ID of the
|
|
43147
|
+
description: "ID of the user identity that you want to grant access to a device.",
|
|
42934
43148
|
format: "uuid",
|
|
42935
43149
|
type: "string"
|
|
42936
43150
|
}
|
|
@@ -42979,6 +43193,7 @@ var openapi_default = {
|
|
|
42979
43193
|
schema: {
|
|
42980
43194
|
properties: {
|
|
42981
43195
|
credential_manager_acs_system_id: {
|
|
43196
|
+
description: "`acs_system_id` of the credential manager by which you want to filter the list of user identities.",
|
|
42982
43197
|
format: "uuid",
|
|
42983
43198
|
type: "string"
|
|
42984
43199
|
}
|
|
@@ -43056,7 +43271,7 @@ var openapi_default = {
|
|
|
43056
43271
|
deprecated: true,
|
|
43057
43272
|
items: { $ref: "#/components/schemas/device" },
|
|
43058
43273
|
type: "array",
|
|
43059
|
-
"x-deprecated": "
|
|
43274
|
+
"x-deprecated": "Use devices."
|
|
43060
43275
|
},
|
|
43061
43276
|
devices: {
|
|
43062
43277
|
items: { $ref: "#/components/schemas/device" },
|
|
@@ -43090,7 +43305,7 @@ var openapi_default = {
|
|
|
43090
43305
|
},
|
|
43091
43306
|
"/user_identities/list_acs_systems": {
|
|
43092
43307
|
post: {
|
|
43093
|
-
description: "Returns a list of all [access
|
|
43308
|
+
description: "Returns a list of all [access systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
|
|
43094
43309
|
operationId: "userIdentitiesListAcsSystemsPost",
|
|
43095
43310
|
requestBody: {
|
|
43096
43311
|
content: {
|
|
@@ -43098,7 +43313,7 @@ var openapi_default = {
|
|
|
43098
43313
|
schema: {
|
|
43099
43314
|
properties: {
|
|
43100
43315
|
user_identity_id: {
|
|
43101
|
-
description: "ID of the user identity for which you want to retrieve all access
|
|
43316
|
+
description: "ID of the user identity for which you want to retrieve all access systems.",
|
|
43102
43317
|
format: "uuid",
|
|
43103
43318
|
type: "string"
|
|
43104
43319
|
}
|
|
@@ -43148,7 +43363,7 @@ var openapi_default = {
|
|
|
43148
43363
|
},
|
|
43149
43364
|
"/user_identities/list_acs_users": {
|
|
43150
43365
|
post: {
|
|
43151
|
-
description: "Returns a list of all [
|
|
43366
|
+
description: "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
|
|
43152
43367
|
operationId: "userIdentitiesListAcsUsersPost",
|
|
43153
43368
|
requestBody: {
|
|
43154
43369
|
content: {
|
|
@@ -43156,7 +43371,7 @@ var openapi_default = {
|
|
|
43156
43371
|
schema: {
|
|
43157
43372
|
properties: {
|
|
43158
43373
|
user_identity_id: {
|
|
43159
|
-
description: "ID of the user identity for which you want to retrieve all
|
|
43374
|
+
description: "ID of the user identity for which you want to retrieve all access system users.",
|
|
43160
43375
|
format: "uuid",
|
|
43161
43376
|
type: "string"
|
|
43162
43377
|
}
|
|
@@ -43205,7 +43420,7 @@ var openapi_default = {
|
|
|
43205
43420
|
},
|
|
43206
43421
|
"/user_identities/remove_acs_user": {
|
|
43207
43422
|
post: {
|
|
43208
|
-
description: "Removes a specified [
|
|
43423
|
+
description: "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
|
|
43209
43424
|
operationId: "userIdentitiesRemoveAcsUserPost",
|
|
43210
43425
|
requestBody: {
|
|
43211
43426
|
content: {
|
|
@@ -43213,12 +43428,12 @@ var openapi_default = {
|
|
|
43213
43428
|
schema: {
|
|
43214
43429
|
properties: {
|
|
43215
43430
|
acs_user_id: {
|
|
43216
|
-
description: "ID of the
|
|
43431
|
+
description: "ID of the access system user that you want to remove from the user identity..",
|
|
43217
43432
|
format: "uuid",
|
|
43218
43433
|
type: "string"
|
|
43219
43434
|
},
|
|
43220
43435
|
user_identity_id: {
|
|
43221
|
-
description: "ID of the
|
|
43436
|
+
description: "ID of the user identity from which you want to remove an access system user.",
|
|
43222
43437
|
format: "uuid",
|
|
43223
43438
|
type: "string"
|
|
43224
43439
|
}
|
|
@@ -43268,12 +43483,12 @@ var openapi_default = {
|
|
|
43268
43483
|
schema: {
|
|
43269
43484
|
properties: {
|
|
43270
43485
|
device_id: {
|
|
43271
|
-
description: "ID of the
|
|
43486
|
+
description: "ID of the managed device to which you want to revoke access from the user identity.",
|
|
43272
43487
|
format: "uuid",
|
|
43273
43488
|
type: "string"
|
|
43274
43489
|
},
|
|
43275
43490
|
user_identity_id: {
|
|
43276
|
-
description: "ID of the
|
|
43491
|
+
description: "ID of the user identity from which you want to revoke access to a device.",
|
|
43277
43492
|
format: "uuid",
|
|
43278
43493
|
type: "string"
|
|
43279
43494
|
}
|
|
@@ -43315,6 +43530,7 @@ var openapi_default = {
|
|
|
43315
43530
|
},
|
|
43316
43531
|
"/user_identities/update": {
|
|
43317
43532
|
patch: {
|
|
43533
|
+
description: "Updates a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
|
|
43318
43534
|
operationId: "userIdentitiesUpdatePatch",
|
|
43319
43535
|
requestBody: {
|
|
43320
43536
|
content: {
|
|
@@ -43327,14 +43543,19 @@ var openapi_default = {
|
|
|
43327
43543
|
nullable: true,
|
|
43328
43544
|
type: "string"
|
|
43329
43545
|
},
|
|
43330
|
-
full_name: {
|
|
43546
|
+
full_name: {
|
|
43547
|
+
description: "Full name of the user associated with the user identity.",
|
|
43548
|
+
minLength: 1,
|
|
43549
|
+
nullable: true,
|
|
43550
|
+
type: "string"
|
|
43551
|
+
},
|
|
43331
43552
|
phone_number: {
|
|
43332
|
-
description: "Unique phone number for the user identity
|
|
43553
|
+
description: "Unique phone number for the user identity.",
|
|
43333
43554
|
nullable: true,
|
|
43334
43555
|
type: "string"
|
|
43335
43556
|
},
|
|
43336
43557
|
user_identity_id: {
|
|
43337
|
-
description: "ID of the user identity.",
|
|
43558
|
+
description: "ID of the user identity that you want to update.",
|
|
43338
43559
|
format: "uuid",
|
|
43339
43560
|
type: "string"
|
|
43340
43561
|
},
|
|
@@ -43379,6 +43600,7 @@ var openapi_default = {
|
|
|
43379
43600
|
"x-title": "Update a User Identity"
|
|
43380
43601
|
},
|
|
43381
43602
|
post: {
|
|
43603
|
+
description: "Updates a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
|
|
43382
43604
|
operationId: "userIdentitiesUpdatePost",
|
|
43383
43605
|
requestBody: {
|
|
43384
43606
|
content: {
|
|
@@ -43391,14 +43613,19 @@ var openapi_default = {
|
|
|
43391
43613
|
nullable: true,
|
|
43392
43614
|
type: "string"
|
|
43393
43615
|
},
|
|
43394
|
-
full_name: {
|
|
43616
|
+
full_name: {
|
|
43617
|
+
description: "Full name of the user associated with the user identity.",
|
|
43618
|
+
minLength: 1,
|
|
43619
|
+
nullable: true,
|
|
43620
|
+
type: "string"
|
|
43621
|
+
},
|
|
43395
43622
|
phone_number: {
|
|
43396
|
-
description: "Unique phone number for the user identity
|
|
43623
|
+
description: "Unique phone number for the user identity.",
|
|
43397
43624
|
nullable: true,
|
|
43398
43625
|
type: "string"
|
|
43399
43626
|
},
|
|
43400
43627
|
user_identity_id: {
|
|
43401
|
-
description: "ID of the user identity.",
|
|
43628
|
+
description: "ID of the user identity that you want to update.",
|
|
43402
43629
|
format: "uuid",
|
|
43403
43630
|
type: "string"
|
|
43404
43631
|
},
|
|
@@ -43446,6 +43673,7 @@ var openapi_default = {
|
|
|
43446
43673
|
},
|
|
43447
43674
|
"/webhooks/create": {
|
|
43448
43675
|
post: {
|
|
43676
|
+
description: "Creates a new [webhook](https://docs.seam.co/latest/developer-tools/webhooks).",
|
|
43449
43677
|
operationId: "webhooksCreatePost",
|
|
43450
43678
|
requestBody: {
|
|
43451
43679
|
content: {
|
|
@@ -43454,10 +43682,15 @@ var openapi_default = {
|
|
|
43454
43682
|
properties: {
|
|
43455
43683
|
event_types: {
|
|
43456
43684
|
default: ["*"],
|
|
43685
|
+
description: "Types of events that you want the new webhook to receive.",
|
|
43457
43686
|
items: { type: "string" },
|
|
43458
43687
|
type: "array"
|
|
43459
43688
|
},
|
|
43460
|
-
url: {
|
|
43689
|
+
url: {
|
|
43690
|
+
description: "URL for the new webhook.",
|
|
43691
|
+
format: "uri",
|
|
43692
|
+
type: "string"
|
|
43693
|
+
}
|
|
43461
43694
|
},
|
|
43462
43695
|
required: ["url"],
|
|
43463
43696
|
type: "object"
|
|
@@ -43494,17 +43727,24 @@ var openapi_default = {
|
|
|
43494
43727
|
"x-fern-sdk-group-name": ["webhooks"],
|
|
43495
43728
|
"x-fern-sdk-method-name": "create",
|
|
43496
43729
|
"x-fern-sdk-return-value": "webhook",
|
|
43497
|
-
"x-response-key": "webhook"
|
|
43730
|
+
"x-response-key": "webhook",
|
|
43731
|
+
"x-title": "Create a Webhook"
|
|
43498
43732
|
}
|
|
43499
43733
|
},
|
|
43500
43734
|
"/webhooks/delete": {
|
|
43501
43735
|
post: {
|
|
43736
|
+
description: "Deletes a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).",
|
|
43502
43737
|
operationId: "webhooksDeletePost",
|
|
43503
43738
|
requestBody: {
|
|
43504
43739
|
content: {
|
|
43505
43740
|
"application/json": {
|
|
43506
43741
|
schema: {
|
|
43507
|
-
properties: {
|
|
43742
|
+
properties: {
|
|
43743
|
+
webhook_id: {
|
|
43744
|
+
description: "ID of the webhook that you want to delete.",
|
|
43745
|
+
type: "string"
|
|
43746
|
+
}
|
|
43747
|
+
},
|
|
43508
43748
|
required: ["webhook_id"],
|
|
43509
43749
|
type: "object"
|
|
43510
43750
|
}
|
|
@@ -43536,17 +43776,24 @@ var openapi_default = {
|
|
|
43536
43776
|
tags: ["/webhooks"],
|
|
43537
43777
|
"x-fern-sdk-group-name": ["webhooks"],
|
|
43538
43778
|
"x-fern-sdk-method-name": "delete",
|
|
43539
|
-
"x-response-key": null
|
|
43779
|
+
"x-response-key": null,
|
|
43780
|
+
"x-title": "Delete a Webhook"
|
|
43540
43781
|
}
|
|
43541
43782
|
},
|
|
43542
43783
|
"/webhooks/get": {
|
|
43543
43784
|
post: {
|
|
43785
|
+
description: "Gets a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).",
|
|
43544
43786
|
operationId: "webhooksGetPost",
|
|
43545
43787
|
requestBody: {
|
|
43546
43788
|
content: {
|
|
43547
43789
|
"application/json": {
|
|
43548
43790
|
schema: {
|
|
43549
|
-
properties: {
|
|
43791
|
+
properties: {
|
|
43792
|
+
webhook_id: {
|
|
43793
|
+
description: "ID of the webhook that you want to get.",
|
|
43794
|
+
type: "string"
|
|
43795
|
+
}
|
|
43796
|
+
},
|
|
43550
43797
|
required: ["webhook_id"],
|
|
43551
43798
|
type: "object"
|
|
43552
43799
|
}
|
|
@@ -43582,11 +43829,13 @@ var openapi_default = {
|
|
|
43582
43829
|
"x-fern-sdk-group-name": ["webhooks"],
|
|
43583
43830
|
"x-fern-sdk-method-name": "get",
|
|
43584
43831
|
"x-fern-sdk-return-value": "webhook",
|
|
43585
|
-
"x-response-key": "webhook"
|
|
43832
|
+
"x-response-key": "webhook",
|
|
43833
|
+
"x-title": "Get a Webhook"
|
|
43586
43834
|
}
|
|
43587
43835
|
},
|
|
43588
43836
|
"/webhooks/list": {
|
|
43589
43837
|
get: {
|
|
43838
|
+
description: "Returns a list of all [webhooks](https://docs.seam.co/latest/developer-tools/webhooks).",
|
|
43590
43839
|
operationId: "webhooksListGet",
|
|
43591
43840
|
responses: {
|
|
43592
43841
|
200: {
|
|
@@ -43618,9 +43867,11 @@ var openapi_default = {
|
|
|
43618
43867
|
summary: "/webhooks/list",
|
|
43619
43868
|
tags: ["/webhooks"],
|
|
43620
43869
|
"x-fern-ignore": true,
|
|
43621
|
-
"x-response-key": "webhooks"
|
|
43870
|
+
"x-response-key": "webhooks",
|
|
43871
|
+
"x-title": "List Webhooks"
|
|
43622
43872
|
},
|
|
43623
43873
|
post: {
|
|
43874
|
+
description: "Returns a list of all [webhooks](https://docs.seam.co/latest/developer-tools/webhooks).",
|
|
43624
43875
|
operationId: "webhooksListPost",
|
|
43625
43876
|
responses: {
|
|
43626
43877
|
200: {
|
|
@@ -43654,19 +43905,28 @@ var openapi_default = {
|
|
|
43654
43905
|
"x-fern-sdk-group-name": ["webhooks"],
|
|
43655
43906
|
"x-fern-sdk-method-name": "list",
|
|
43656
43907
|
"x-fern-sdk-return-value": "webhooks",
|
|
43657
|
-
"x-response-key": "webhooks"
|
|
43908
|
+
"x-response-key": "webhooks",
|
|
43909
|
+
"x-title": "List Webhooks"
|
|
43658
43910
|
}
|
|
43659
43911
|
},
|
|
43660
43912
|
"/webhooks/update": {
|
|
43661
43913
|
post: {
|
|
43914
|
+
description: "Updates a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).",
|
|
43662
43915
|
operationId: "webhooksUpdatePost",
|
|
43663
43916
|
requestBody: {
|
|
43664
43917
|
content: {
|
|
43665
43918
|
"application/json": {
|
|
43666
43919
|
schema: {
|
|
43667
43920
|
properties: {
|
|
43668
|
-
event_types: {
|
|
43669
|
-
|
|
43921
|
+
event_types: {
|
|
43922
|
+
description: "Types of events that you want the webhook to receive.",
|
|
43923
|
+
items: { type: "string" },
|
|
43924
|
+
type: "array"
|
|
43925
|
+
},
|
|
43926
|
+
webhook_id: {
|
|
43927
|
+
description: "ID of the webhook that you want to update.",
|
|
43928
|
+
type: "string"
|
|
43929
|
+
}
|
|
43670
43930
|
},
|
|
43671
43931
|
required: ["webhook_id", "event_types"],
|
|
43672
43932
|
type: "object"
|
|
@@ -43699,17 +43959,26 @@ var openapi_default = {
|
|
|
43699
43959
|
tags: ["/webhooks"],
|
|
43700
43960
|
"x-fern-sdk-group-name": ["webhooks"],
|
|
43701
43961
|
"x-fern-sdk-method-name": "update",
|
|
43702
|
-
"x-response-key": null
|
|
43962
|
+
"x-response-key": null,
|
|
43963
|
+
"x-title": "Update a Webhook"
|
|
43703
43964
|
},
|
|
43704
43965
|
put: {
|
|
43966
|
+
description: "Updates a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).",
|
|
43705
43967
|
operationId: "webhooksUpdatePut",
|
|
43706
43968
|
requestBody: {
|
|
43707
43969
|
content: {
|
|
43708
43970
|
"application/json": {
|
|
43709
43971
|
schema: {
|
|
43710
43972
|
properties: {
|
|
43711
|
-
event_types: {
|
|
43712
|
-
|
|
43973
|
+
event_types: {
|
|
43974
|
+
description: "Types of events that you want the webhook to receive.",
|
|
43975
|
+
items: { type: "string" },
|
|
43976
|
+
type: "array"
|
|
43977
|
+
},
|
|
43978
|
+
webhook_id: {
|
|
43979
|
+
description: "ID of the webhook that you want to update.",
|
|
43980
|
+
type: "string"
|
|
43981
|
+
}
|
|
43713
43982
|
},
|
|
43714
43983
|
required: ["webhook_id", "event_types"],
|
|
43715
43984
|
type: "object"
|
|
@@ -43741,42 +44010,66 @@ var openapi_default = {
|
|
|
43741
44010
|
summary: "/webhooks/update",
|
|
43742
44011
|
tags: ["/webhooks"],
|
|
43743
44012
|
"x-fern-ignore": true,
|
|
43744
|
-
"x-response-key": null
|
|
44013
|
+
"x-response-key": null,
|
|
44014
|
+
"x-title": "Update a Webhook"
|
|
43745
44015
|
}
|
|
43746
44016
|
},
|
|
43747
44017
|
"/workspaces/create": {
|
|
43748
44018
|
post: {
|
|
44019
|
+
description: "Creates a new [workspace](https://docs.seam.co/latest/core-concepts/workspaces).",
|
|
43749
44020
|
operationId: "workspacesCreatePost",
|
|
43750
44021
|
requestBody: {
|
|
43751
44022
|
content: {
|
|
43752
44023
|
"application/json": {
|
|
43753
44024
|
schema: {
|
|
43754
44025
|
properties: {
|
|
43755
|
-
company_name: {
|
|
44026
|
+
company_name: {
|
|
44027
|
+
description: "Company name for the new workspace.",
|
|
44028
|
+
type: "string"
|
|
44029
|
+
},
|
|
43756
44030
|
connect_partner_name: {
|
|
43757
44031
|
deprecated: true,
|
|
44032
|
+
description: "Connect partner name for the new workspace.",
|
|
43758
44033
|
nullable: true,
|
|
43759
44034
|
type: "string",
|
|
43760
44035
|
"x-deprecated": "use company_name"
|
|
43761
44036
|
},
|
|
43762
44037
|
connect_webview_customization: {
|
|
44038
|
+
description: "[Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) customizations for the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
|
|
43763
44039
|
properties: {
|
|
43764
44040
|
logo_shape: {
|
|
44041
|
+
description: "Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
|
|
43765
44042
|
enum: ["circle", "square"],
|
|
43766
44043
|
nullable: true,
|
|
43767
44044
|
type: "string"
|
|
43768
44045
|
},
|
|
43769
|
-
primary_button_color: {
|
|
44046
|
+
primary_button_color: {
|
|
44047
|
+
description: "Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
|
|
44048
|
+
nullable: true,
|
|
44049
|
+
type: "string"
|
|
44050
|
+
},
|
|
43770
44051
|
primary_button_text_color: {
|
|
44052
|
+
description: "Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
|
|
43771
44053
|
nullable: true,
|
|
43772
44054
|
type: "string"
|
|
43773
44055
|
},
|
|
43774
|
-
success_message: {
|
|
44056
|
+
success_message: {
|
|
44057
|
+
description: "Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
|
|
44058
|
+
nullable: true,
|
|
44059
|
+
type: "string"
|
|
44060
|
+
}
|
|
43775
44061
|
},
|
|
43776
44062
|
type: "object"
|
|
43777
44063
|
},
|
|
43778
|
-
is_sandbox: {
|
|
43779
|
-
|
|
44064
|
+
is_sandbox: {
|
|
44065
|
+
default: false,
|
|
44066
|
+
description: "Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).",
|
|
44067
|
+
type: "boolean"
|
|
44068
|
+
},
|
|
44069
|
+
name: {
|
|
44070
|
+
description: "Name of the new workspace.",
|
|
44071
|
+
type: "string"
|
|
44072
|
+
},
|
|
43780
44073
|
webview_logo_shape: {
|
|
43781
44074
|
deprecated: true,
|
|
43782
44075
|
enum: ["circle", "square"],
|
|
@@ -43834,11 +44127,13 @@ var openapi_default = {
|
|
|
43834
44127
|
"x-fern-sdk-group-name": ["workspaces"],
|
|
43835
44128
|
"x-fern-sdk-method-name": "create",
|
|
43836
44129
|
"x-fern-sdk-return-value": "workspace",
|
|
43837
|
-
"x-response-key": "workspace"
|
|
44130
|
+
"x-response-key": "workspace",
|
|
44131
|
+
"x-title": "Create a Workspace"
|
|
43838
44132
|
}
|
|
43839
44133
|
},
|
|
43840
44134
|
"/workspaces/get": {
|
|
43841
44135
|
get: {
|
|
44136
|
+
description: "Returns the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.",
|
|
43842
44137
|
operationId: "workspacesGetGet",
|
|
43843
44138
|
responses: {
|
|
43844
44139
|
200: {
|
|
@@ -43863,14 +44158,17 @@ var openapi_default = {
|
|
|
43863
44158
|
{ api_key: [] },
|
|
43864
44159
|
{ console_session_with_workspace: [] },
|
|
43865
44160
|
{ client_session: [] },
|
|
44161
|
+
{ client_session_with_customer: [] },
|
|
43866
44162
|
{ pat_with_workspace: [] }
|
|
43867
44163
|
],
|
|
43868
44164
|
summary: "/workspaces/get",
|
|
43869
44165
|
tags: ["/workspaces"],
|
|
43870
44166
|
"x-fern-ignore": true,
|
|
43871
|
-
"x-response-key": "workspace"
|
|
44167
|
+
"x-response-key": "workspace",
|
|
44168
|
+
"x-title": "Get a Workspace"
|
|
43872
44169
|
},
|
|
43873
44170
|
post: {
|
|
44171
|
+
description: "Returns the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.",
|
|
43874
44172
|
operationId: "workspacesGetPost",
|
|
43875
44173
|
responses: {
|
|
43876
44174
|
200: {
|
|
@@ -43895,6 +44193,7 @@ var openapi_default = {
|
|
|
43895
44193
|
{ api_key: [] },
|
|
43896
44194
|
{ console_session_with_workspace: [] },
|
|
43897
44195
|
{ client_session: [] },
|
|
44196
|
+
{ client_session_with_customer: [] },
|
|
43898
44197
|
{ pat_with_workspace: [] }
|
|
43899
44198
|
],
|
|
43900
44199
|
summary: "/workspaces/get",
|
|
@@ -43902,11 +44201,13 @@ var openapi_default = {
|
|
|
43902
44201
|
"x-fern-sdk-group-name": ["workspaces"],
|
|
43903
44202
|
"x-fern-sdk-method-name": "get",
|
|
43904
44203
|
"x-fern-sdk-return-value": "workspace",
|
|
43905
|
-
"x-response-key": "workspace"
|
|
44204
|
+
"x-response-key": "workspace",
|
|
44205
|
+
"x-title": "Get a Workspace"
|
|
43906
44206
|
}
|
|
43907
44207
|
},
|
|
43908
44208
|
"/workspaces/list": {
|
|
43909
44209
|
get: {
|
|
44210
|
+
description: "Returns a list of [workspaces](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.",
|
|
43910
44211
|
operationId: "workspacesListGet",
|
|
43911
44212
|
responses: {
|
|
43912
44213
|
200: {
|
|
@@ -43941,9 +44242,11 @@ var openapi_default = {
|
|
|
43941
44242
|
summary: "/workspaces/list",
|
|
43942
44243
|
tags: ["/workspaces"],
|
|
43943
44244
|
"x-fern-ignore": true,
|
|
43944
|
-
"x-response-key": "workspaces"
|
|
44245
|
+
"x-response-key": "workspaces",
|
|
44246
|
+
"x-title": "List Workspaces"
|
|
43945
44247
|
},
|
|
43946
44248
|
post: {
|
|
44249
|
+
description: "Returns a list of [workspaces](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.",
|
|
43947
44250
|
operationId: "workspacesListPost",
|
|
43948
44251
|
responses: {
|
|
43949
44252
|
200: {
|
|
@@ -43980,12 +44283,13 @@ var openapi_default = {
|
|
|
43980
44283
|
"x-fern-sdk-group-name": ["workspaces"],
|
|
43981
44284
|
"x-fern-sdk-method-name": "list",
|
|
43982
44285
|
"x-fern-sdk-return-value": "workspaces",
|
|
43983
|
-
"x-response-key": "workspaces"
|
|
44286
|
+
"x-response-key": "workspaces",
|
|
44287
|
+
"x-title": "List Workspaces"
|
|
43984
44288
|
}
|
|
43985
44289
|
},
|
|
43986
44290
|
"/workspaces/reset_sandbox": {
|
|
43987
44291
|
post: {
|
|
43988
|
-
description: "Resets
|
|
44292
|
+
description: "Resets the [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces.",
|
|
43989
44293
|
operationId: "workspacesResetSandboxPost",
|
|
43990
44294
|
responses: {
|
|
43991
44295
|
200: {
|
|
@@ -44019,36 +44323,58 @@ var openapi_default = {
|
|
|
44019
44323
|
"x-fern-sdk-group-name": ["workspaces"],
|
|
44020
44324
|
"x-fern-sdk-method-name": "reset_sandbox",
|
|
44021
44325
|
"x-fern-sdk-return-value": "action_attempt",
|
|
44022
|
-
"x-response-key": "action_attempt"
|
|
44326
|
+
"x-response-key": "action_attempt",
|
|
44327
|
+
"x-title": "Reset a Sandbox Workspace"
|
|
44023
44328
|
}
|
|
44024
44329
|
},
|
|
44025
44330
|
"/workspaces/update": {
|
|
44026
44331
|
patch: {
|
|
44332
|
+
description: "Updates the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.",
|
|
44027
44333
|
operationId: "workspacesUpdatePatch",
|
|
44028
44334
|
requestBody: {
|
|
44029
44335
|
content: {
|
|
44030
44336
|
"application/json": {
|
|
44031
44337
|
schema: {
|
|
44032
44338
|
properties: {
|
|
44033
|
-
connect_partner_name: {
|
|
44339
|
+
connect_partner_name: {
|
|
44340
|
+
description: "Connect partner name for the workspace.",
|
|
44341
|
+
type: "string"
|
|
44342
|
+
},
|
|
44034
44343
|
connect_webview_customization: {
|
|
44344
|
+
description: "[Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
|
|
44035
44345
|
properties: {
|
|
44036
44346
|
logo_shape: {
|
|
44347
|
+
description: "Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
|
|
44037
44348
|
enum: ["circle", "square"],
|
|
44038
44349
|
nullable: true,
|
|
44039
44350
|
type: "string"
|
|
44040
44351
|
},
|
|
44041
|
-
primary_button_color: {
|
|
44352
|
+
primary_button_color: {
|
|
44353
|
+
description: "Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
|
|
44354
|
+
nullable: true,
|
|
44355
|
+
type: "string"
|
|
44356
|
+
},
|
|
44042
44357
|
primary_button_text_color: {
|
|
44358
|
+
description: "Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
|
|
44043
44359
|
nullable: true,
|
|
44044
44360
|
type: "string"
|
|
44045
44361
|
},
|
|
44046
|
-
success_message: {
|
|
44362
|
+
success_message: {
|
|
44363
|
+
description: "Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
|
|
44364
|
+
nullable: true,
|
|
44365
|
+
type: "string"
|
|
44366
|
+
}
|
|
44047
44367
|
},
|
|
44048
44368
|
type: "object"
|
|
44049
44369
|
},
|
|
44050
|
-
is_suspended: {
|
|
44051
|
-
|
|
44370
|
+
is_suspended: {
|
|
44371
|
+
description: "Indicates whether the workspace is suspended.",
|
|
44372
|
+
type: "boolean"
|
|
44373
|
+
},
|
|
44374
|
+
name: {
|
|
44375
|
+
description: "Name of the workspace.",
|
|
44376
|
+
type: "string"
|
|
44377
|
+
}
|
|
44052
44378
|
},
|
|
44053
44379
|
type: "object"
|
|
44054
44380
|
}
|
|
@@ -44068,34 +44394,56 @@ var openapi_default = {
|
|
|
44068
44394
|
summary: "/workspaces/update",
|
|
44069
44395
|
tags: ["/workspaces"],
|
|
44070
44396
|
"x-fern-ignore": true,
|
|
44071
|
-
"x-response-key": null
|
|
44397
|
+
"x-response-key": null,
|
|
44398
|
+
"x-title": "Udpate a Workspace"
|
|
44072
44399
|
},
|
|
44073
44400
|
post: {
|
|
44401
|
+
description: "Updates the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.",
|
|
44074
44402
|
operationId: "workspacesUpdatePost",
|
|
44075
44403
|
requestBody: {
|
|
44076
44404
|
content: {
|
|
44077
44405
|
"application/json": {
|
|
44078
44406
|
schema: {
|
|
44079
44407
|
properties: {
|
|
44080
|
-
connect_partner_name: {
|
|
44408
|
+
connect_partner_name: {
|
|
44409
|
+
description: "Connect partner name for the workspace.",
|
|
44410
|
+
type: "string"
|
|
44411
|
+
},
|
|
44081
44412
|
connect_webview_customization: {
|
|
44413
|
+
description: "[Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
|
|
44082
44414
|
properties: {
|
|
44083
44415
|
logo_shape: {
|
|
44416
|
+
description: "Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
|
|
44084
44417
|
enum: ["circle", "square"],
|
|
44085
44418
|
nullable: true,
|
|
44086
44419
|
type: "string"
|
|
44087
44420
|
},
|
|
44088
|
-
primary_button_color: {
|
|
44421
|
+
primary_button_color: {
|
|
44422
|
+
description: "Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
|
|
44423
|
+
nullable: true,
|
|
44424
|
+
type: "string"
|
|
44425
|
+
},
|
|
44089
44426
|
primary_button_text_color: {
|
|
44427
|
+
description: "Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
|
|
44090
44428
|
nullable: true,
|
|
44091
44429
|
type: "string"
|
|
44092
44430
|
},
|
|
44093
|
-
success_message: {
|
|
44431
|
+
success_message: {
|
|
44432
|
+
description: "Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).",
|
|
44433
|
+
nullable: true,
|
|
44434
|
+
type: "string"
|
|
44435
|
+
}
|
|
44094
44436
|
},
|
|
44095
44437
|
type: "object"
|
|
44096
44438
|
},
|
|
44097
|
-
is_suspended: {
|
|
44098
|
-
|
|
44439
|
+
is_suspended: {
|
|
44440
|
+
description: "Indicates whether the workspace is suspended.",
|
|
44441
|
+
type: "boolean"
|
|
44442
|
+
},
|
|
44443
|
+
name: {
|
|
44444
|
+
description: "Name of the workspace.",
|
|
44445
|
+
type: "string"
|
|
44446
|
+
}
|
|
44099
44447
|
},
|
|
44100
44448
|
type: "object"
|
|
44101
44449
|
}
|
|
@@ -44116,7 +44464,8 @@ var openapi_default = {
|
|
|
44116
44464
|
tags: ["/workspaces"],
|
|
44117
44465
|
"x-fern-sdk-group-name": ["workspaces"],
|
|
44118
44466
|
"x-fern-sdk-method-name": "update",
|
|
44119
|
-
"x-response-key": null
|
|
44467
|
+
"x-response-key": null,
|
|
44468
|
+
"x-title": "Udpate a Workspace"
|
|
44120
44469
|
}
|
|
44121
44470
|
}
|
|
44122
44471
|
},
|