@seamapi/types 1.410.1 → 1.411.0
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 +680 -354
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +486 -177
- package/lib/seam/connect/internal/schemas.d.ts +1 -1
- package/lib/seam/connect/internal/schemas.js +1 -1
- package/lib/seam/connect/internal/schemas.js.map +1 -1
- package/lib/seam/connect/models/partner/magic-link.d.ts +4 -4
- package/lib/seam/connect/models/partner/magic-link.js +1 -0
- package/lib/seam/connect/models/partner/magic-link.js.map +1 -1
- package/lib/seam/connect/models/partner/resources.d.ts +17 -0
- package/lib/seam/connect/models/partner/resources.js +11 -0
- package/lib/seam/connect/models/partner/resources.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +284 -47
- package/lib/seam/connect/openapi.js +655 -330
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +198 -126
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/models/partner/magic-link.ts +1 -0
- package/src/lib/seam/connect/models/partner/resources.ts +15 -0
- package/src/lib/seam/connect/openapi.ts +786 -342
- package/src/lib/seam/connect/route-types.ts +211 -134
package/dist/connect.cjs
CHANGED
|
@@ -5087,7 +5087,8 @@ var pagination = zod.z.object({
|
|
|
5087
5087
|
var building_block_type = zod.z.enum([
|
|
5088
5088
|
"connect_accounts",
|
|
5089
5089
|
"manage_devices",
|
|
5090
|
-
"organize_spaces"
|
|
5090
|
+
"organize_spaces",
|
|
5091
|
+
"console"
|
|
5091
5092
|
]);
|
|
5092
5093
|
var magic_link = zod.z.object({
|
|
5093
5094
|
url: zod.z.string().url(),
|
|
@@ -19754,7 +19755,12 @@ var openapi_default = {
|
|
|
19754
19755
|
magic_link: {
|
|
19755
19756
|
properties: {
|
|
19756
19757
|
building_block_type: {
|
|
19757
|
-
enum: [
|
|
19758
|
+
enum: [
|
|
19759
|
+
"connect_accounts",
|
|
19760
|
+
"manage_devices",
|
|
19761
|
+
"organize_spaces",
|
|
19762
|
+
"console"
|
|
19763
|
+
],
|
|
19758
19764
|
type: "string"
|
|
19759
19765
|
},
|
|
19760
19766
|
created_at: { format: "date-time", type: "string" },
|
|
@@ -25446,6 +25452,7 @@ var openapi_default = {
|
|
|
25446
25452
|
},
|
|
25447
25453
|
security: [
|
|
25448
25454
|
{ client_session: [] },
|
|
25455
|
+
{ client_session_with_customer: [] },
|
|
25449
25456
|
{ pat_with_workspace: [] },
|
|
25450
25457
|
{ console_session_with_workspace: [] },
|
|
25451
25458
|
{ api_key: [] }
|
|
@@ -25578,6 +25585,7 @@ var openapi_default = {
|
|
|
25578
25585
|
},
|
|
25579
25586
|
security: [
|
|
25580
25587
|
{ client_session: [] },
|
|
25588
|
+
{ client_session_with_customer: [] },
|
|
25581
25589
|
{ pat_with_workspace: [] },
|
|
25582
25590
|
{ console_session_with_workspace: [] },
|
|
25583
25591
|
{ api_key: [] }
|
|
@@ -25711,6 +25719,7 @@ var openapi_default = {
|
|
|
25711
25719
|
},
|
|
25712
25720
|
security: [
|
|
25713
25721
|
{ client_session: [] },
|
|
25722
|
+
{ client_session_with_customer: [] },
|
|
25714
25723
|
{ pat_with_workspace: [] },
|
|
25715
25724
|
{ console_session_with_workspace: [] },
|
|
25716
25725
|
{ api_key: [] }
|
|
@@ -31920,6 +31929,7 @@ var openapi_default = {
|
|
|
31920
31929
|
},
|
|
31921
31930
|
security: [
|
|
31922
31931
|
{ client_session: [] },
|
|
31932
|
+
{ client_session_with_customer: [] },
|
|
31923
31933
|
{ api_key: [] },
|
|
31924
31934
|
{ pat_with_workspace: [] },
|
|
31925
31935
|
{ console_session_with_workspace: [] }
|
|
@@ -32672,7 +32682,8 @@ var openapi_default = {
|
|
|
32672
32682
|
security: [
|
|
32673
32683
|
{ api_key: [] },
|
|
32674
32684
|
{ pat_with_workspace: [] },
|
|
32675
|
-
{ console_session_with_workspace: [] }
|
|
32685
|
+
{ console_session_with_workspace: [] },
|
|
32686
|
+
{ client_session_with_customer: [] }
|
|
32676
32687
|
],
|
|
32677
32688
|
summary: "/devices/simulate/connect",
|
|
32678
32689
|
tags: ["/devices"],
|
|
@@ -32722,7 +32733,8 @@ var openapi_default = {
|
|
|
32722
32733
|
security: [
|
|
32723
32734
|
{ api_key: [] },
|
|
32724
32735
|
{ pat_with_workspace: [] },
|
|
32725
|
-
{ console_session_with_workspace: [] }
|
|
32736
|
+
{ console_session_with_workspace: [] },
|
|
32737
|
+
{ client_session_with_customer: [] }
|
|
32726
32738
|
],
|
|
32727
32739
|
summary: "/devices/simulate/disconnect",
|
|
32728
32740
|
tags: ["/devices"],
|
|
@@ -32772,7 +32784,8 @@ var openapi_default = {
|
|
|
32772
32784
|
security: [
|
|
32773
32785
|
{ api_key: [] },
|
|
32774
32786
|
{ pat_with_workspace: [] },
|
|
32775
|
-
{ console_session_with_workspace: [] }
|
|
32787
|
+
{ console_session_with_workspace: [] },
|
|
32788
|
+
{ client_session_with_customer: [] }
|
|
32776
32789
|
],
|
|
32777
32790
|
summary: "/devices/simulate/remove",
|
|
32778
32791
|
tags: ["/devices"],
|
|
@@ -33341,7 +33354,8 @@ var openapi_default = {
|
|
|
33341
33354
|
{ api_key: [] },
|
|
33342
33355
|
{ pat_with_workspace: [] },
|
|
33343
33356
|
{ console_session_with_workspace: [] },
|
|
33344
|
-
{ client_session: [] }
|
|
33357
|
+
{ client_session: [] },
|
|
33358
|
+
{ client_session_with_customer: [] }
|
|
33345
33359
|
],
|
|
33346
33360
|
summary: "/devices/update",
|
|
33347
33361
|
tags: ["/devices"],
|
|
@@ -33420,7 +33434,8 @@ var openapi_default = {
|
|
|
33420
33434
|
{ api_key: [] },
|
|
33421
33435
|
{ pat_with_workspace: [] },
|
|
33422
33436
|
{ console_session_with_workspace: [] },
|
|
33423
|
-
{ client_session: [] }
|
|
33437
|
+
{ client_session: [] },
|
|
33438
|
+
{ client_session_with_customer: [] }
|
|
33424
33439
|
],
|
|
33425
33440
|
summary: "/devices/update",
|
|
33426
33441
|
tags: ["/devices"],
|
|
@@ -33483,7 +33498,8 @@ var openapi_default = {
|
|
|
33483
33498
|
{ client_session: [] },
|
|
33484
33499
|
{ api_key: [] },
|
|
33485
33500
|
{ pat_with_workspace: [] },
|
|
33486
|
-
{ console_session_with_workspace: [] }
|
|
33501
|
+
{ console_session_with_workspace: [] },
|
|
33502
|
+
{ client_session_with_customer: [] }
|
|
33487
33503
|
],
|
|
33488
33504
|
summary: "/events/get",
|
|
33489
33505
|
tags: ["/events"],
|
|
@@ -35277,7 +35293,7 @@ var openapi_default = {
|
|
|
35277
35293
|
schema: {
|
|
35278
35294
|
properties: {
|
|
35279
35295
|
device_id: {
|
|
35280
|
-
description: "Device ID of the
|
|
35296
|
+
description: "Device ID of the phone that you want to deactivate.",
|
|
35281
35297
|
type: "string"
|
|
35282
35298
|
}
|
|
35283
35299
|
},
|
|
@@ -35319,7 +35335,7 @@ var openapi_default = {
|
|
|
35319
35335
|
},
|
|
35320
35336
|
"/phones/get": {
|
|
35321
35337
|
post: {
|
|
35322
|
-
description: "Returns a
|
|
35338
|
+
description: "Returns a specified [phone](https://docs.seam.co/latest/capability-guides/mobile-access/managing-phones-for-a-user-identity).",
|
|
35323
35339
|
operationId: "phonesGetPost",
|
|
35324
35340
|
requestBody: {
|
|
35325
35341
|
content: {
|
|
@@ -35327,7 +35343,7 @@ var openapi_default = {
|
|
|
35327
35343
|
schema: {
|
|
35328
35344
|
properties: {
|
|
35329
35345
|
device_id: {
|
|
35330
|
-
description: "Device ID of the
|
|
35346
|
+
description: "Device ID of the phone that you want to get.",
|
|
35331
35347
|
format: "uuid",
|
|
35332
35348
|
type: "string"
|
|
35333
35349
|
}
|
|
@@ -35368,12 +35384,12 @@ var openapi_default = {
|
|
|
35368
35384
|
"x-fern-sdk-method-name": "get",
|
|
35369
35385
|
"x-fern-sdk-return-value": "phone",
|
|
35370
35386
|
"x-response-key": "phone",
|
|
35371
|
-
"x-title": "Get Phone"
|
|
35387
|
+
"x-title": "Get a Phone"
|
|
35372
35388
|
}
|
|
35373
35389
|
},
|
|
35374
35390
|
"/phones/list": {
|
|
35375
35391
|
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.",
|
|
35392
|
+
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
35393
|
operationId: "phonesListPost",
|
|
35378
35394
|
requestBody: {
|
|
35379
35395
|
content: {
|
|
@@ -35381,12 +35397,12 @@ var openapi_default = {
|
|
|
35381
35397
|
schema: {
|
|
35382
35398
|
properties: {
|
|
35383
35399
|
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.",
|
|
35400
|
+
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
35401
|
format: "uuid",
|
|
35386
35402
|
type: "string"
|
|
35387
35403
|
},
|
|
35388
35404
|
owner_user_identity_id: {
|
|
35389
|
-
description: "ID of the user identity that represents the owner by which to filter the list of returned phones.",
|
|
35405
|
+
description: "ID of the user identity that represents the owner by which you want to filter the list of returned phones.",
|
|
35390
35406
|
format: "uuid",
|
|
35391
35407
|
type: "string"
|
|
35392
35408
|
}
|
|
@@ -35434,7 +35450,7 @@ var openapi_default = {
|
|
|
35434
35450
|
},
|
|
35435
35451
|
"/phones/simulate/create_sandbox_phone": {
|
|
35436
35452
|
post: {
|
|
35437
|
-
description: "Creates a new simulated phone in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).
|
|
35453
|
+
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
35454
|
operationId: "phonesSimulateCreateSandboxPhonePost",
|
|
35439
35455
|
requestBody: {
|
|
35440
35456
|
content: {
|
|
@@ -35443,7 +35459,7 @@ var openapi_default = {
|
|
|
35443
35459
|
properties: {
|
|
35444
35460
|
assa_abloy_metadata: {
|
|
35445
35461
|
default: {},
|
|
35446
|
-
description: "ASSA ABLOY metadata to associate with the simulated phone.",
|
|
35462
|
+
description: "ASSA ABLOY metadata that you want to associate with the simulated phone.",
|
|
35447
35463
|
properties: {
|
|
35448
35464
|
application_version: {
|
|
35449
35465
|
default: "1.0.0",
|
|
@@ -35480,12 +35496,12 @@ var openapi_default = {
|
|
|
35480
35496
|
type: "object"
|
|
35481
35497
|
},
|
|
35482
35498
|
custom_sdk_installation_id: {
|
|
35483
|
-
description: "ID of the custom SDK installation to use for the simulated phone.",
|
|
35499
|
+
description: "ID of the custom SDK installation that you want to use for the simulated phone.",
|
|
35484
35500
|
type: "string"
|
|
35485
35501
|
},
|
|
35486
35502
|
phone_metadata: {
|
|
35487
35503
|
default: {},
|
|
35488
|
-
description: "Metadata to associate with the simulated phone.",
|
|
35504
|
+
description: "Metadata that you want to associate with the simulated phone.",
|
|
35489
35505
|
properties: {
|
|
35490
35506
|
device_manufacturer: {
|
|
35491
35507
|
default: "Samsung",
|
|
@@ -35512,7 +35528,7 @@ var openapi_default = {
|
|
|
35512
35528
|
type: "object"
|
|
35513
35529
|
},
|
|
35514
35530
|
user_identity_id: {
|
|
35515
|
-
description: "ID of the user identity to associate with the simulated phone.",
|
|
35531
|
+
description: "ID of the user identity that you want to associate with the simulated phone.",
|
|
35516
35532
|
format: "uuid",
|
|
35517
35533
|
type: "string"
|
|
35518
35534
|
}
|
|
@@ -35558,16 +35574,25 @@ var openapi_default = {
|
|
|
35558
35574
|
},
|
|
35559
35575
|
"/seam/bridge/v1/bridge_client_sessions/create": {
|
|
35560
35576
|
post: {
|
|
35561
|
-
description: "Creates a new bridge client session.",
|
|
35577
|
+
description: "Creates a new [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.",
|
|
35562
35578
|
operationId: "seamBridgeV1BridgeClientSessionsCreatePost",
|
|
35563
35579
|
requestBody: {
|
|
35564
35580
|
content: {
|
|
35565
35581
|
"application/json": {
|
|
35566
35582
|
schema: {
|
|
35567
35583
|
properties: {
|
|
35568
|
-
bridge_client_machine_identifier_key: {
|
|
35569
|
-
|
|
35570
|
-
|
|
35584
|
+
bridge_client_machine_identifier_key: {
|
|
35585
|
+
description: "Identifier key of the client machine for the Seam Bridge client that you want to create.",
|
|
35586
|
+
type: "string"
|
|
35587
|
+
},
|
|
35588
|
+
bridge_client_name: {
|
|
35589
|
+
description: "Name of the Seam Bridge client that you want to create.",
|
|
35590
|
+
type: "string"
|
|
35591
|
+
},
|
|
35592
|
+
bridge_client_time_zone: {
|
|
35593
|
+
description: "Time zone for the Seam Bridge that you want to create.",
|
|
35594
|
+
type: "string"
|
|
35595
|
+
}
|
|
35571
35596
|
},
|
|
35572
35597
|
required: [
|
|
35573
35598
|
"bridge_client_name",
|
|
@@ -35743,12 +35768,12 @@ var openapi_default = {
|
|
|
35743
35768
|
"x-fern-sdk-return-value": "bridge_client_session",
|
|
35744
35769
|
"x-response-key": "bridge_client_session",
|
|
35745
35770
|
"x-title": "Create a Bridge Client Session",
|
|
35746
|
-
"x-undocumented": "Seam Bridge
|
|
35771
|
+
"x-undocumented": "Seam Bridge client only."
|
|
35747
35772
|
}
|
|
35748
35773
|
},
|
|
35749
35774
|
"/seam/bridge/v1/bridge_client_sessions/get": {
|
|
35750
35775
|
get: {
|
|
35751
|
-
description: "Returns the bridge client session associated with the session token used.",
|
|
35776
|
+
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
35777
|
operationId: "seamBridgeV1BridgeClientSessionsGetGet",
|
|
35753
35778
|
responses: {
|
|
35754
35779
|
200: {
|
|
@@ -35906,11 +35931,11 @@ var openapi_default = {
|
|
|
35906
35931
|
tags: [],
|
|
35907
35932
|
"x-fern-ignore": true,
|
|
35908
35933
|
"x-response-key": "bridge_client_session",
|
|
35909
|
-
"x-title": "Get a Bridge Client Session",
|
|
35934
|
+
"x-title": "Get a Seam Bridge Client Session",
|
|
35910
35935
|
"x-undocumented": "Seam Bridge Client only."
|
|
35911
35936
|
},
|
|
35912
35937
|
post: {
|
|
35913
|
-
description: "Returns the bridge client session associated with the session token used.",
|
|
35938
|
+
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
35939
|
operationId: "seamBridgeV1BridgeClientSessionsGetPost",
|
|
35915
35940
|
responses: {
|
|
35916
35941
|
200: {
|
|
@@ -36075,13 +36100,13 @@ var openapi_default = {
|
|
|
36075
36100
|
"x-fern-sdk-method-name": "get",
|
|
36076
36101
|
"x-fern-sdk-return-value": "bridge_client_session",
|
|
36077
36102
|
"x-response-key": "bridge_client_session",
|
|
36078
|
-
"x-title": "Get a Bridge Client Session",
|
|
36103
|
+
"x-title": "Get a Seam Bridge Client Session",
|
|
36079
36104
|
"x-undocumented": "Seam Bridge Client only."
|
|
36080
36105
|
}
|
|
36081
36106
|
},
|
|
36082
36107
|
"/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token": {
|
|
36083
36108
|
post: {
|
|
36084
|
-
description: "Returns the bridge client session associated with the session token and refreshed telemetry token.",
|
|
36109
|
+
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
36110
|
operationId: "seamBridgeV1BridgeClientSessionsRefreshTelemetryTokenPost",
|
|
36086
36111
|
responses: {
|
|
36087
36112
|
200: {
|
|
@@ -36246,13 +36271,13 @@ var openapi_default = {
|
|
|
36246
36271
|
"x-fern-sdk-method-name": "refresh_telemetry_token",
|
|
36247
36272
|
"x-fern-sdk-return-value": "bridge_client_session",
|
|
36248
36273
|
"x-response-key": "bridge_client_session",
|
|
36249
|
-
"x-title": "Refresh
|
|
36274
|
+
"x-title": "Refresh the Telemetry Token for a Seam Bridge Client Session",
|
|
36250
36275
|
"x-undocumented": "Seam Bridge Client only."
|
|
36251
36276
|
}
|
|
36252
36277
|
},
|
|
36253
36278
|
"/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code": {
|
|
36254
36279
|
post: {
|
|
36255
|
-
description: "Generate a new pairing code and return the updated bridge client session.",
|
|
36280
|
+
description: "Generate a new pairing code and return the updated [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.",
|
|
36256
36281
|
operationId: "seamBridgeV1BridgeClientSessionsRegeneratePairingCodePost",
|
|
36257
36282
|
responses: {
|
|
36258
36283
|
200: {
|
|
@@ -36417,21 +36442,29 @@ var openapi_default = {
|
|
|
36417
36442
|
"x-fern-sdk-method-name": "regenerate_pairing_code",
|
|
36418
36443
|
"x-fern-sdk-return-value": "bridge_client_session",
|
|
36419
36444
|
"x-response-key": "bridge_client_session",
|
|
36420
|
-
"x-title": "Regenerate a Bridge Client Session Pairing Code",
|
|
36445
|
+
"x-title": "Regenerate a Seam Bridge Client Session Pairing Code",
|
|
36421
36446
|
"x-undocumented": "Seam Bridge Client only."
|
|
36422
36447
|
}
|
|
36423
36448
|
},
|
|
36424
36449
|
"/seam/bridge/v1/bridge_client_sessions/report_status": {
|
|
36425
36450
|
post: {
|
|
36426
|
-
description: "Report a Seam Bridge
|
|
36451
|
+
description: "Report the status of a [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client.",
|
|
36427
36452
|
operationId: "seamBridgeV1BridgeClientSessionsReportStatusPost",
|
|
36428
36453
|
requestBody: {
|
|
36429
36454
|
content: {
|
|
36430
36455
|
"application/json": {
|
|
36431
36456
|
schema: {
|
|
36432
36457
|
properties: {
|
|
36433
|
-
is_tailscale_connected: {
|
|
36434
|
-
|
|
36458
|
+
is_tailscale_connected: {
|
|
36459
|
+
description: "Indicates whether Tailscale is connected.",
|
|
36460
|
+
nullable: true,
|
|
36461
|
+
type: "boolean"
|
|
36462
|
+
},
|
|
36463
|
+
tailscale_ip_v4: {
|
|
36464
|
+
description: "Tailscale IPv4 address.",
|
|
36465
|
+
nullable: true,
|
|
36466
|
+
type: "string"
|
|
36467
|
+
}
|
|
36435
36468
|
},
|
|
36436
36469
|
required: ["is_tailscale_connected", "tailscale_ip_v4"],
|
|
36437
36470
|
type: "object"
|
|
@@ -36466,13 +36499,13 @@ var openapi_default = {
|
|
|
36466
36499
|
],
|
|
36467
36500
|
"x-fern-sdk-method-name": "report_status",
|
|
36468
36501
|
"x-response-key": null,
|
|
36469
|
-
"x-title": "Report a Bridge Client
|
|
36502
|
+
"x-title": "Report the Status of a Seam Bridge Client",
|
|
36470
36503
|
"x-undocumented": "Seam Bridge Client only."
|
|
36471
36504
|
}
|
|
36472
36505
|
},
|
|
36473
36506
|
"/seam/bridge/v1/bridge_connected_systems/list": {
|
|
36474
36507
|
get: {
|
|
36475
|
-
description: "Returns the bridge
|
|
36508
|
+
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
36509
|
operationId: "seamBridgeV1BridgeConnectedSystemsListGet",
|
|
36477
36510
|
responses: {
|
|
36478
36511
|
200: {
|
|
@@ -36534,11 +36567,11 @@ var openapi_default = {
|
|
|
36534
36567
|
tags: [],
|
|
36535
36568
|
"x-fern-ignore": true,
|
|
36536
36569
|
"x-response-key": "bridge_connected_systems",
|
|
36537
|
-
"x-title": "List Bridge
|
|
36570
|
+
"x-title": "List Bridge-Connected Systems",
|
|
36538
36571
|
"x-undocumented": "Seam Bridge Client only."
|
|
36539
36572
|
},
|
|
36540
36573
|
post: {
|
|
36541
|
-
description: "Returns the bridge
|
|
36574
|
+
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
36575
|
operationId: "seamBridgeV1BridgeConnectedSystemsListPost",
|
|
36543
36576
|
responses: {
|
|
36544
36577
|
200: {
|
|
@@ -36607,13 +36640,13 @@ var openapi_default = {
|
|
|
36607
36640
|
"x-fern-sdk-method-name": "list",
|
|
36608
36641
|
"x-fern-sdk-return-value": "bridge_connected_systems",
|
|
36609
36642
|
"x-response-key": "bridge_connected_systems",
|
|
36610
|
-
"x-title": "List Bridge
|
|
36643
|
+
"x-title": "List Bridge-Connected Systems",
|
|
36611
36644
|
"x-undocumented": "Seam Bridge Client only."
|
|
36612
36645
|
}
|
|
36613
36646
|
},
|
|
36614
36647
|
"/seam/instant_key/v1/client_sessions/exchange_short_code": {
|
|
36615
36648
|
post: {
|
|
36616
|
-
description: "Exchanges a short code for a
|
|
36649
|
+
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
36650
|
operationId: "seamInstantKeyV1ClientSessionsExchangeShortCodePost",
|
|
36618
36651
|
requestBody: {
|
|
36619
36652
|
content: {
|
|
@@ -36621,7 +36654,7 @@ var openapi_default = {
|
|
|
36621
36654
|
schema: {
|
|
36622
36655
|
properties: {
|
|
36623
36656
|
short_code: {
|
|
36624
|
-
description: "
|
|
36657
|
+
description: "Short code that you want to exchange for a client session token.",
|
|
36625
36658
|
type: "string"
|
|
36626
36659
|
}
|
|
36627
36660
|
},
|
|
@@ -36670,7 +36703,7 @@ var openapi_default = {
|
|
|
36670
36703
|
},
|
|
36671
36704
|
"/seam/mobile_sdk/v1/acs/credentials/list": {
|
|
36672
36705
|
post: {
|
|
36673
|
-
description: "Returns a list of all
|
|
36706
|
+
description: "Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
36674
36707
|
operationId: "seamMobileSdkV1AcsCredentialsListPost",
|
|
36675
36708
|
requestBody: {
|
|
36676
36709
|
content: {
|
|
@@ -36718,15 +36751,19 @@ var openapi_default = {
|
|
|
36718
36751
|
},
|
|
36719
36752
|
"/seam/mobile_sdk/v1/phone_sessions/get_or_create": {
|
|
36720
36753
|
post: {
|
|
36721
|
-
description: "
|
|
36754
|
+
description: "Gets or creates a session for a mobile SDK phone.",
|
|
36722
36755
|
operationId: "seamMobileSdkV1PhoneSessionsGetOrCreatePost",
|
|
36723
36756
|
requestBody: {
|
|
36724
36757
|
content: {
|
|
36725
36758
|
"application/json": {
|
|
36726
36759
|
schema: {
|
|
36727
36760
|
properties: {
|
|
36728
|
-
custom_sdk_installation_id: {
|
|
36761
|
+
custom_sdk_installation_id: {
|
|
36762
|
+
description: "ID of the custom SDK installation that you want to use for the new session.",
|
|
36763
|
+
type: "string"
|
|
36764
|
+
},
|
|
36729
36765
|
phone_device_metadata: {
|
|
36766
|
+
description: "Phone device metadata that you want to use for the new session.",
|
|
36730
36767
|
properties: {
|
|
36731
36768
|
manufacturer: { type: "string" },
|
|
36732
36769
|
model: { type: "string" },
|
|
@@ -36734,7 +36771,11 @@ var openapi_default = {
|
|
|
36734
36771
|
},
|
|
36735
36772
|
type: "object"
|
|
36736
36773
|
},
|
|
36737
|
-
phone_os: {
|
|
36774
|
+
phone_os: {
|
|
36775
|
+
description: "Phone operating system that you want to use for the new session.",
|
|
36776
|
+
enum: ["ios", "android"],
|
|
36777
|
+
type: "string"
|
|
36778
|
+
}
|
|
36738
36779
|
},
|
|
36739
36780
|
required: ["custom_sdk_installation_id", "phone_os"],
|
|
36740
36781
|
type: "object"
|
|
@@ -36776,13 +36817,18 @@ var openapi_default = {
|
|
|
36776
36817
|
},
|
|
36777
36818
|
"/seam/partner/v1/building_blocks/spaces/auto_map": {
|
|
36778
36819
|
post: {
|
|
36779
|
-
description: "Auto
|
|
36820
|
+
description: "Auto-maps partner resources that have been pushed to Seam.",
|
|
36780
36821
|
operationId: "seamPartnerV1BuildingBlocksSpacesAutoMapPost",
|
|
36781
36822
|
requestBody: {
|
|
36782
36823
|
content: {
|
|
36783
36824
|
"application/json": {
|
|
36784
36825
|
schema: {
|
|
36785
|
-
properties: {
|
|
36826
|
+
properties: {
|
|
36827
|
+
collection_key: {
|
|
36828
|
+
description: "Collection key.",
|
|
36829
|
+
type: "string"
|
|
36830
|
+
}
|
|
36831
|
+
},
|
|
36786
36832
|
required: ["collection_key"],
|
|
36787
36833
|
type: "object"
|
|
36788
36834
|
}
|
|
@@ -36863,13 +36909,13 @@ var openapi_default = {
|
|
|
36863
36909
|
"x-fern-sdk-method-name": "auto_map",
|
|
36864
36910
|
"x-fern-sdk-return-value": "spaces",
|
|
36865
36911
|
"x-response-key": "spaces",
|
|
36866
|
-
"x-title": "Do
|
|
36912
|
+
"x-title": "Do Auto-Mapping for Partner Resources that Map to Spaces",
|
|
36867
36913
|
"x-undocumented": "Partner building blocks/UI only."
|
|
36868
36914
|
}
|
|
36869
36915
|
},
|
|
36870
36916
|
"/seam/partner/v1/resources/list": {
|
|
36871
36917
|
post: {
|
|
36872
|
-
description: "
|
|
36918
|
+
description: "Lists partner resources that have been pushed to Seam.",
|
|
36873
36919
|
operationId: "seamPartnerV1ResourcesListPost",
|
|
36874
36920
|
requestBody: {
|
|
36875
36921
|
content: {
|
|
@@ -36877,7 +36923,7 @@ var openapi_default = {
|
|
|
36877
36923
|
schema: {
|
|
36878
36924
|
properties: {
|
|
36879
36925
|
resource_type_alias: {
|
|
36880
|
-
description: "
|
|
36926
|
+
description: "Resource type alias by which you want to filter partner resources.",
|
|
36881
36927
|
type: "string"
|
|
36882
36928
|
}
|
|
36883
36929
|
},
|
|
@@ -36944,13 +36990,13 @@ var openapi_default = {
|
|
|
36944
36990
|
"x-fern-sdk-method-name": "list",
|
|
36945
36991
|
"x-fern-sdk-return-value": "partner_resources",
|
|
36946
36992
|
"x-response-key": "partner_resources",
|
|
36947
|
-
"x-title": "List
|
|
36993
|
+
"x-title": "List Partner Resources at Seam",
|
|
36948
36994
|
"x-undocumented": "Partner building blocks/UI only."
|
|
36949
36995
|
}
|
|
36950
36996
|
},
|
|
36951
36997
|
"/spaces/add_acs_entrances": {
|
|
36952
36998
|
post: {
|
|
36953
|
-
description: "
|
|
36999
|
+
description: "Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.",
|
|
36954
37000
|
operationId: "spacesAddAcsEntrancesPost",
|
|
36955
37001
|
requestBody: {
|
|
36956
37002
|
content: {
|
|
@@ -36958,11 +37004,16 @@ var openapi_default = {
|
|
|
36958
37004
|
schema: {
|
|
36959
37005
|
properties: {
|
|
36960
37006
|
acs_entrance_ids: {
|
|
37007
|
+
description: "IDs of the entrances that you want to add to the space.",
|
|
36961
37008
|
items: { format: "uuid", type: "string" },
|
|
36962
37009
|
minItems: 1,
|
|
36963
37010
|
type: "array"
|
|
36964
37011
|
},
|
|
36965
|
-
space_id: {
|
|
37012
|
+
space_id: {
|
|
37013
|
+
description: "ID of the space to which you want to add entrances.",
|
|
37014
|
+
format: "uuid",
|
|
37015
|
+
type: "string"
|
|
37016
|
+
}
|
|
36966
37017
|
},
|
|
36967
37018
|
required: ["space_id", "acs_entrance_ids"],
|
|
36968
37019
|
type: "object"
|
|
@@ -36997,10 +37048,10 @@ var openapi_default = {
|
|
|
36997
37048
|
"x-fern-sdk-group-name": ["spaces"],
|
|
36998
37049
|
"x-fern-sdk-method-name": "add_acs_entrances",
|
|
36999
37050
|
"x-response-key": null,
|
|
37000
|
-
"x-title": "Add
|
|
37051
|
+
"x-title": "Add Entrances to a Space"
|
|
37001
37052
|
},
|
|
37002
37053
|
put: {
|
|
37003
|
-
description: "
|
|
37054
|
+
description: "Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.",
|
|
37004
37055
|
operationId: "spacesAddAcsEntrancesPut",
|
|
37005
37056
|
requestBody: {
|
|
37006
37057
|
content: {
|
|
@@ -37008,11 +37059,16 @@ var openapi_default = {
|
|
|
37008
37059
|
schema: {
|
|
37009
37060
|
properties: {
|
|
37010
37061
|
acs_entrance_ids: {
|
|
37062
|
+
description: "IDs of the entrances that you want to add to the space.",
|
|
37011
37063
|
items: { format: "uuid", type: "string" },
|
|
37012
37064
|
minItems: 1,
|
|
37013
37065
|
type: "array"
|
|
37014
37066
|
},
|
|
37015
|
-
space_id: {
|
|
37067
|
+
space_id: {
|
|
37068
|
+
description: "ID of the space to which you want to add entrances.",
|
|
37069
|
+
format: "uuid",
|
|
37070
|
+
type: "string"
|
|
37071
|
+
}
|
|
37016
37072
|
},
|
|
37017
37073
|
required: ["space_id", "acs_entrance_ids"],
|
|
37018
37074
|
type: "object"
|
|
@@ -37046,12 +37102,12 @@ var openapi_default = {
|
|
|
37046
37102
|
"x-draft": "Early access.",
|
|
37047
37103
|
"x-fern-ignore": true,
|
|
37048
37104
|
"x-response-key": null,
|
|
37049
|
-
"x-title": "Add
|
|
37105
|
+
"x-title": "Add Entrances to a Space"
|
|
37050
37106
|
}
|
|
37051
37107
|
},
|
|
37052
37108
|
"/spaces/add_devices": {
|
|
37053
37109
|
post: {
|
|
37054
|
-
description: "
|
|
37110
|
+
description: "Adds devices to a specific space.",
|
|
37055
37111
|
operationId: "spacesAddDevicesPost",
|
|
37056
37112
|
requestBody: {
|
|
37057
37113
|
content: {
|
|
@@ -37059,11 +37115,16 @@ var openapi_default = {
|
|
|
37059
37115
|
schema: {
|
|
37060
37116
|
properties: {
|
|
37061
37117
|
device_ids: {
|
|
37118
|
+
description: "IDs of the devices that you want to add to the space.",
|
|
37062
37119
|
items: { format: "uuid", type: "string" },
|
|
37063
37120
|
minItems: 1,
|
|
37064
37121
|
type: "array"
|
|
37065
37122
|
},
|
|
37066
|
-
space_id: {
|
|
37123
|
+
space_id: {
|
|
37124
|
+
description: "ID of the space to which you want to add devices.",
|
|
37125
|
+
format: "uuid",
|
|
37126
|
+
type: "string"
|
|
37127
|
+
}
|
|
37067
37128
|
},
|
|
37068
37129
|
required: ["space_id", "device_ids"],
|
|
37069
37130
|
type: "object"
|
|
@@ -37098,10 +37159,10 @@ var openapi_default = {
|
|
|
37098
37159
|
"x-fern-sdk-group-name": ["spaces"],
|
|
37099
37160
|
"x-fern-sdk-method-name": "add_devices",
|
|
37100
37161
|
"x-response-key": null,
|
|
37101
|
-
"x-title": "Add Space
|
|
37162
|
+
"x-title": "Add Devices to a Space"
|
|
37102
37163
|
},
|
|
37103
37164
|
put: {
|
|
37104
|
-
description: "
|
|
37165
|
+
description: "Adds devices to a specific space.",
|
|
37105
37166
|
operationId: "spacesAddDevicesPut",
|
|
37106
37167
|
requestBody: {
|
|
37107
37168
|
content: {
|
|
@@ -37109,11 +37170,16 @@ var openapi_default = {
|
|
|
37109
37170
|
schema: {
|
|
37110
37171
|
properties: {
|
|
37111
37172
|
device_ids: {
|
|
37173
|
+
description: "IDs of the devices that you want to add to the space.",
|
|
37112
37174
|
items: { format: "uuid", type: "string" },
|
|
37113
37175
|
minItems: 1,
|
|
37114
37176
|
type: "array"
|
|
37115
37177
|
},
|
|
37116
|
-
space_id: {
|
|
37178
|
+
space_id: {
|
|
37179
|
+
description: "ID of the space to which you want to add devices.",
|
|
37180
|
+
format: "uuid",
|
|
37181
|
+
type: "string"
|
|
37182
|
+
}
|
|
37117
37183
|
},
|
|
37118
37184
|
required: ["space_id", "device_ids"],
|
|
37119
37185
|
type: "object"
|
|
@@ -37147,12 +37213,12 @@ var openapi_default = {
|
|
|
37147
37213
|
"x-draft": "Early access.",
|
|
37148
37214
|
"x-fern-ignore": true,
|
|
37149
37215
|
"x-response-key": null,
|
|
37150
|
-
"x-title": "Add Space
|
|
37216
|
+
"x-title": "Add Devices to a Space"
|
|
37151
37217
|
}
|
|
37152
37218
|
},
|
|
37153
37219
|
"/spaces/create": {
|
|
37154
37220
|
post: {
|
|
37155
|
-
description: "
|
|
37221
|
+
description: "Creates a new space.",
|
|
37156
37222
|
operationId: "spacesCreatePost",
|
|
37157
37223
|
requestBody: {
|
|
37158
37224
|
content: {
|
|
@@ -37160,14 +37226,19 @@ var openapi_default = {
|
|
|
37160
37226
|
schema: {
|
|
37161
37227
|
properties: {
|
|
37162
37228
|
acs_entrance_ids: {
|
|
37229
|
+
description: "IDs of the entrances that you want to add to the new space.",
|
|
37163
37230
|
items: { format: "uuid", type: "string" },
|
|
37164
37231
|
type: "array"
|
|
37165
37232
|
},
|
|
37166
37233
|
device_ids: {
|
|
37234
|
+
description: "IDs of the devices that you want to add to the new space.",
|
|
37167
37235
|
items: { format: "uuid", type: "string" },
|
|
37168
37236
|
type: "array"
|
|
37169
37237
|
},
|
|
37170
|
-
name: {
|
|
37238
|
+
name: {
|
|
37239
|
+
description: "Name of the space that you want to create.",
|
|
37240
|
+
type: "string"
|
|
37241
|
+
}
|
|
37171
37242
|
},
|
|
37172
37243
|
required: ["name"],
|
|
37173
37244
|
type: "object"
|
|
@@ -37206,18 +37277,24 @@ var openapi_default = {
|
|
|
37206
37277
|
"x-fern-sdk-method-name": "create",
|
|
37207
37278
|
"x-fern-sdk-return-value": "space",
|
|
37208
37279
|
"x-response-key": "space",
|
|
37209
|
-
"x-title": "Create Space"
|
|
37280
|
+
"x-title": "Create a Space"
|
|
37210
37281
|
}
|
|
37211
37282
|
},
|
|
37212
37283
|
"/spaces/delete": {
|
|
37213
37284
|
post: {
|
|
37214
|
-
description: "
|
|
37285
|
+
description: "Deletes a space.",
|
|
37215
37286
|
operationId: "spacesDeletePost",
|
|
37216
37287
|
requestBody: {
|
|
37217
37288
|
content: {
|
|
37218
37289
|
"application/json": {
|
|
37219
37290
|
schema: {
|
|
37220
|
-
properties: {
|
|
37291
|
+
properties: {
|
|
37292
|
+
space_id: {
|
|
37293
|
+
description: "ID of the space that you want to delete.",
|
|
37294
|
+
format: "uuid",
|
|
37295
|
+
type: "string"
|
|
37296
|
+
}
|
|
37297
|
+
},
|
|
37221
37298
|
required: ["space_id"],
|
|
37222
37299
|
type: "object"
|
|
37223
37300
|
}
|
|
@@ -37247,21 +37324,28 @@ var openapi_default = {
|
|
|
37247
37324
|
],
|
|
37248
37325
|
summary: "/spaces/delete",
|
|
37249
37326
|
tags: [],
|
|
37327
|
+
"x-draft": "Early access.",
|
|
37250
37328
|
"x-fern-sdk-group-name": ["spaces"],
|
|
37251
37329
|
"x-fern-sdk-method-name": "delete",
|
|
37252
37330
|
"x-response-key": null,
|
|
37253
|
-
"x-title": "Delete Space"
|
|
37331
|
+
"x-title": "Delete a Space"
|
|
37254
37332
|
}
|
|
37255
37333
|
},
|
|
37256
37334
|
"/spaces/get": {
|
|
37257
37335
|
post: {
|
|
37258
|
-
description: "
|
|
37336
|
+
description: "Gets a space.",
|
|
37259
37337
|
operationId: "spacesGetPost",
|
|
37260
37338
|
requestBody: {
|
|
37261
37339
|
content: {
|
|
37262
37340
|
"application/json": {
|
|
37263
37341
|
schema: {
|
|
37264
|
-
properties: {
|
|
37342
|
+
properties: {
|
|
37343
|
+
space_id: {
|
|
37344
|
+
description: "ID of the space that you want to get.",
|
|
37345
|
+
format: "uuid",
|
|
37346
|
+
type: "string"
|
|
37347
|
+
}
|
|
37348
|
+
},
|
|
37265
37349
|
required: ["space_id"],
|
|
37266
37350
|
type: "object"
|
|
37267
37351
|
}
|
|
@@ -37294,11 +37378,12 @@ var openapi_default = {
|
|
|
37294
37378
|
],
|
|
37295
37379
|
summary: "/spaces/get",
|
|
37296
37380
|
tags: [],
|
|
37381
|
+
"x-draft": "Early access.",
|
|
37297
37382
|
"x-fern-sdk-group-name": ["spaces"],
|
|
37298
37383
|
"x-fern-sdk-method-name": "get",
|
|
37299
37384
|
"x-fern-sdk-return-value": "space",
|
|
37300
37385
|
"x-response-key": "space",
|
|
37301
|
-
"x-title": "Get Space"
|
|
37386
|
+
"x-title": "Get a Space"
|
|
37302
37387
|
}
|
|
37303
37388
|
},
|
|
37304
37389
|
"/spaces/list": {
|
|
@@ -37381,7 +37466,7 @@ var openapi_default = {
|
|
|
37381
37466
|
},
|
|
37382
37467
|
"/spaces/remove_acs_entrances": {
|
|
37383
37468
|
post: {
|
|
37384
|
-
description: "
|
|
37469
|
+
description: "Removes [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) from a specific space.",
|
|
37385
37470
|
operationId: "spacesRemoveAcsEntrancesPost",
|
|
37386
37471
|
requestBody: {
|
|
37387
37472
|
content: {
|
|
@@ -37389,10 +37474,15 @@ var openapi_default = {
|
|
|
37389
37474
|
schema: {
|
|
37390
37475
|
properties: {
|
|
37391
37476
|
acs_entrance_ids: {
|
|
37477
|
+
description: "IDs of the entrances that you want to remove from the space.",
|
|
37392
37478
|
items: { format: "uuid", type: "string" },
|
|
37393
37479
|
type: "array"
|
|
37394
37480
|
},
|
|
37395
|
-
space_id: {
|
|
37481
|
+
space_id: {
|
|
37482
|
+
description: "ID of the space from which you want to remove entrances.",
|
|
37483
|
+
format: "uuid",
|
|
37484
|
+
type: "string"
|
|
37485
|
+
}
|
|
37396
37486
|
},
|
|
37397
37487
|
required: ["space_id", "acs_entrance_ids"],
|
|
37398
37488
|
type: "object"
|
|
@@ -37427,12 +37517,12 @@ var openapi_default = {
|
|
|
37427
37517
|
"x-fern-sdk-group-name": ["spaces"],
|
|
37428
37518
|
"x-fern-sdk-method-name": "remove_acs_entrances",
|
|
37429
37519
|
"x-response-key": null,
|
|
37430
|
-
"x-title": "Remove
|
|
37520
|
+
"x-title": "Remove Entrances from a Space"
|
|
37431
37521
|
}
|
|
37432
37522
|
},
|
|
37433
37523
|
"/spaces/remove_devices": {
|
|
37434
37524
|
post: {
|
|
37435
|
-
description: "
|
|
37525
|
+
description: "Removes devices from a specific space.",
|
|
37436
37526
|
operationId: "spacesRemoveDevicesPost",
|
|
37437
37527
|
requestBody: {
|
|
37438
37528
|
content: {
|
|
@@ -37440,10 +37530,15 @@ var openapi_default = {
|
|
|
37440
37530
|
schema: {
|
|
37441
37531
|
properties: {
|
|
37442
37532
|
device_ids: {
|
|
37533
|
+
description: "IDs of the devices that you want to remove from the space.",
|
|
37443
37534
|
items: { format: "uuid", type: "string" },
|
|
37444
37535
|
type: "array"
|
|
37445
37536
|
},
|
|
37446
|
-
space_id: {
|
|
37537
|
+
space_id: {
|
|
37538
|
+
description: "ID of the space from which you want to remove devices.",
|
|
37539
|
+
format: "uuid",
|
|
37540
|
+
type: "string"
|
|
37541
|
+
}
|
|
37447
37542
|
},
|
|
37448
37543
|
required: ["space_id", "device_ids"],
|
|
37449
37544
|
type: "object"
|
|
@@ -37478,20 +37573,24 @@ var openapi_default = {
|
|
|
37478
37573
|
"x-fern-sdk-group-name": ["spaces"],
|
|
37479
37574
|
"x-fern-sdk-method-name": "remove_devices",
|
|
37480
37575
|
"x-response-key": null,
|
|
37481
|
-
"x-title": "Remove Space
|
|
37576
|
+
"x-title": "Remove Devices from a Space"
|
|
37482
37577
|
}
|
|
37483
37578
|
},
|
|
37484
37579
|
"/spaces/update": {
|
|
37485
37580
|
patch: {
|
|
37486
|
-
description: "
|
|
37581
|
+
description: "Updates an existing space.",
|
|
37487
37582
|
operationId: "spacesUpdatePatch",
|
|
37488
37583
|
requestBody: {
|
|
37489
37584
|
content: {
|
|
37490
37585
|
"application/json": {
|
|
37491
37586
|
schema: {
|
|
37492
37587
|
properties: {
|
|
37493
|
-
name: { type: "string" },
|
|
37494
|
-
space_id: {
|
|
37588
|
+
name: { description: "Name of the space.", type: "string" },
|
|
37589
|
+
space_id: {
|
|
37590
|
+
description: "ID of the space that you want to update.",
|
|
37591
|
+
format: "uuid",
|
|
37592
|
+
type: "string"
|
|
37593
|
+
}
|
|
37495
37594
|
},
|
|
37496
37595
|
required: ["space_id"],
|
|
37497
37596
|
type: "object"
|
|
@@ -37528,18 +37627,22 @@ var openapi_default = {
|
|
|
37528
37627
|
"x-draft": "Early access.",
|
|
37529
37628
|
"x-fern-ignore": true,
|
|
37530
37629
|
"x-response-key": "space",
|
|
37531
|
-
"x-title": "Update Space"
|
|
37630
|
+
"x-title": "Update a Space"
|
|
37532
37631
|
},
|
|
37533
37632
|
post: {
|
|
37534
|
-
description: "
|
|
37633
|
+
description: "Updates an existing space.",
|
|
37535
37634
|
operationId: "spacesUpdatePost",
|
|
37536
37635
|
requestBody: {
|
|
37537
37636
|
content: {
|
|
37538
37637
|
"application/json": {
|
|
37539
37638
|
schema: {
|
|
37540
37639
|
properties: {
|
|
37541
|
-
name: { type: "string" },
|
|
37542
|
-
space_id: {
|
|
37640
|
+
name: { description: "Name of the space.", type: "string" },
|
|
37641
|
+
space_id: {
|
|
37642
|
+
description: "ID of the space that you want to update.",
|
|
37643
|
+
format: "uuid",
|
|
37644
|
+
type: "string"
|
|
37645
|
+
}
|
|
37543
37646
|
},
|
|
37544
37647
|
required: ["space_id"],
|
|
37545
37648
|
type: "object"
|
|
@@ -37578,7 +37681,7 @@ var openapi_default = {
|
|
|
37578
37681
|
"x-fern-sdk-method-name": "update",
|
|
37579
37682
|
"x-fern-sdk-return-value": "space",
|
|
37580
37683
|
"x-response-key": "space",
|
|
37581
|
-
"x-title": "Update Space"
|
|
37684
|
+
"x-title": "Update a Space"
|
|
37582
37685
|
}
|
|
37583
37686
|
},
|
|
37584
37687
|
"/thermostats/activate_climate_preset": {
|
|
@@ -37652,12 +37755,12 @@ var openapi_default = {
|
|
|
37652
37755
|
schema: {
|
|
37653
37756
|
properties: {
|
|
37654
37757
|
cooling_set_point_celsius: {
|
|
37655
|
-
description: "
|
|
37758
|
+
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
37759
|
format: "float",
|
|
37657
37760
|
type: "number"
|
|
37658
37761
|
},
|
|
37659
37762
|
cooling_set_point_fahrenheit: {
|
|
37660
|
-
description: "
|
|
37763
|
+
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
37764
|
format: "float",
|
|
37662
37765
|
type: "number"
|
|
37663
37766
|
},
|
|
@@ -37815,7 +37918,7 @@ var openapi_default = {
|
|
|
37815
37918
|
},
|
|
37816
37919
|
"/thermostats/daily_programs/create": {
|
|
37817
37920
|
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.",
|
|
37921
|
+
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
37922
|
operationId: "thermostatsDailyProgramsCreatePost",
|
|
37820
37923
|
requestBody: {
|
|
37821
37924
|
content: {
|
|
@@ -37828,7 +37931,7 @@ var openapi_default = {
|
|
|
37828
37931
|
type: "string"
|
|
37829
37932
|
},
|
|
37830
37933
|
name: {
|
|
37831
|
-
description: "
|
|
37934
|
+
description: "Name of the thermostat daily program.",
|
|
37832
37935
|
type: "string"
|
|
37833
37936
|
},
|
|
37834
37937
|
periods: {
|
|
@@ -38012,7 +38115,7 @@ var openapi_default = {
|
|
|
38012
38115
|
schema: {
|
|
38013
38116
|
properties: {
|
|
38014
38117
|
name: {
|
|
38015
|
-
description: "
|
|
38118
|
+
description: "Name of the thermostat daily program that you want to update.",
|
|
38016
38119
|
type: "string"
|
|
38017
38120
|
},
|
|
38018
38121
|
periods: {
|
|
@@ -38090,7 +38193,7 @@ var openapi_default = {
|
|
|
38090
38193
|
schema: {
|
|
38091
38194
|
properties: {
|
|
38092
38195
|
name: {
|
|
38093
|
-
description: "
|
|
38196
|
+
description: "Name of the thermostat daily program that you want to update.",
|
|
38094
38197
|
type: "string"
|
|
38095
38198
|
},
|
|
38096
38199
|
periods: {
|
|
@@ -38219,7 +38322,7 @@ var openapi_default = {
|
|
|
38219
38322
|
},
|
|
38220
38323
|
"/thermostats/get": {
|
|
38221
38324
|
post: {
|
|
38222
|
-
description: "Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
|
|
38325
|
+
description: "Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). **Deprecated:** Will be removed. Use `/devices/get` instead.",
|
|
38223
38326
|
operationId: "thermostatsGetPost",
|
|
38224
38327
|
requestBody: {
|
|
38225
38328
|
content: {
|
|
@@ -38227,12 +38330,12 @@ var openapi_default = {
|
|
|
38227
38330
|
schema: {
|
|
38228
38331
|
properties: {
|
|
38229
38332
|
device_id: {
|
|
38230
|
-
description: "ID of the thermostat device that you want to
|
|
38333
|
+
description: "ID of the thermostat device that you want to get.",
|
|
38231
38334
|
format: "uuid",
|
|
38232
38335
|
type: "string"
|
|
38233
38336
|
},
|
|
38234
38337
|
name: {
|
|
38235
|
-
description: "
|
|
38338
|
+
description: "Name of the thermostat device that you want to retrieve.",
|
|
38236
38339
|
type: "string"
|
|
38237
38340
|
}
|
|
38238
38341
|
},
|
|
@@ -38292,12 +38395,12 @@ var openapi_default = {
|
|
|
38292
38395
|
type: "string"
|
|
38293
38396
|
},
|
|
38294
38397
|
heating_set_point_celsius: {
|
|
38295
|
-
description: "
|
|
38398
|
+
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
38399
|
format: "float",
|
|
38297
38400
|
type: "number"
|
|
38298
38401
|
},
|
|
38299
38402
|
heating_set_point_fahrenheit: {
|
|
38300
|
-
description: "
|
|
38403
|
+
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
38404
|
format: "float",
|
|
38302
38405
|
type: "number"
|
|
38303
38406
|
},
|
|
@@ -38360,12 +38463,12 @@ var openapi_default = {
|
|
|
38360
38463
|
schema: {
|
|
38361
38464
|
properties: {
|
|
38362
38465
|
cooling_set_point_celsius: {
|
|
38363
|
-
description: "
|
|
38466
|
+
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
38467
|
format: "float",
|
|
38365
38468
|
type: "number"
|
|
38366
38469
|
},
|
|
38367
38470
|
cooling_set_point_fahrenheit: {
|
|
38368
|
-
description: "
|
|
38471
|
+
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
38472
|
format: "float",
|
|
38370
38473
|
type: "number"
|
|
38371
38474
|
},
|
|
@@ -38375,12 +38478,12 @@ var openapi_default = {
|
|
|
38375
38478
|
type: "string"
|
|
38376
38479
|
},
|
|
38377
38480
|
heating_set_point_celsius: {
|
|
38378
|
-
description: "
|
|
38481
|
+
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
38482
|
format: "float",
|
|
38380
38483
|
type: "number"
|
|
38381
38484
|
},
|
|
38382
38485
|
heating_set_point_fahrenheit: {
|
|
38383
|
-
description: "
|
|
38486
|
+
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
38487
|
format: "float",
|
|
38385
38488
|
type: "number"
|
|
38386
38489
|
},
|
|
@@ -38479,7 +38582,7 @@ var openapi_default = {
|
|
|
38479
38582
|
type: "array"
|
|
38480
38583
|
},
|
|
38481
38584
|
device_type: {
|
|
38482
|
-
description: "Device type by which to filter thermostat devices.",
|
|
38585
|
+
description: "Device type by which you want to filter thermostat devices.",
|
|
38483
38586
|
enum: [
|
|
38484
38587
|
"ecobee_thermostat",
|
|
38485
38588
|
"nest_thermostat",
|
|
@@ -38491,7 +38594,7 @@ var openapi_default = {
|
|
|
38491
38594
|
type: "string"
|
|
38492
38595
|
},
|
|
38493
38596
|
device_types: {
|
|
38494
|
-
description: "Array of device types by which to filter thermostat devices.",
|
|
38597
|
+
description: "Array of device types by which you want to filter thermostat devices.",
|
|
38495
38598
|
items: {
|
|
38496
38599
|
description: "Device type for thermostats.\n ",
|
|
38497
38600
|
enum: [
|
|
@@ -38553,7 +38656,7 @@ var openapi_default = {
|
|
|
38553
38656
|
type: "number"
|
|
38554
38657
|
},
|
|
38555
38658
|
manufacturer: {
|
|
38556
|
-
description: "Manufacturer by which to filter thermostat devices.",
|
|
38659
|
+
description: "Manufacturer by which you want to filter thermostat devices.",
|
|
38557
38660
|
enum: [
|
|
38558
38661
|
"ecobee",
|
|
38559
38662
|
"honeywell_resideo",
|
|
@@ -38697,7 +38800,7 @@ var openapi_default = {
|
|
|
38697
38800
|
},
|
|
38698
38801
|
"/thermostats/schedules/create": {
|
|
38699
38802
|
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).",
|
|
38803
|
+
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
38804
|
operationId: "thermostatsSchedulesCreatePost",
|
|
38702
38805
|
requestBody: {
|
|
38703
38806
|
content: {
|
|
@@ -38705,19 +38808,19 @@ var openapi_default = {
|
|
|
38705
38808
|
schema: {
|
|
38706
38809
|
properties: {
|
|
38707
38810
|
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.",
|
|
38811
|
+
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
38812
|
type: "string"
|
|
38710
38813
|
},
|
|
38711
38814
|
device_id: {
|
|
38712
|
-
description: "ID of the
|
|
38815
|
+
description: "ID of the thermostat device for which you want to create a schedule.",
|
|
38713
38816
|
type: "string"
|
|
38714
38817
|
},
|
|
38715
38818
|
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.",
|
|
38819
|
+
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
38820
|
type: "string"
|
|
38718
38821
|
},
|
|
38719
38822
|
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).",
|
|
38823
|
+
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
38824
|
type: "boolean"
|
|
38722
38825
|
},
|
|
38723
38826
|
max_override_period_minutes: {
|
|
@@ -38728,11 +38831,11 @@ var openapi_default = {
|
|
|
38728
38831
|
type: "integer"
|
|
38729
38832
|
},
|
|
38730
38833
|
name: {
|
|
38731
|
-
description: "
|
|
38834
|
+
description: "Name of the thermostat schedule.",
|
|
38732
38835
|
type: "string"
|
|
38733
38836
|
},
|
|
38734
38837
|
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.",
|
|
38838
|
+
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
38839
|
type: "string"
|
|
38737
38840
|
}
|
|
38738
38841
|
},
|
|
@@ -38793,7 +38896,7 @@ var openapi_default = {
|
|
|
38793
38896
|
schema: {
|
|
38794
38897
|
properties: {
|
|
38795
38898
|
thermostat_schedule_id: {
|
|
38796
|
-
description: "ID of the
|
|
38899
|
+
description: "ID of the thermostat schedule that you want to delete.",
|
|
38797
38900
|
format: "uuid",
|
|
38798
38901
|
type: "string"
|
|
38799
38902
|
}
|
|
@@ -38844,7 +38947,7 @@ var openapi_default = {
|
|
|
38844
38947
|
schema: {
|
|
38845
38948
|
properties: {
|
|
38846
38949
|
thermostat_schedule_id: {
|
|
38847
|
-
description: "ID of the
|
|
38950
|
+
description: "ID of the thermostat schedule that you want to get.",
|
|
38848
38951
|
format: "uuid",
|
|
38849
38952
|
type: "string"
|
|
38850
38953
|
}
|
|
@@ -38901,7 +39004,7 @@ var openapi_default = {
|
|
|
38901
39004
|
schema: {
|
|
38902
39005
|
properties: {
|
|
38903
39006
|
device_id: {
|
|
38904
|
-
description: "ID of the
|
|
39007
|
+
description: "ID of the thermostat device for which you want to list schedules.",
|
|
38905
39008
|
format: "uuid",
|
|
38906
39009
|
type: "string"
|
|
38907
39010
|
},
|
|
@@ -38984,7 +39087,7 @@ var openapi_default = {
|
|
|
38984
39087
|
type: "integer"
|
|
38985
39088
|
},
|
|
38986
39089
|
name: {
|
|
38987
|
-
description: "
|
|
39090
|
+
description: "Name of the thermostat schedule.",
|
|
38988
39091
|
type: "string"
|
|
38989
39092
|
},
|
|
38990
39093
|
starts_at: {
|
|
@@ -38992,7 +39095,7 @@ var openapi_default = {
|
|
|
38992
39095
|
type: "string"
|
|
38993
39096
|
},
|
|
38994
39097
|
thermostat_schedule_id: {
|
|
38995
|
-
description: "ID of the
|
|
39098
|
+
description: "ID of the thermostat schedule that you want to update.",
|
|
38996
39099
|
format: "uuid",
|
|
38997
39100
|
type: "string"
|
|
38998
39101
|
}
|
|
@@ -39059,7 +39162,7 @@ var openapi_default = {
|
|
|
39059
39162
|
type: "integer"
|
|
39060
39163
|
},
|
|
39061
39164
|
name: {
|
|
39062
|
-
description: "
|
|
39165
|
+
description: "Name of the thermostat schedule.",
|
|
39063
39166
|
type: "string"
|
|
39064
39167
|
},
|
|
39065
39168
|
starts_at: {
|
|
@@ -39067,7 +39170,7 @@ var openapi_default = {
|
|
|
39067
39170
|
type: "string"
|
|
39068
39171
|
},
|
|
39069
39172
|
thermostat_schedule_id: {
|
|
39070
|
-
description: "ID of the
|
|
39173
|
+
description: "ID of the thermostat schedule that you want to update.",
|
|
39071
39174
|
format: "uuid",
|
|
39072
39175
|
type: "string"
|
|
39073
39176
|
}
|
|
@@ -39183,7 +39286,7 @@ var openapi_default = {
|
|
|
39183
39286
|
"x-deprecated": "Use `fan_mode_setting` instead."
|
|
39184
39287
|
},
|
|
39185
39288
|
fan_mode_setting: {
|
|
39186
|
-
description: "
|
|
39289
|
+
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
39290
|
enum: ["auto", "on", "circulate"],
|
|
39188
39291
|
type: "string"
|
|
39189
39292
|
},
|
|
@@ -39261,12 +39364,12 @@ var openapi_default = {
|
|
|
39261
39364
|
{
|
|
39262
39365
|
properties: {
|
|
39263
39366
|
cooling_set_point_celsius: {
|
|
39264
|
-
description: "
|
|
39367
|
+
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
39368
|
format: "float",
|
|
39266
39369
|
type: "number"
|
|
39267
39370
|
},
|
|
39268
39371
|
cooling_set_point_fahrenheit: {
|
|
39269
|
-
description: "
|
|
39372
|
+
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
39373
|
format: "float",
|
|
39271
39374
|
type: "number"
|
|
39272
39375
|
},
|
|
@@ -39288,12 +39391,12 @@ var openapi_default = {
|
|
|
39288
39391
|
type: "string"
|
|
39289
39392
|
},
|
|
39290
39393
|
heating_set_point_celsius: {
|
|
39291
|
-
description: "
|
|
39394
|
+
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
39395
|
format: "float",
|
|
39293
39396
|
type: "number"
|
|
39294
39397
|
},
|
|
39295
39398
|
heating_set_point_fahrenheit: {
|
|
39296
|
-
description: "
|
|
39399
|
+
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
39400
|
format: "float",
|
|
39298
39401
|
type: "number"
|
|
39299
39402
|
},
|
|
@@ -39305,12 +39408,12 @@ var openapi_default = {
|
|
|
39305
39408
|
{
|
|
39306
39409
|
properties: {
|
|
39307
39410
|
cooling_set_point_celsius: {
|
|
39308
|
-
description: "
|
|
39411
|
+
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
39412
|
format: "float",
|
|
39310
39413
|
type: "number"
|
|
39311
39414
|
},
|
|
39312
39415
|
cooling_set_point_fahrenheit: {
|
|
39313
|
-
description: "
|
|
39416
|
+
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
39417
|
format: "float",
|
|
39315
39418
|
type: "number"
|
|
39316
39419
|
},
|
|
@@ -39320,12 +39423,12 @@ var openapi_default = {
|
|
|
39320
39423
|
type: "string"
|
|
39321
39424
|
},
|
|
39322
39425
|
heating_set_point_celsius: {
|
|
39323
|
-
description: "
|
|
39426
|
+
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
39427
|
format: "float",
|
|
39325
39428
|
type: "number"
|
|
39326
39429
|
},
|
|
39327
39430
|
heating_set_point_fahrenheit: {
|
|
39328
|
-
description: "
|
|
39431
|
+
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
39432
|
format: "float",
|
|
39330
39433
|
type: "number"
|
|
39331
39434
|
},
|
|
@@ -39545,12 +39648,12 @@ var openapi_default = {
|
|
|
39545
39648
|
{
|
|
39546
39649
|
properties: {
|
|
39547
39650
|
device_id: {
|
|
39548
|
-
description: "ID of the
|
|
39651
|
+
description: "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.",
|
|
39549
39652
|
format: "uuid",
|
|
39550
39653
|
type: "string"
|
|
39551
39654
|
},
|
|
39552
39655
|
hvac_mode: {
|
|
39553
|
-
description: "
|
|
39656
|
+
description: "HVAC mode that you want to simulate.",
|
|
39554
39657
|
enum: ["off"],
|
|
39555
39658
|
type: "string"
|
|
39556
39659
|
}
|
|
@@ -39561,22 +39664,22 @@ var openapi_default = {
|
|
|
39561
39664
|
{
|
|
39562
39665
|
properties: {
|
|
39563
39666
|
cooling_set_point_celsius: {
|
|
39564
|
-
description: "
|
|
39667
|
+
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
39668
|
format: "float",
|
|
39566
39669
|
type: "number"
|
|
39567
39670
|
},
|
|
39568
39671
|
cooling_set_point_fahrenheit: {
|
|
39569
|
-
description: "
|
|
39672
|
+
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
39673
|
format: "float",
|
|
39571
39674
|
type: "number"
|
|
39572
39675
|
},
|
|
39573
39676
|
device_id: {
|
|
39574
|
-
description: "ID of the
|
|
39677
|
+
description: "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.",
|
|
39575
39678
|
format: "uuid",
|
|
39576
39679
|
type: "string"
|
|
39577
39680
|
},
|
|
39578
39681
|
hvac_mode: {
|
|
39579
|
-
description: "
|
|
39682
|
+
description: "HVAC mode that you want to simulate.",
|
|
39580
39683
|
enum: ["cool"],
|
|
39581
39684
|
type: "string"
|
|
39582
39685
|
}
|
|
@@ -39587,22 +39690,22 @@ var openapi_default = {
|
|
|
39587
39690
|
{
|
|
39588
39691
|
properties: {
|
|
39589
39692
|
device_id: {
|
|
39590
|
-
description: "ID of the
|
|
39693
|
+
description: "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.",
|
|
39591
39694
|
format: "uuid",
|
|
39592
39695
|
type: "string"
|
|
39593
39696
|
},
|
|
39594
39697
|
heating_set_point_celsius: {
|
|
39595
|
-
description: "
|
|
39698
|
+
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
39699
|
format: "float",
|
|
39597
39700
|
type: "number"
|
|
39598
39701
|
},
|
|
39599
39702
|
heating_set_point_fahrenheit: {
|
|
39600
|
-
description: "
|
|
39703
|
+
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
39704
|
format: "float",
|
|
39602
39705
|
type: "number"
|
|
39603
39706
|
},
|
|
39604
39707
|
hvac_mode: {
|
|
39605
|
-
description: "
|
|
39708
|
+
description: "HVAC mode that you want to simulate.",
|
|
39606
39709
|
enum: ["heat"],
|
|
39607
39710
|
type: "string"
|
|
39608
39711
|
}
|
|
@@ -39613,32 +39716,32 @@ var openapi_default = {
|
|
|
39613
39716
|
{
|
|
39614
39717
|
properties: {
|
|
39615
39718
|
cooling_set_point_celsius: {
|
|
39616
|
-
description: "
|
|
39719
|
+
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
39720
|
format: "float",
|
|
39618
39721
|
type: "number"
|
|
39619
39722
|
},
|
|
39620
39723
|
cooling_set_point_fahrenheit: {
|
|
39621
|
-
description: "
|
|
39724
|
+
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
39725
|
format: "float",
|
|
39623
39726
|
type: "number"
|
|
39624
39727
|
},
|
|
39625
39728
|
device_id: {
|
|
39626
|
-
description: "ID of the
|
|
39729
|
+
description: "ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.",
|
|
39627
39730
|
format: "uuid",
|
|
39628
39731
|
type: "string"
|
|
39629
39732
|
},
|
|
39630
39733
|
heating_set_point_celsius: {
|
|
39631
|
-
description: "
|
|
39734
|
+
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
39735
|
format: "float",
|
|
39633
39736
|
type: "number"
|
|
39634
39737
|
},
|
|
39635
39738
|
heating_set_point_fahrenheit: {
|
|
39636
|
-
description: "
|
|
39739
|
+
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
39740
|
format: "float",
|
|
39638
39741
|
type: "number"
|
|
39639
39742
|
},
|
|
39640
39743
|
hvac_mode: {
|
|
39641
|
-
description: "
|
|
39744
|
+
description: "HVAC mode that you want to simulate.",
|
|
39642
39745
|
enum: ["heat_cool"],
|
|
39643
39746
|
type: "string"
|
|
39644
39747
|
}
|
|
@@ -39690,17 +39793,17 @@ var openapi_default = {
|
|
|
39690
39793
|
schema: {
|
|
39691
39794
|
properties: {
|
|
39692
39795
|
device_id: {
|
|
39693
|
-
description: "ID of the
|
|
39796
|
+
description: "ID of the thermostat device that you want to simulate reaching a specified temperature.",
|
|
39694
39797
|
format: "uuid",
|
|
39695
39798
|
type: "string"
|
|
39696
39799
|
},
|
|
39697
39800
|
temperature_celsius: {
|
|
39698
|
-
description: "
|
|
39801
|
+
description: "Temperature in \xB0C that you want simulate the thermostat reaching. You must set `temperature_celsius` or `temperature_fahrenheit`.",
|
|
39699
39802
|
format: "float",
|
|
39700
39803
|
type: "number"
|
|
39701
39804
|
},
|
|
39702
39805
|
temperature_fahrenheit: {
|
|
39703
|
-
description: "
|
|
39806
|
+
description: "Temperature in \xB0F that you want simulate the thermostat reaching. You must set `temperature_fahrenheit` or `temperature_celsius`.",
|
|
39704
39807
|
format: "float",
|
|
39705
39808
|
type: "number"
|
|
39706
39809
|
}
|
|
@@ -40045,7 +40148,7 @@ var openapi_default = {
|
|
|
40045
40148
|
{
|
|
40046
40149
|
properties: {
|
|
40047
40150
|
user_identity_id: {
|
|
40048
|
-
description: "ID of user identity for whom
|
|
40151
|
+
description: "ID of user identity for whom you want to grant access.",
|
|
40049
40152
|
format: "uuid",
|
|
40050
40153
|
type: "string"
|
|
40051
40154
|
}
|
|
@@ -40056,7 +40159,7 @@ var openapi_default = {
|
|
|
40056
40159
|
{
|
|
40057
40160
|
properties: {
|
|
40058
40161
|
user_identity: {
|
|
40059
|
-
description: "When used, creates a new user identity with the
|
|
40162
|
+
description: "User identity. When used, creates a new user identity with the specified details and grants them access.",
|
|
40060
40163
|
properties: {
|
|
40061
40164
|
email_address: {
|
|
40062
40165
|
description: "Unique email address for the user identity.",
|
|
@@ -40087,13 +40190,13 @@ var openapi_default = {
|
|
|
40087
40190
|
properties: {
|
|
40088
40191
|
acs_entrance_ids: {
|
|
40089
40192
|
default: [],
|
|
40090
|
-
description: "
|
|
40193
|
+
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
40194
|
items: { format: "uuid", type: "string" },
|
|
40092
40195
|
type: "array"
|
|
40093
40196
|
},
|
|
40094
40197
|
device_ids: {
|
|
40095
40198
|
default: [],
|
|
40096
|
-
description: "
|
|
40199
|
+
description: "IDs of the devices to which you want to grant access.",
|
|
40097
40200
|
items: { format: "uuid", type: "string" },
|
|
40098
40201
|
type: "array"
|
|
40099
40202
|
},
|
|
@@ -40103,7 +40206,7 @@ var openapi_default = {
|
|
|
40103
40206
|
type: "string"
|
|
40104
40207
|
},
|
|
40105
40208
|
location: {
|
|
40106
|
-
description: "When used, creates a new location with the
|
|
40209
|
+
description: "Location. When used, creates a new location with the specified entrances and devices, and gives the user access to this location.",
|
|
40107
40210
|
properties: {
|
|
40108
40211
|
acs_entrance_ids: {
|
|
40109
40212
|
default: [],
|
|
@@ -40136,7 +40239,7 @@ var openapi_default = {
|
|
|
40136
40239
|
items: {
|
|
40137
40240
|
properties: {
|
|
40138
40241
|
mode: {
|
|
40139
|
-
description: "Access method mode.
|
|
40242
|
+
description: "Access method mode.",
|
|
40140
40243
|
enum: ["code", "card", "mobile_key"],
|
|
40141
40244
|
type: "string"
|
|
40142
40245
|
}
|
|
@@ -40147,7 +40250,7 @@ var openapi_default = {
|
|
|
40147
40250
|
type: "array"
|
|
40148
40251
|
},
|
|
40149
40252
|
space_ids: {
|
|
40150
|
-
description: "
|
|
40253
|
+
description: "IDs of the existing spaces to which you want to grant access.",
|
|
40151
40254
|
items: { format: "uuid", type: "string" },
|
|
40152
40255
|
type: "array"
|
|
40153
40256
|
},
|
|
@@ -40293,7 +40396,7 @@ var openapi_default = {
|
|
|
40293
40396
|
},
|
|
40294
40397
|
"/unstable_access_grants/delete": {
|
|
40295
40398
|
post: {
|
|
40296
|
-
description: "
|
|
40399
|
+
description: "Deletes an access grant.",
|
|
40297
40400
|
operationId: "unstableAccessGrantsDeletePost",
|
|
40298
40401
|
requestBody: {
|
|
40299
40402
|
content: {
|
|
@@ -40301,7 +40404,7 @@ var openapi_default = {
|
|
|
40301
40404
|
schema: {
|
|
40302
40405
|
properties: {
|
|
40303
40406
|
access_grant_id: {
|
|
40304
|
-
description: "ID of access grant to delete.",
|
|
40407
|
+
description: "ID of access grant that you want to delete.",
|
|
40305
40408
|
format: "uuid",
|
|
40306
40409
|
type: "string"
|
|
40307
40410
|
}
|
|
@@ -40345,7 +40448,7 @@ var openapi_default = {
|
|
|
40345
40448
|
},
|
|
40346
40449
|
"/unstable_access_grants/get": {
|
|
40347
40450
|
post: {
|
|
40348
|
-
description: "
|
|
40451
|
+
description: "Gets an access grant.",
|
|
40349
40452
|
operationId: "unstableAccessGrantsGetPost",
|
|
40350
40453
|
requestBody: {
|
|
40351
40454
|
content: {
|
|
@@ -40353,7 +40456,7 @@ var openapi_default = {
|
|
|
40353
40456
|
schema: {
|
|
40354
40457
|
properties: {
|
|
40355
40458
|
access_grant_id: {
|
|
40356
|
-
description: "ID of access grant to get.",
|
|
40459
|
+
description: "ID of access grant that you want to get.",
|
|
40357
40460
|
format: "uuid",
|
|
40358
40461
|
type: "string"
|
|
40359
40462
|
}
|
|
@@ -40492,7 +40595,7 @@ var openapi_default = {
|
|
|
40492
40595
|
},
|
|
40493
40596
|
"/unstable_access_grants/list": {
|
|
40494
40597
|
post: {
|
|
40495
|
-
description: "
|
|
40598
|
+
description: "Returns a list of all access grants.",
|
|
40496
40599
|
operationId: "unstableAccessGrantsListPost",
|
|
40497
40600
|
requestBody: {
|
|
40498
40601
|
content: {
|
|
@@ -40500,12 +40603,12 @@ var openapi_default = {
|
|
|
40500
40603
|
schema: {
|
|
40501
40604
|
properties: {
|
|
40502
40605
|
acs_entrance_id: {
|
|
40503
|
-
description: "ID of entrance to filter list of access grants
|
|
40606
|
+
description: "ID of the entrance by which you want to filter the list of access grants.",
|
|
40504
40607
|
format: "uuid",
|
|
40505
40608
|
type: "string"
|
|
40506
40609
|
},
|
|
40507
40610
|
acs_system_id: {
|
|
40508
|
-
description: "ID of system to filter list of access grants
|
|
40611
|
+
description: "ID of the access system by which you want to filter the list of access grants.",
|
|
40509
40612
|
format: "uuid",
|
|
40510
40613
|
type: "string"
|
|
40511
40614
|
},
|
|
@@ -40516,12 +40619,12 @@ var openapi_default = {
|
|
|
40516
40619
|
"x-deprecated": "Use `space_id`."
|
|
40517
40620
|
},
|
|
40518
40621
|
space_id: {
|
|
40519
|
-
description: "ID of space to filter list of access grants
|
|
40622
|
+
description: "ID of the space by which you want to filter the list of access grants.",
|
|
40520
40623
|
format: "uuid",
|
|
40521
40624
|
type: "string"
|
|
40522
40625
|
},
|
|
40523
40626
|
user_identity_id: {
|
|
40524
|
-
description: "ID of user identity to filter list of access grants
|
|
40627
|
+
description: "ID of the user identity by which you want to filter the list of access grants.",
|
|
40525
40628
|
format: "uuid",
|
|
40526
40629
|
type: "string"
|
|
40527
40630
|
}
|
|
@@ -40662,7 +40765,7 @@ var openapi_default = {
|
|
|
40662
40765
|
},
|
|
40663
40766
|
"/unstable_access_methods/delete": {
|
|
40664
40767
|
post: {
|
|
40665
|
-
description: "
|
|
40768
|
+
description: "Deletes an access method.",
|
|
40666
40769
|
operationId: "unstableAccessMethodsDeletePost",
|
|
40667
40770
|
requestBody: {
|
|
40668
40771
|
content: {
|
|
@@ -40670,7 +40773,7 @@ var openapi_default = {
|
|
|
40670
40773
|
schema: {
|
|
40671
40774
|
properties: {
|
|
40672
40775
|
access_method_id: {
|
|
40673
|
-
description: "ID of access method to
|
|
40776
|
+
description: "ID of the access method that you want to delete.",
|
|
40674
40777
|
format: "uuid",
|
|
40675
40778
|
type: "string"
|
|
40676
40779
|
}
|
|
@@ -40713,7 +40816,7 @@ var openapi_default = {
|
|
|
40713
40816
|
},
|
|
40714
40817
|
"/unstable_access_methods/get": {
|
|
40715
40818
|
post: {
|
|
40716
|
-
description: "
|
|
40819
|
+
description: "Gets an access method.",
|
|
40717
40820
|
operationId: "unstableAccessMethodsGetPost",
|
|
40718
40821
|
requestBody: {
|
|
40719
40822
|
content: {
|
|
@@ -40721,7 +40824,7 @@ var openapi_default = {
|
|
|
40721
40824
|
schema: {
|
|
40722
40825
|
properties: {
|
|
40723
40826
|
access_method_id: {
|
|
40724
|
-
description: "ID of access method to get.",
|
|
40827
|
+
description: "ID of the access method that you want to get.",
|
|
40725
40828
|
format: "uuid",
|
|
40726
40829
|
type: "string"
|
|
40727
40830
|
}
|
|
@@ -40818,7 +40921,7 @@ var openapi_default = {
|
|
|
40818
40921
|
},
|
|
40819
40922
|
"/unstable_access_methods/list": {
|
|
40820
40923
|
post: {
|
|
40821
|
-
description: "
|
|
40924
|
+
description: "Lists all access methods, usually filtered by access grant.",
|
|
40822
40925
|
operationId: "unstableAccessMethodsListPost",
|
|
40823
40926
|
requestBody: {
|
|
40824
40927
|
content: {
|
|
@@ -40826,7 +40929,7 @@ var openapi_default = {
|
|
|
40826
40929
|
schema: {
|
|
40827
40930
|
properties: {
|
|
40828
40931
|
access_grant_id: {
|
|
40829
|
-
description: "ID of access grant to list access methods
|
|
40932
|
+
description: "ID of the access grant by which to filter the list of access methods.",
|
|
40830
40933
|
format: "uuid",
|
|
40831
40934
|
type: "string"
|
|
40832
40935
|
}
|
|
@@ -40926,7 +41029,7 @@ var openapi_default = {
|
|
|
40926
41029
|
},
|
|
40927
41030
|
"/unstable_locations/add_acs_entrances": {
|
|
40928
41031
|
post: {
|
|
40929
|
-
description: "
|
|
41032
|
+
description: "Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.",
|
|
40930
41033
|
operationId: "unstableLocationsAddAcsEntrancesPost",
|
|
40931
41034
|
requestBody: {
|
|
40932
41035
|
content: {
|
|
@@ -40934,11 +41037,16 @@ var openapi_default = {
|
|
|
40934
41037
|
schema: {
|
|
40935
41038
|
properties: {
|
|
40936
41039
|
acs_entrance_ids: {
|
|
41040
|
+
description: "IDs of the entrances that you want to add to the location.",
|
|
40937
41041
|
items: { format: "uuid", type: "string" },
|
|
40938
41042
|
minItems: 1,
|
|
40939
41043
|
type: "array"
|
|
40940
41044
|
},
|
|
40941
|
-
location_id: {
|
|
41045
|
+
location_id: {
|
|
41046
|
+
description: "ID of the location to which you want to add entrances.",
|
|
41047
|
+
format: "uuid",
|
|
41048
|
+
type: "string"
|
|
41049
|
+
}
|
|
40942
41050
|
},
|
|
40943
41051
|
required: ["location_id", "acs_entrance_ids"],
|
|
40944
41052
|
type: "object"
|
|
@@ -40972,11 +41080,11 @@ var openapi_default = {
|
|
|
40972
41080
|
"x-fern-sdk-group-name": ["unstable_locations"],
|
|
40973
41081
|
"x-fern-sdk-method-name": "add_acs_entrances",
|
|
40974
41082
|
"x-response-key": null,
|
|
40975
|
-
"x-title": "Add
|
|
41083
|
+
"x-title": "Add Entrances to a Location",
|
|
40976
41084
|
"x-undocumented": "Experimental locations."
|
|
40977
41085
|
},
|
|
40978
41086
|
put: {
|
|
40979
|
-
description: "
|
|
41087
|
+
description: "Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.",
|
|
40980
41088
|
operationId: "unstableLocationsAddAcsEntrancesPut",
|
|
40981
41089
|
requestBody: {
|
|
40982
41090
|
content: {
|
|
@@ -40984,11 +41092,16 @@ var openapi_default = {
|
|
|
40984
41092
|
schema: {
|
|
40985
41093
|
properties: {
|
|
40986
41094
|
acs_entrance_ids: {
|
|
41095
|
+
description: "IDs of the entrances that you want to add to the location.",
|
|
40987
41096
|
items: { format: "uuid", type: "string" },
|
|
40988
41097
|
minItems: 1,
|
|
40989
41098
|
type: "array"
|
|
40990
41099
|
},
|
|
40991
|
-
location_id: {
|
|
41100
|
+
location_id: {
|
|
41101
|
+
description: "ID of the location to which you want to add entrances.",
|
|
41102
|
+
format: "uuid",
|
|
41103
|
+
type: "string"
|
|
41104
|
+
}
|
|
40992
41105
|
},
|
|
40993
41106
|
required: ["location_id", "acs_entrance_ids"],
|
|
40994
41107
|
type: "object"
|
|
@@ -41021,13 +41134,13 @@ var openapi_default = {
|
|
|
41021
41134
|
tags: [],
|
|
41022
41135
|
"x-fern-ignore": true,
|
|
41023
41136
|
"x-response-key": null,
|
|
41024
|
-
"x-title": "Add
|
|
41137
|
+
"x-title": "Add Entrances to a Location",
|
|
41025
41138
|
"x-undocumented": "Experimental locations."
|
|
41026
41139
|
}
|
|
41027
41140
|
},
|
|
41028
41141
|
"/unstable_locations/add_devices": {
|
|
41029
41142
|
post: {
|
|
41030
|
-
description: "
|
|
41143
|
+
description: "Adds devices to a specific location.",
|
|
41031
41144
|
operationId: "unstableLocationsAddDevicesPost",
|
|
41032
41145
|
requestBody: {
|
|
41033
41146
|
content: {
|
|
@@ -41035,11 +41148,16 @@ var openapi_default = {
|
|
|
41035
41148
|
schema: {
|
|
41036
41149
|
properties: {
|
|
41037
41150
|
device_ids: {
|
|
41151
|
+
description: "IDs of the devices that you want to add to the location.",
|
|
41038
41152
|
items: { format: "uuid", type: "string" },
|
|
41039
41153
|
minItems: 1,
|
|
41040
41154
|
type: "array"
|
|
41041
41155
|
},
|
|
41042
|
-
location_id: {
|
|
41156
|
+
location_id: {
|
|
41157
|
+
description: "ID of the location to which you want to add devices.",
|
|
41158
|
+
format: "uuid",
|
|
41159
|
+
type: "string"
|
|
41160
|
+
}
|
|
41043
41161
|
},
|
|
41044
41162
|
required: ["location_id", "device_ids"],
|
|
41045
41163
|
type: "object"
|
|
@@ -41073,11 +41191,11 @@ var openapi_default = {
|
|
|
41073
41191
|
"x-fern-sdk-group-name": ["unstable_locations"],
|
|
41074
41192
|
"x-fern-sdk-method-name": "add_devices",
|
|
41075
41193
|
"x-response-key": null,
|
|
41076
|
-
"x-title": "Add Location
|
|
41194
|
+
"x-title": "Add Devices to a Location",
|
|
41077
41195
|
"x-undocumented": "Experimental locations."
|
|
41078
41196
|
},
|
|
41079
41197
|
put: {
|
|
41080
|
-
description: "
|
|
41198
|
+
description: "Adds devices to a specific location.",
|
|
41081
41199
|
operationId: "unstableLocationsAddDevicesPut",
|
|
41082
41200
|
requestBody: {
|
|
41083
41201
|
content: {
|
|
@@ -41085,11 +41203,16 @@ var openapi_default = {
|
|
|
41085
41203
|
schema: {
|
|
41086
41204
|
properties: {
|
|
41087
41205
|
device_ids: {
|
|
41206
|
+
description: "IDs of the devices that you want to add to the location.",
|
|
41088
41207
|
items: { format: "uuid", type: "string" },
|
|
41089
41208
|
minItems: 1,
|
|
41090
41209
|
type: "array"
|
|
41091
41210
|
},
|
|
41092
|
-
location_id: {
|
|
41211
|
+
location_id: {
|
|
41212
|
+
description: "ID of the location to which you want to add devices.",
|
|
41213
|
+
format: "uuid",
|
|
41214
|
+
type: "string"
|
|
41215
|
+
}
|
|
41093
41216
|
},
|
|
41094
41217
|
required: ["location_id", "device_ids"],
|
|
41095
41218
|
type: "object"
|
|
@@ -41122,13 +41245,13 @@ var openapi_default = {
|
|
|
41122
41245
|
tags: [],
|
|
41123
41246
|
"x-fern-ignore": true,
|
|
41124
41247
|
"x-response-key": null,
|
|
41125
|
-
"x-title": "Add Location
|
|
41248
|
+
"x-title": "Add Devices to a Location",
|
|
41126
41249
|
"x-undocumented": "Experimental locations."
|
|
41127
41250
|
}
|
|
41128
41251
|
},
|
|
41129
41252
|
"/unstable_locations/create": {
|
|
41130
41253
|
post: {
|
|
41131
|
-
description: "
|
|
41254
|
+
description: "Creates a new location.",
|
|
41132
41255
|
operationId: "unstableLocationsCreatePost",
|
|
41133
41256
|
requestBody: {
|
|
41134
41257
|
content: {
|
|
@@ -41136,14 +41259,17 @@ var openapi_default = {
|
|
|
41136
41259
|
schema: {
|
|
41137
41260
|
properties: {
|
|
41138
41261
|
acs_entrance_ids: {
|
|
41262
|
+
description: "IDs of the entrances that you want to add to the new location.",
|
|
41139
41263
|
items: { format: "uuid", type: "string" },
|
|
41140
41264
|
type: "array"
|
|
41141
41265
|
},
|
|
41142
41266
|
device_ids: {
|
|
41267
|
+
description: "IDs of the devices that you want to add to the new location.",
|
|
41143
41268
|
items: { format: "uuid", type: "string" },
|
|
41144
41269
|
type: "array"
|
|
41145
41270
|
},
|
|
41146
41271
|
geolocation: {
|
|
41272
|
+
description: "Geolocation of the new location.",
|
|
41147
41273
|
properties: {
|
|
41148
41274
|
latitude: { format: "float", type: "number" },
|
|
41149
41275
|
longitude: { format: "float", type: "number" }
|
|
@@ -41151,8 +41277,14 @@ var openapi_default = {
|
|
|
41151
41277
|
required: ["latitude", "longitude"],
|
|
41152
41278
|
type: "object"
|
|
41153
41279
|
},
|
|
41154
|
-
name: {
|
|
41155
|
-
|
|
41280
|
+
name: {
|
|
41281
|
+
description: "Name of the new location.",
|
|
41282
|
+
type: "string"
|
|
41283
|
+
},
|
|
41284
|
+
time_zone: {
|
|
41285
|
+
description: "Time zone of the new location.",
|
|
41286
|
+
type: "string"
|
|
41287
|
+
}
|
|
41156
41288
|
},
|
|
41157
41289
|
required: ["name"],
|
|
41158
41290
|
type: "object"
|
|
@@ -41237,19 +41369,25 @@ var openapi_default = {
|
|
|
41237
41369
|
"x-fern-sdk-method-name": "create",
|
|
41238
41370
|
"x-fern-sdk-return-value": "location",
|
|
41239
41371
|
"x-response-key": "location",
|
|
41240
|
-
"x-title": "Create Location",
|
|
41372
|
+
"x-title": "Create a Location",
|
|
41241
41373
|
"x-undocumented": "Experimental locations."
|
|
41242
41374
|
}
|
|
41243
41375
|
},
|
|
41244
41376
|
"/unstable_locations/delete": {
|
|
41245
41377
|
post: {
|
|
41246
|
-
description: "
|
|
41378
|
+
description: "Deletes a location.",
|
|
41247
41379
|
operationId: "unstableLocationsDeletePost",
|
|
41248
41380
|
requestBody: {
|
|
41249
41381
|
content: {
|
|
41250
41382
|
"application/json": {
|
|
41251
41383
|
schema: {
|
|
41252
|
-
properties: {
|
|
41384
|
+
properties: {
|
|
41385
|
+
location_id: {
|
|
41386
|
+
description: "ID of the location that you want to delete.",
|
|
41387
|
+
format: "uuid",
|
|
41388
|
+
type: "string"
|
|
41389
|
+
}
|
|
41390
|
+
},
|
|
41253
41391
|
required: ["location_id"],
|
|
41254
41392
|
type: "object"
|
|
41255
41393
|
}
|
|
@@ -41282,19 +41420,25 @@ var openapi_default = {
|
|
|
41282
41420
|
"x-fern-sdk-group-name": ["unstable_locations"],
|
|
41283
41421
|
"x-fern-sdk-method-name": "delete",
|
|
41284
41422
|
"x-response-key": null,
|
|
41285
|
-
"x-title": "Delete Location",
|
|
41423
|
+
"x-title": "Delete a Location",
|
|
41286
41424
|
"x-undocumented": "Experimental locations."
|
|
41287
41425
|
}
|
|
41288
41426
|
},
|
|
41289
41427
|
"/unstable_locations/get": {
|
|
41290
41428
|
post: {
|
|
41291
|
-
description: "
|
|
41429
|
+
description: "Gets a location.",
|
|
41292
41430
|
operationId: "unstableLocationsGetPost",
|
|
41293
41431
|
requestBody: {
|
|
41294
41432
|
content: {
|
|
41295
41433
|
"application/json": {
|
|
41296
41434
|
schema: {
|
|
41297
|
-
properties: {
|
|
41435
|
+
properties: {
|
|
41436
|
+
location_id: {
|
|
41437
|
+
description: "ID of the location that you want to get.",
|
|
41438
|
+
format: "uuid",
|
|
41439
|
+
type: "string"
|
|
41440
|
+
}
|
|
41441
|
+
},
|
|
41298
41442
|
required: ["location_id"],
|
|
41299
41443
|
type: "object"
|
|
41300
41444
|
}
|
|
@@ -41378,7 +41522,7 @@ var openapi_default = {
|
|
|
41378
41522
|
"x-fern-sdk-method-name": "get",
|
|
41379
41523
|
"x-fern-sdk-return-value": "location",
|
|
41380
41524
|
"x-response-key": "location",
|
|
41381
|
-
"x-title": "Get Location",
|
|
41525
|
+
"x-title": "Get a Location",
|
|
41382
41526
|
"x-undocumented": "Experimental locations."
|
|
41383
41527
|
}
|
|
41384
41528
|
},
|
|
@@ -41556,7 +41700,7 @@ var openapi_default = {
|
|
|
41556
41700
|
},
|
|
41557
41701
|
"/unstable_locations/remove_acs_entrances": {
|
|
41558
41702
|
post: {
|
|
41559
|
-
description: "
|
|
41703
|
+
description: "Removes entrances from a specific location.",
|
|
41560
41704
|
operationId: "unstableLocationsRemoveAcsEntrancesPost",
|
|
41561
41705
|
requestBody: {
|
|
41562
41706
|
content: {
|
|
@@ -41564,10 +41708,15 @@ var openapi_default = {
|
|
|
41564
41708
|
schema: {
|
|
41565
41709
|
properties: {
|
|
41566
41710
|
acs_entrance_ids: {
|
|
41711
|
+
description: "IDs of the entrances that you want to remove from the location.",
|
|
41567
41712
|
items: { format: "uuid", type: "string" },
|
|
41568
41713
|
type: "array"
|
|
41569
41714
|
},
|
|
41570
|
-
location_id: {
|
|
41715
|
+
location_id: {
|
|
41716
|
+
description: "ID of the location from which you want to remove entrances.",
|
|
41717
|
+
format: "uuid",
|
|
41718
|
+
type: "string"
|
|
41719
|
+
}
|
|
41571
41720
|
},
|
|
41572
41721
|
required: ["location_id", "acs_entrance_ids"],
|
|
41573
41722
|
type: "object"
|
|
@@ -41601,13 +41750,13 @@ var openapi_default = {
|
|
|
41601
41750
|
"x-fern-sdk-group-name": ["unstable_locations"],
|
|
41602
41751
|
"x-fern-sdk-method-name": "remove_acs_entrances",
|
|
41603
41752
|
"x-response-key": null,
|
|
41604
|
-
"x-title": "Remove
|
|
41753
|
+
"x-title": "Remove Entrances from a Location",
|
|
41605
41754
|
"x-undocumented": "Experimental locations."
|
|
41606
41755
|
}
|
|
41607
41756
|
},
|
|
41608
41757
|
"/unstable_locations/remove_devices": {
|
|
41609
41758
|
post: {
|
|
41610
|
-
description: "
|
|
41759
|
+
description: "Removes devices from a specific location.",
|
|
41611
41760
|
operationId: "unstableLocationsRemoveDevicesPost",
|
|
41612
41761
|
requestBody: {
|
|
41613
41762
|
content: {
|
|
@@ -41615,10 +41764,15 @@ var openapi_default = {
|
|
|
41615
41764
|
schema: {
|
|
41616
41765
|
properties: {
|
|
41617
41766
|
device_ids: {
|
|
41767
|
+
description: "IDs of the devices that you want to remove from the location.",
|
|
41618
41768
|
items: { format: "uuid", type: "string" },
|
|
41619
41769
|
type: "array"
|
|
41620
41770
|
},
|
|
41621
|
-
location_id: {
|
|
41771
|
+
location_id: {
|
|
41772
|
+
description: "ID of the location from which you want to remove devices.",
|
|
41773
|
+
format: "uuid",
|
|
41774
|
+
type: "string"
|
|
41775
|
+
}
|
|
41622
41776
|
},
|
|
41623
41777
|
required: ["location_id", "device_ids"],
|
|
41624
41778
|
type: "object"
|
|
@@ -41652,13 +41806,13 @@ var openapi_default = {
|
|
|
41652
41806
|
"x-fern-sdk-group-name": ["unstable_locations"],
|
|
41653
41807
|
"x-fern-sdk-method-name": "remove_devices",
|
|
41654
41808
|
"x-response-key": null,
|
|
41655
|
-
"x-title": "Remove Location
|
|
41809
|
+
"x-title": "Remove Devices from a Location",
|
|
41656
41810
|
"x-undocumented": "Experimental locations."
|
|
41657
41811
|
}
|
|
41658
41812
|
},
|
|
41659
41813
|
"/unstable_locations/update": {
|
|
41660
41814
|
patch: {
|
|
41661
|
-
description: "
|
|
41815
|
+
description: "Updates a location.",
|
|
41662
41816
|
operationId: "unstableLocationsUpdatePatch",
|
|
41663
41817
|
requestBody: {
|
|
41664
41818
|
content: {
|
|
@@ -41666,6 +41820,7 @@ var openapi_default = {
|
|
|
41666
41820
|
schema: {
|
|
41667
41821
|
properties: {
|
|
41668
41822
|
geolocation: {
|
|
41823
|
+
description: "Geolocation of the location.",
|
|
41669
41824
|
properties: {
|
|
41670
41825
|
latitude: { format: "float", type: "number" },
|
|
41671
41826
|
longitude: { format: "float", type: "number" }
|
|
@@ -41673,9 +41828,19 @@ var openapi_default = {
|
|
|
41673
41828
|
required: ["latitude", "longitude"],
|
|
41674
41829
|
type: "object"
|
|
41675
41830
|
},
|
|
41676
|
-
location_id: {
|
|
41677
|
-
|
|
41678
|
-
|
|
41831
|
+
location_id: {
|
|
41832
|
+
description: "ID of the location that you want to update.",
|
|
41833
|
+
format: "uuid",
|
|
41834
|
+
type: "string"
|
|
41835
|
+
},
|
|
41836
|
+
name: {
|
|
41837
|
+
description: "Name of the location.",
|
|
41838
|
+
type: "string"
|
|
41839
|
+
},
|
|
41840
|
+
time_zone: {
|
|
41841
|
+
description: "Time zone of the the location.",
|
|
41842
|
+
type: "string"
|
|
41843
|
+
}
|
|
41679
41844
|
},
|
|
41680
41845
|
required: ["location_id"],
|
|
41681
41846
|
type: "object"
|
|
@@ -41758,11 +41923,11 @@ var openapi_default = {
|
|
|
41758
41923
|
tags: [],
|
|
41759
41924
|
"x-fern-ignore": true,
|
|
41760
41925
|
"x-response-key": "location",
|
|
41761
|
-
"x-title": "Update Location",
|
|
41926
|
+
"x-title": "Update a Location",
|
|
41762
41927
|
"x-undocumented": "Experimental locations."
|
|
41763
41928
|
},
|
|
41764
41929
|
post: {
|
|
41765
|
-
description: "
|
|
41930
|
+
description: "Updates a location.",
|
|
41766
41931
|
operationId: "unstableLocationsUpdatePost",
|
|
41767
41932
|
requestBody: {
|
|
41768
41933
|
content: {
|
|
@@ -41770,6 +41935,7 @@ var openapi_default = {
|
|
|
41770
41935
|
schema: {
|
|
41771
41936
|
properties: {
|
|
41772
41937
|
geolocation: {
|
|
41938
|
+
description: "Geolocation of the location.",
|
|
41773
41939
|
properties: {
|
|
41774
41940
|
latitude: { format: "float", type: "number" },
|
|
41775
41941
|
longitude: { format: "float", type: "number" }
|
|
@@ -41777,9 +41943,19 @@ var openapi_default = {
|
|
|
41777
41943
|
required: ["latitude", "longitude"],
|
|
41778
41944
|
type: "object"
|
|
41779
41945
|
},
|
|
41780
|
-
location_id: {
|
|
41781
|
-
|
|
41782
|
-
|
|
41946
|
+
location_id: {
|
|
41947
|
+
description: "ID of the location that you want to update.",
|
|
41948
|
+
format: "uuid",
|
|
41949
|
+
type: "string"
|
|
41950
|
+
},
|
|
41951
|
+
name: {
|
|
41952
|
+
description: "Name of the location.",
|
|
41953
|
+
type: "string"
|
|
41954
|
+
},
|
|
41955
|
+
time_zone: {
|
|
41956
|
+
description: "Time zone of the the location.",
|
|
41957
|
+
type: "string"
|
|
41958
|
+
}
|
|
41783
41959
|
},
|
|
41784
41960
|
required: ["location_id"],
|
|
41785
41961
|
type: "object"
|
|
@@ -41864,7 +42040,7 @@ var openapi_default = {
|
|
|
41864
42040
|
"x-fern-sdk-method-name": "update",
|
|
41865
42041
|
"x-fern-sdk-return-value": "location",
|
|
41866
42042
|
"x-response-key": "location",
|
|
41867
|
-
"x-title": "Update Location",
|
|
42043
|
+
"x-title": "Update a Location",
|
|
41868
42044
|
"x-undocumented": "Experimental locations."
|
|
41869
42045
|
}
|
|
41870
42046
|
},
|
|
@@ -41876,7 +42052,12 @@ var openapi_default = {
|
|
|
41876
42052
|
content: {
|
|
41877
42053
|
"application/json": {
|
|
41878
42054
|
schema: {
|
|
41879
|
-
properties: {
|
|
42055
|
+
properties: {
|
|
42056
|
+
customer_key: {
|
|
42057
|
+
description: "Customer key for which you want to connect accounts.",
|
|
42058
|
+
type: "string"
|
|
42059
|
+
}
|
|
42060
|
+
},
|
|
41880
42061
|
required: ["customer_key"],
|
|
41881
42062
|
type: "object"
|
|
41882
42063
|
}
|
|
@@ -41913,7 +42094,7 @@ var openapi_default = {
|
|
|
41913
42094
|
"x-fern-sdk-method-name": "connect_accounts",
|
|
41914
42095
|
"x-fern-sdk-return-value": "magic_link",
|
|
41915
42096
|
"x-response-key": "magic_link",
|
|
41916
|
-
"x-title": "Connect Accounts",
|
|
42097
|
+
"x-title": "Generate a Connect Accounts Building Block Magic Link",
|
|
41917
42098
|
"x-undocumented": "Experimental partner building blocks."
|
|
41918
42099
|
}
|
|
41919
42100
|
},
|
|
@@ -41925,60 +42106,43 @@ var openapi_default = {
|
|
|
41925
42106
|
content: {
|
|
41926
42107
|
"application/json": {
|
|
41927
42108
|
schema: {
|
|
41928
|
-
|
|
41929
|
-
{
|
|
41930
|
-
|
|
41931
|
-
|
|
41932
|
-
|
|
41933
|
-
|
|
41934
|
-
|
|
41935
|
-
|
|
41936
|
-
|
|
41937
|
-
|
|
41938
|
-
type: "object"
|
|
42109
|
+
properties: {
|
|
42110
|
+
building_block_type: {
|
|
42111
|
+
description: "Type of building block to create a magic link for.",
|
|
42112
|
+
enum: [
|
|
42113
|
+
"connect_accounts",
|
|
42114
|
+
"organize_spaces",
|
|
42115
|
+
"console",
|
|
42116
|
+
"manage_devices"
|
|
42117
|
+
],
|
|
42118
|
+
type: "string"
|
|
41939
42119
|
},
|
|
41940
|
-
{
|
|
41941
|
-
|
|
41942
|
-
|
|
41943
|
-
enum: ["manage_devices"],
|
|
41944
|
-
type: "string"
|
|
41945
|
-
},
|
|
41946
|
-
customer_key: { type: "string" }
|
|
41947
|
-
},
|
|
41948
|
-
required: ["building_block_type", "customer_key"],
|
|
41949
|
-
type: "object"
|
|
42120
|
+
customer_key: {
|
|
42121
|
+
description: "Customer key for which you want to create a new building block magic link.",
|
|
42122
|
+
type: "string"
|
|
41950
42123
|
},
|
|
41951
|
-
{
|
|
41952
|
-
|
|
41953
|
-
|
|
41954
|
-
|
|
41955
|
-
|
|
41956
|
-
|
|
41957
|
-
|
|
41958
|
-
partner_resources: {
|
|
41959
|
-
description: "Optional list of partner resources to include in the magic link.",
|
|
41960
|
-
items: {
|
|
41961
|
-
properties: {
|
|
41962
|
-
custom_metadata: {
|
|
41963
|
-
additionalProperties: { type: "string" },
|
|
41964
|
-
type: "object"
|
|
41965
|
-
},
|
|
41966
|
-
description: { type: "string" },
|
|
41967
|
-
name: { type: "string" },
|
|
41968
|
-
partner_resource_key: { type: "string" }
|
|
41969
|
-
},
|
|
41970
|
-
required: ["partner_resource_key", "name"],
|
|
41971
|
-
type: "object",
|
|
41972
|
-
"x-route-path": "/unstable_partner/resources",
|
|
41973
|
-
"x-undocumented": "Unreleased."
|
|
42124
|
+
spaces: {
|
|
42125
|
+
description: "Optional list of spaces that you want to include in the new building block magic link.",
|
|
42126
|
+
items: {
|
|
42127
|
+
properties: {
|
|
42128
|
+
custom_metadata: {
|
|
42129
|
+
additionalProperties: { type: "string" },
|
|
42130
|
+
type: "object"
|
|
41974
42131
|
},
|
|
41975
|
-
type: "
|
|
41976
|
-
|
|
42132
|
+
description: { type: "string" },
|
|
42133
|
+
name: { type: "string" },
|
|
42134
|
+
space_key: { type: "string" }
|
|
42135
|
+
},
|
|
42136
|
+
required: ["space_key", "name"],
|
|
42137
|
+
type: "object",
|
|
42138
|
+
"x-route-path": "/unstable_partner/resources",
|
|
42139
|
+
"x-undocumented": "Unreleased."
|
|
41977
42140
|
},
|
|
41978
|
-
|
|
41979
|
-
type: "object"
|
|
42141
|
+
type: "array"
|
|
41980
42142
|
}
|
|
41981
|
-
|
|
42143
|
+
},
|
|
42144
|
+
required: ["building_block_type", "customer_key"],
|
|
42145
|
+
type: "object"
|
|
41982
42146
|
}
|
|
41983
42147
|
}
|
|
41984
42148
|
}
|
|
@@ -42013,7 +42177,7 @@ var openapi_default = {
|
|
|
42013
42177
|
"x-fern-sdk-method-name": "generate_magic_link",
|
|
42014
42178
|
"x-fern-sdk-return-value": "magic_link",
|
|
42015
42179
|
"x-response-key": "magic_link",
|
|
42016
|
-
"x-title": "Generate a
|
|
42180
|
+
"x-title": "Generate a Building Block Magic Link",
|
|
42017
42181
|
"x-undocumented": "Experimental partner building blocks."
|
|
42018
42182
|
}
|
|
42019
42183
|
},
|
|
@@ -42025,7 +42189,12 @@ var openapi_default = {
|
|
|
42025
42189
|
content: {
|
|
42026
42190
|
"application/json": {
|
|
42027
42191
|
schema: {
|
|
42028
|
-
properties: {
|
|
42192
|
+
properties: {
|
|
42193
|
+
customer_key: {
|
|
42194
|
+
description: "Customer key for which you want to manage devices.",
|
|
42195
|
+
type: "string"
|
|
42196
|
+
}
|
|
42197
|
+
},
|
|
42029
42198
|
required: ["customer_key"],
|
|
42030
42199
|
type: "object"
|
|
42031
42200
|
}
|
|
@@ -42062,7 +42231,7 @@ var openapi_default = {
|
|
|
42062
42231
|
"x-fern-sdk-method-name": "manage_devices",
|
|
42063
42232
|
"x-fern-sdk-return-value": "magic_link",
|
|
42064
42233
|
"x-response-key": "magic_link",
|
|
42065
|
-
"x-title": "Manage Devices",
|
|
42234
|
+
"x-title": "Generate a Manage Devices Building Block Magic Link",
|
|
42066
42235
|
"x-undocumented": "Experimental partner building blocks."
|
|
42067
42236
|
}
|
|
42068
42237
|
},
|
|
@@ -42075,8 +42244,12 @@ var openapi_default = {
|
|
|
42075
42244
|
"application/json": {
|
|
42076
42245
|
schema: {
|
|
42077
42246
|
properties: {
|
|
42078
|
-
customer_key: {
|
|
42079
|
-
|
|
42247
|
+
customer_key: {
|
|
42248
|
+
description: "Customer key for which you want to organize spaces.",
|
|
42249
|
+
type: "string"
|
|
42250
|
+
},
|
|
42251
|
+
spaces: {
|
|
42252
|
+
description: "Optional list of spaces that you want to include in the new building block magic link.",
|
|
42080
42253
|
items: {
|
|
42081
42254
|
properties: {
|
|
42082
42255
|
custom_metadata: {
|
|
@@ -42085,9 +42258,9 @@ var openapi_default = {
|
|
|
42085
42258
|
},
|
|
42086
42259
|
description: { type: "string" },
|
|
42087
42260
|
name: { type: "string" },
|
|
42088
|
-
|
|
42261
|
+
space_key: { type: "string" }
|
|
42089
42262
|
},
|
|
42090
|
-
required: ["
|
|
42263
|
+
required: ["space_key", "name"],
|
|
42091
42264
|
type: "object",
|
|
42092
42265
|
"x-route-path": "/unstable_partner/resources",
|
|
42093
42266
|
"x-undocumented": "Unreleased."
|
|
@@ -42131,13 +42304,13 @@ var openapi_default = {
|
|
|
42131
42304
|
"x-fern-sdk-method-name": "organize_spaces",
|
|
42132
42305
|
"x-fern-sdk-return-value": "magic_link",
|
|
42133
42306
|
"x-response-key": "magic_link",
|
|
42134
|
-
"x-title": "Organize Spaces",
|
|
42307
|
+
"x-title": "Generate an Organize Spaces Building Block Magic Link",
|
|
42135
42308
|
"x-undocumented": "Experimental partner building blocks."
|
|
42136
42309
|
}
|
|
42137
42310
|
},
|
|
42138
42311
|
"/unstable_partner/resources/push": {
|
|
42139
42312
|
post: {
|
|
42140
|
-
description: "
|
|
42313
|
+
description: "Sends Seam some of your resources.",
|
|
42141
42314
|
operationId: "unstablePartnerResourcesPushPost",
|
|
42142
42315
|
requestBody: {
|
|
42143
42316
|
content: {
|
|
@@ -42151,7 +42324,10 @@ var openapi_default = {
|
|
|
42151
42324
|
additionalProperties: { type: "string" },
|
|
42152
42325
|
type: "object"
|
|
42153
42326
|
},
|
|
42154
|
-
customer_key: {
|
|
42327
|
+
customer_key: {
|
|
42328
|
+
description: "Customer key associated with the resource that you want to push to Seam.",
|
|
42329
|
+
type: "string"
|
|
42330
|
+
},
|
|
42155
42331
|
description: { type: "string" },
|
|
42156
42332
|
email_address: { type: "string" },
|
|
42157
42333
|
ends_at: { type: "string" },
|
|
@@ -42160,8 +42336,14 @@ var openapi_default = {
|
|
|
42160
42336
|
type: "array"
|
|
42161
42337
|
},
|
|
42162
42338
|
name: { type: "string" },
|
|
42163
|
-
partner_resource_key: {
|
|
42164
|
-
|
|
42339
|
+
partner_resource_key: {
|
|
42340
|
+
description: "Key of the resource that you want to push to Seam.",
|
|
42341
|
+
type: "string"
|
|
42342
|
+
},
|
|
42343
|
+
partner_resource_type: {
|
|
42344
|
+
description: "Type of the resource that you want to push to Seam.",
|
|
42345
|
+
type: "string"
|
|
42346
|
+
},
|
|
42165
42347
|
phone_number: { type: "string" },
|
|
42166
42348
|
starts_at: { type: "string" },
|
|
42167
42349
|
user_identity_key: { type: "string" }
|
|
@@ -42178,7 +42360,10 @@ var openapi_default = {
|
|
|
42178
42360
|
additionalProperties: { type: "string" },
|
|
42179
42361
|
type: "object"
|
|
42180
42362
|
},
|
|
42181
|
-
customer_key: {
|
|
42363
|
+
customer_key: {
|
|
42364
|
+
description: "Customer key associated with the resource that you want to push to Seam.",
|
|
42365
|
+
type: "string"
|
|
42366
|
+
},
|
|
42182
42367
|
description: { type: "string" },
|
|
42183
42368
|
email_address: { type: "string" },
|
|
42184
42369
|
ends_at: { type: "string" },
|
|
@@ -42187,8 +42372,14 @@ var openapi_default = {
|
|
|
42187
42372
|
type: "array"
|
|
42188
42373
|
},
|
|
42189
42374
|
name: { type: "string" },
|
|
42190
|
-
partner_resource_key: {
|
|
42191
|
-
|
|
42375
|
+
partner_resource_key: {
|
|
42376
|
+
description: "Key of the resource that you want to push to Seam.",
|
|
42377
|
+
type: "string"
|
|
42378
|
+
},
|
|
42379
|
+
partner_resource_type: {
|
|
42380
|
+
description: "Type of the resource that you want to push to Seam.",
|
|
42381
|
+
type: "string"
|
|
42382
|
+
},
|
|
42192
42383
|
phone_number: { type: "string" },
|
|
42193
42384
|
starts_at: { type: "string" },
|
|
42194
42385
|
user_identity_key: { type: "string" }
|
|
@@ -42228,13 +42419,13 @@ var openapi_default = {
|
|
|
42228
42419
|
"x-fern-sdk-group-name": ["unstable_partner", "resources"],
|
|
42229
42420
|
"x-fern-sdk-method-name": "push",
|
|
42230
42421
|
"x-response-key": null,
|
|
42231
|
-
"x-title": "Push
|
|
42422
|
+
"x-title": "Push Partner Resources at Seam",
|
|
42232
42423
|
"x-undocumented": "Experimental partner resources."
|
|
42233
42424
|
}
|
|
42234
42425
|
},
|
|
42235
42426
|
"/user_identities/add_acs_user": {
|
|
42236
42427
|
post: {
|
|
42237
|
-
description: "Adds a specified [
|
|
42428
|
+
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
42429
|
operationId: "userIdentitiesAddAcsUserPost",
|
|
42239
42430
|
requestBody: {
|
|
42240
42431
|
content: {
|
|
@@ -42242,12 +42433,12 @@ var openapi_default = {
|
|
|
42242
42433
|
schema: {
|
|
42243
42434
|
properties: {
|
|
42244
42435
|
acs_user_id: {
|
|
42245
|
-
description: "ID of the
|
|
42436
|
+
description: "ID of the access system user that you want to add to the user identity.",
|
|
42246
42437
|
format: "uuid",
|
|
42247
42438
|
type: "string"
|
|
42248
42439
|
},
|
|
42249
42440
|
user_identity_id: {
|
|
42250
|
-
description: "ID of the
|
|
42441
|
+
description: "ID of the user identity to which you want to add an access system user.",
|
|
42251
42442
|
format: "uuid",
|
|
42252
42443
|
type: "string"
|
|
42253
42444
|
}
|
|
@@ -42287,7 +42478,7 @@ var openapi_default = {
|
|
|
42287
42478
|
"x-title": "Add an ACS User to a User Identity"
|
|
42288
42479
|
},
|
|
42289
42480
|
put: {
|
|
42290
|
-
description: "Adds a specified [
|
|
42481
|
+
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
42482
|
operationId: "userIdentitiesAddAcsUserPut",
|
|
42292
42483
|
requestBody: {
|
|
42293
42484
|
content: {
|
|
@@ -42295,12 +42486,12 @@ var openapi_default = {
|
|
|
42295
42486
|
schema: {
|
|
42296
42487
|
properties: {
|
|
42297
42488
|
acs_user_id: {
|
|
42298
|
-
description: "ID of the
|
|
42489
|
+
description: "ID of the access system user that you want to add to the user identity.",
|
|
42299
42490
|
format: "uuid",
|
|
42300
42491
|
type: "string"
|
|
42301
42492
|
},
|
|
42302
42493
|
user_identity_id: {
|
|
42303
|
-
description: "ID of the
|
|
42494
|
+
description: "ID of the user identity to which you want to add an access system user.",
|
|
42304
42495
|
format: "uuid",
|
|
42305
42496
|
type: "string"
|
|
42306
42497
|
}
|
|
@@ -42349,29 +42540,29 @@ var openapi_default = {
|
|
|
42349
42540
|
schema: {
|
|
42350
42541
|
properties: {
|
|
42351
42542
|
acs_system_ids: {
|
|
42352
|
-
description: "List of
|
|
42543
|
+
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
42544
|
items: { format: "uuid", type: "string" },
|
|
42354
42545
|
type: "array"
|
|
42355
42546
|
},
|
|
42356
42547
|
email_address: {
|
|
42357
|
-
description: "Unique email address for the user identity.",
|
|
42548
|
+
description: "Unique email address for the new user identity.",
|
|
42358
42549
|
format: "email",
|
|
42359
42550
|
nullable: true,
|
|
42360
42551
|
type: "string"
|
|
42361
42552
|
},
|
|
42362
42553
|
full_name: {
|
|
42363
|
-
description: "Full name of the user associated with the user identity.",
|
|
42554
|
+
description: "Full name of the user associated with the new user identity.",
|
|
42364
42555
|
minLength: 1,
|
|
42365
42556
|
nullable: true,
|
|
42366
42557
|
type: "string"
|
|
42367
42558
|
},
|
|
42368
42559
|
phone_number: {
|
|
42369
|
-
description: "Unique phone number for the user identity in E.164 format (for example, +15555550100).",
|
|
42560
|
+
description: "Unique phone number for the new user identity in E.164 format (for example, +15555550100).",
|
|
42370
42561
|
nullable: true,
|
|
42371
42562
|
type: "string"
|
|
42372
42563
|
},
|
|
42373
42564
|
user_identity_key: {
|
|
42374
|
-
description: "Unique key for the user identity.",
|
|
42565
|
+
description: "Unique key for the new user identity.",
|
|
42375
42566
|
minLength: 1,
|
|
42376
42567
|
nullable: true,
|
|
42377
42568
|
type: "string"
|
|
@@ -42427,7 +42618,7 @@ var openapi_default = {
|
|
|
42427
42618
|
schema: {
|
|
42428
42619
|
properties: {
|
|
42429
42620
|
user_identity_id: {
|
|
42430
|
-
description: "ID of the
|
|
42621
|
+
description: "ID of the user identity that you want to delete.",
|
|
42431
42622
|
format: "uuid",
|
|
42432
42623
|
type: "string"
|
|
42433
42624
|
}
|
|
@@ -42477,7 +42668,7 @@ var openapi_default = {
|
|
|
42477
42668
|
schema: {
|
|
42478
42669
|
properties: {
|
|
42479
42670
|
enrollment_automation_id: {
|
|
42480
|
-
description: "ID of the
|
|
42671
|
+
description: "ID of the enrollment automation that you want to delete.",
|
|
42481
42672
|
format: "uuid",
|
|
42482
42673
|
type: "string"
|
|
42483
42674
|
}
|
|
@@ -42527,7 +42718,7 @@ var openapi_default = {
|
|
|
42527
42718
|
schema: {
|
|
42528
42719
|
properties: {
|
|
42529
42720
|
enrollment_automation_id: {
|
|
42530
|
-
description: "ID of the
|
|
42721
|
+
description: "ID of the enrollment automation that you want to get.",
|
|
42531
42722
|
format: "uuid",
|
|
42532
42723
|
type: "string"
|
|
42533
42724
|
}
|
|
@@ -42584,7 +42775,7 @@ var openapi_default = {
|
|
|
42584
42775
|
schema: {
|
|
42585
42776
|
properties: {
|
|
42586
42777
|
acs_credential_pool_id: {
|
|
42587
|
-
description: "ID of the
|
|
42778
|
+
description: "ID of the credential pool from which to obtain credentials for the user identity.",
|
|
42588
42779
|
format: "uuid",
|
|
42589
42780
|
type: "string"
|
|
42590
42781
|
},
|
|
@@ -42593,17 +42784,17 @@ var openapi_default = {
|
|
|
42593
42784
|
type: "boolean"
|
|
42594
42785
|
},
|
|
42595
42786
|
credential_manager_acs_system_id: {
|
|
42596
|
-
description: "ID of the desired
|
|
42787
|
+
description: "ID of the desired access system that serves as the credential manager for the enrollment automation.",
|
|
42597
42788
|
format: "uuid",
|
|
42598
42789
|
type: "string"
|
|
42599
42790
|
},
|
|
42600
42791
|
credential_manager_acs_user_id: {
|
|
42601
|
-
description: "ID of the associated
|
|
42792
|
+
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
42793
|
format: "uuid",
|
|
42603
42794
|
type: "string"
|
|
42604
42795
|
},
|
|
42605
42796
|
user_identity_id: {
|
|
42606
|
-
description: "ID of the
|
|
42797
|
+
description: "ID of the user identity for which you want to launch an enrollment automation.",
|
|
42607
42798
|
format: "uuid",
|
|
42608
42799
|
type: "string"
|
|
42609
42800
|
}
|
|
@@ -42687,7 +42878,7 @@ var openapi_default = {
|
|
|
42687
42878
|
schema: {
|
|
42688
42879
|
properties: {
|
|
42689
42880
|
user_identity_id: {
|
|
42690
|
-
description: "ID of the user identity for which you want to retrieve
|
|
42881
|
+
description: "ID of the user identity for which you want to retrieve enrollment automations.",
|
|
42691
42882
|
format: "uuid",
|
|
42692
42883
|
type: "string"
|
|
42693
42884
|
}
|
|
@@ -42748,7 +42939,7 @@ var openapi_default = {
|
|
|
42748
42939
|
properties: {
|
|
42749
42940
|
max_use_count: {
|
|
42750
42941
|
default: 1,
|
|
42751
|
-
description: "
|
|
42942
|
+
description: "Maximum number of times the instant key can be used. Default: 1.",
|
|
42752
42943
|
format: "float",
|
|
42753
42944
|
type: "number"
|
|
42754
42945
|
},
|
|
@@ -42809,7 +43000,7 @@ var openapi_default = {
|
|
|
42809
43000
|
{
|
|
42810
43001
|
properties: {
|
|
42811
43002
|
user_identity_id: {
|
|
42812
|
-
description: "ID of the
|
|
43003
|
+
description: "ID of the user identity that you want to get.",
|
|
42813
43004
|
format: "uuid",
|
|
42814
43005
|
type: "string"
|
|
42815
43006
|
}
|
|
@@ -42872,12 +43063,12 @@ var openapi_default = {
|
|
|
42872
43063
|
schema: {
|
|
42873
43064
|
properties: {
|
|
42874
43065
|
device_id: {
|
|
42875
|
-
description: "ID of the
|
|
43066
|
+
description: "ID of the managed device to which you want to grant access to the user identity.",
|
|
42876
43067
|
format: "uuid",
|
|
42877
43068
|
type: "string"
|
|
42878
43069
|
},
|
|
42879
43070
|
user_identity_id: {
|
|
42880
|
-
description: "ID of the
|
|
43071
|
+
description: "ID of the user identity that you want to grant access to a device.",
|
|
42881
43072
|
format: "uuid",
|
|
42882
43073
|
type: "string"
|
|
42883
43074
|
}
|
|
@@ -42925,12 +43116,12 @@ var openapi_default = {
|
|
|
42925
43116
|
schema: {
|
|
42926
43117
|
properties: {
|
|
42927
43118
|
device_id: {
|
|
42928
|
-
description: "ID of the
|
|
43119
|
+
description: "ID of the managed device to which you want to grant access to the user identity.",
|
|
42929
43120
|
format: "uuid",
|
|
42930
43121
|
type: "string"
|
|
42931
43122
|
},
|
|
42932
43123
|
user_identity_id: {
|
|
42933
|
-
description: "ID of the
|
|
43124
|
+
description: "ID of the user identity that you want to grant access to a device.",
|
|
42934
43125
|
format: "uuid",
|
|
42935
43126
|
type: "string"
|
|
42936
43127
|
}
|
|
@@ -42979,6 +43170,7 @@ var openapi_default = {
|
|
|
42979
43170
|
schema: {
|
|
42980
43171
|
properties: {
|
|
42981
43172
|
credential_manager_acs_system_id: {
|
|
43173
|
+
description: "`acs_system_id` of the credential manager by which you want to filter the list of user identities.",
|
|
42982
43174
|
format: "uuid",
|
|
42983
43175
|
type: "string"
|
|
42984
43176
|
}
|
|
@@ -43056,7 +43248,7 @@ var openapi_default = {
|
|
|
43056
43248
|
deprecated: true,
|
|
43057
43249
|
items: { $ref: "#/components/schemas/device" },
|
|
43058
43250
|
type: "array",
|
|
43059
|
-
"x-deprecated": "
|
|
43251
|
+
"x-deprecated": "Use devices."
|
|
43060
43252
|
},
|
|
43061
43253
|
devices: {
|
|
43062
43254
|
items: { $ref: "#/components/schemas/device" },
|
|
@@ -43090,7 +43282,7 @@ var openapi_default = {
|
|
|
43090
43282
|
},
|
|
43091
43283
|
"/user_identities/list_acs_systems": {
|
|
43092
43284
|
post: {
|
|
43093
|
-
description: "Returns a list of all [access
|
|
43285
|
+
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
43286
|
operationId: "userIdentitiesListAcsSystemsPost",
|
|
43095
43287
|
requestBody: {
|
|
43096
43288
|
content: {
|
|
@@ -43098,7 +43290,7 @@ var openapi_default = {
|
|
|
43098
43290
|
schema: {
|
|
43099
43291
|
properties: {
|
|
43100
43292
|
user_identity_id: {
|
|
43101
|
-
description: "ID of the user identity for which you want to retrieve all access
|
|
43293
|
+
description: "ID of the user identity for which you want to retrieve all access systems.",
|
|
43102
43294
|
format: "uuid",
|
|
43103
43295
|
type: "string"
|
|
43104
43296
|
}
|
|
@@ -43148,7 +43340,7 @@ var openapi_default = {
|
|
|
43148
43340
|
},
|
|
43149
43341
|
"/user_identities/list_acs_users": {
|
|
43150
43342
|
post: {
|
|
43151
|
-
description: "Returns a list of all [
|
|
43343
|
+
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
43344
|
operationId: "userIdentitiesListAcsUsersPost",
|
|
43153
43345
|
requestBody: {
|
|
43154
43346
|
content: {
|
|
@@ -43156,7 +43348,7 @@ var openapi_default = {
|
|
|
43156
43348
|
schema: {
|
|
43157
43349
|
properties: {
|
|
43158
43350
|
user_identity_id: {
|
|
43159
|
-
description: "ID of the user identity for which you want to retrieve all
|
|
43351
|
+
description: "ID of the user identity for which you want to retrieve all access system users.",
|
|
43160
43352
|
format: "uuid",
|
|
43161
43353
|
type: "string"
|
|
43162
43354
|
}
|
|
@@ -43205,7 +43397,7 @@ var openapi_default = {
|
|
|
43205
43397
|
},
|
|
43206
43398
|
"/user_identities/remove_acs_user": {
|
|
43207
43399
|
post: {
|
|
43208
|
-
description: "Removes a specified [
|
|
43400
|
+
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
43401
|
operationId: "userIdentitiesRemoveAcsUserPost",
|
|
43210
43402
|
requestBody: {
|
|
43211
43403
|
content: {
|
|
@@ -43213,12 +43405,12 @@ var openapi_default = {
|
|
|
43213
43405
|
schema: {
|
|
43214
43406
|
properties: {
|
|
43215
43407
|
acs_user_id: {
|
|
43216
|
-
description: "ID of the
|
|
43408
|
+
description: "ID of the access system user that you want to remove from the user identity..",
|
|
43217
43409
|
format: "uuid",
|
|
43218
43410
|
type: "string"
|
|
43219
43411
|
},
|
|
43220
43412
|
user_identity_id: {
|
|
43221
|
-
description: "ID of the
|
|
43413
|
+
description: "ID of the user identity from which you want to remove an access system user.",
|
|
43222
43414
|
format: "uuid",
|
|
43223
43415
|
type: "string"
|
|
43224
43416
|
}
|
|
@@ -43268,12 +43460,12 @@ var openapi_default = {
|
|
|
43268
43460
|
schema: {
|
|
43269
43461
|
properties: {
|
|
43270
43462
|
device_id: {
|
|
43271
|
-
description: "ID of the
|
|
43463
|
+
description: "ID of the managed device to which you want to revoke access from the user identity.",
|
|
43272
43464
|
format: "uuid",
|
|
43273
43465
|
type: "string"
|
|
43274
43466
|
},
|
|
43275
43467
|
user_identity_id: {
|
|
43276
|
-
description: "ID of the
|
|
43468
|
+
description: "ID of the user identity from which you want to revoke access to a device.",
|
|
43277
43469
|
format: "uuid",
|
|
43278
43470
|
type: "string"
|
|
43279
43471
|
}
|
|
@@ -43315,6 +43507,7 @@ var openapi_default = {
|
|
|
43315
43507
|
},
|
|
43316
43508
|
"/user_identities/update": {
|
|
43317
43509
|
patch: {
|
|
43510
|
+
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
43511
|
operationId: "userIdentitiesUpdatePatch",
|
|
43319
43512
|
requestBody: {
|
|
43320
43513
|
content: {
|
|
@@ -43327,14 +43520,19 @@ var openapi_default = {
|
|
|
43327
43520
|
nullable: true,
|
|
43328
43521
|
type: "string"
|
|
43329
43522
|
},
|
|
43330
|
-
full_name: {
|
|
43523
|
+
full_name: {
|
|
43524
|
+
description: "Full name of the user associated with the user identity.",
|
|
43525
|
+
minLength: 1,
|
|
43526
|
+
nullable: true,
|
|
43527
|
+
type: "string"
|
|
43528
|
+
},
|
|
43331
43529
|
phone_number: {
|
|
43332
|
-
description: "Unique phone number for the user identity
|
|
43530
|
+
description: "Unique phone number for the user identity.",
|
|
43333
43531
|
nullable: true,
|
|
43334
43532
|
type: "string"
|
|
43335
43533
|
},
|
|
43336
43534
|
user_identity_id: {
|
|
43337
|
-
description: "ID of the user identity.",
|
|
43535
|
+
description: "ID of the user identity that you want to update.",
|
|
43338
43536
|
format: "uuid",
|
|
43339
43537
|
type: "string"
|
|
43340
43538
|
},
|
|
@@ -43379,6 +43577,7 @@ var openapi_default = {
|
|
|
43379
43577
|
"x-title": "Update a User Identity"
|
|
43380
43578
|
},
|
|
43381
43579
|
post: {
|
|
43580
|
+
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
43581
|
operationId: "userIdentitiesUpdatePost",
|
|
43383
43582
|
requestBody: {
|
|
43384
43583
|
content: {
|
|
@@ -43391,14 +43590,19 @@ var openapi_default = {
|
|
|
43391
43590
|
nullable: true,
|
|
43392
43591
|
type: "string"
|
|
43393
43592
|
},
|
|
43394
|
-
full_name: {
|
|
43593
|
+
full_name: {
|
|
43594
|
+
description: "Full name of the user associated with the user identity.",
|
|
43595
|
+
minLength: 1,
|
|
43596
|
+
nullable: true,
|
|
43597
|
+
type: "string"
|
|
43598
|
+
},
|
|
43395
43599
|
phone_number: {
|
|
43396
|
-
description: "Unique phone number for the user identity
|
|
43600
|
+
description: "Unique phone number for the user identity.",
|
|
43397
43601
|
nullable: true,
|
|
43398
43602
|
type: "string"
|
|
43399
43603
|
},
|
|
43400
43604
|
user_identity_id: {
|
|
43401
|
-
description: "ID of the user identity.",
|
|
43605
|
+
description: "ID of the user identity that you want to update.",
|
|
43402
43606
|
format: "uuid",
|
|
43403
43607
|
type: "string"
|
|
43404
43608
|
},
|
|
@@ -43446,6 +43650,7 @@ var openapi_default = {
|
|
|
43446
43650
|
},
|
|
43447
43651
|
"/webhooks/create": {
|
|
43448
43652
|
post: {
|
|
43653
|
+
description: "Creates a new [webhook](https://docs.seam.co/latest/developer-tools/webhooks).",
|
|
43449
43654
|
operationId: "webhooksCreatePost",
|
|
43450
43655
|
requestBody: {
|
|
43451
43656
|
content: {
|
|
@@ -43454,10 +43659,15 @@ var openapi_default = {
|
|
|
43454
43659
|
properties: {
|
|
43455
43660
|
event_types: {
|
|
43456
43661
|
default: ["*"],
|
|
43662
|
+
description: "Types of events that you want the new webhook to receive.",
|
|
43457
43663
|
items: { type: "string" },
|
|
43458
43664
|
type: "array"
|
|
43459
43665
|
},
|
|
43460
|
-
url: {
|
|
43666
|
+
url: {
|
|
43667
|
+
description: "URL for the new webhook.",
|
|
43668
|
+
format: "uri",
|
|
43669
|
+
type: "string"
|
|
43670
|
+
}
|
|
43461
43671
|
},
|
|
43462
43672
|
required: ["url"],
|
|
43463
43673
|
type: "object"
|
|
@@ -43494,17 +43704,24 @@ var openapi_default = {
|
|
|
43494
43704
|
"x-fern-sdk-group-name": ["webhooks"],
|
|
43495
43705
|
"x-fern-sdk-method-name": "create",
|
|
43496
43706
|
"x-fern-sdk-return-value": "webhook",
|
|
43497
|
-
"x-response-key": "webhook"
|
|
43707
|
+
"x-response-key": "webhook",
|
|
43708
|
+
"x-title": "Create a Webhook"
|
|
43498
43709
|
}
|
|
43499
43710
|
},
|
|
43500
43711
|
"/webhooks/delete": {
|
|
43501
43712
|
post: {
|
|
43713
|
+
description: "Deletes a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).",
|
|
43502
43714
|
operationId: "webhooksDeletePost",
|
|
43503
43715
|
requestBody: {
|
|
43504
43716
|
content: {
|
|
43505
43717
|
"application/json": {
|
|
43506
43718
|
schema: {
|
|
43507
|
-
properties: {
|
|
43719
|
+
properties: {
|
|
43720
|
+
webhook_id: {
|
|
43721
|
+
description: "ID of the webhook that you want to delete.",
|
|
43722
|
+
type: "string"
|
|
43723
|
+
}
|
|
43724
|
+
},
|
|
43508
43725
|
required: ["webhook_id"],
|
|
43509
43726
|
type: "object"
|
|
43510
43727
|
}
|
|
@@ -43536,17 +43753,24 @@ var openapi_default = {
|
|
|
43536
43753
|
tags: ["/webhooks"],
|
|
43537
43754
|
"x-fern-sdk-group-name": ["webhooks"],
|
|
43538
43755
|
"x-fern-sdk-method-name": "delete",
|
|
43539
|
-
"x-response-key": null
|
|
43756
|
+
"x-response-key": null,
|
|
43757
|
+
"x-title": "Delete a Webhook"
|
|
43540
43758
|
}
|
|
43541
43759
|
},
|
|
43542
43760
|
"/webhooks/get": {
|
|
43543
43761
|
post: {
|
|
43762
|
+
description: "Gets a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).",
|
|
43544
43763
|
operationId: "webhooksGetPost",
|
|
43545
43764
|
requestBody: {
|
|
43546
43765
|
content: {
|
|
43547
43766
|
"application/json": {
|
|
43548
43767
|
schema: {
|
|
43549
|
-
properties: {
|
|
43768
|
+
properties: {
|
|
43769
|
+
webhook_id: {
|
|
43770
|
+
description: "ID of the webhook that you want to get.",
|
|
43771
|
+
type: "string"
|
|
43772
|
+
}
|
|
43773
|
+
},
|
|
43550
43774
|
required: ["webhook_id"],
|
|
43551
43775
|
type: "object"
|
|
43552
43776
|
}
|
|
@@ -43582,11 +43806,13 @@ var openapi_default = {
|
|
|
43582
43806
|
"x-fern-sdk-group-name": ["webhooks"],
|
|
43583
43807
|
"x-fern-sdk-method-name": "get",
|
|
43584
43808
|
"x-fern-sdk-return-value": "webhook",
|
|
43585
|
-
"x-response-key": "webhook"
|
|
43809
|
+
"x-response-key": "webhook",
|
|
43810
|
+
"x-title": "Get a Webhook"
|
|
43586
43811
|
}
|
|
43587
43812
|
},
|
|
43588
43813
|
"/webhooks/list": {
|
|
43589
43814
|
get: {
|
|
43815
|
+
description: "Returns a list of all [webhooks](https://docs.seam.co/latest/developer-tools/webhooks).",
|
|
43590
43816
|
operationId: "webhooksListGet",
|
|
43591
43817
|
responses: {
|
|
43592
43818
|
200: {
|
|
@@ -43618,9 +43844,11 @@ var openapi_default = {
|
|
|
43618
43844
|
summary: "/webhooks/list",
|
|
43619
43845
|
tags: ["/webhooks"],
|
|
43620
43846
|
"x-fern-ignore": true,
|
|
43621
|
-
"x-response-key": "webhooks"
|
|
43847
|
+
"x-response-key": "webhooks",
|
|
43848
|
+
"x-title": "List Webhooks"
|
|
43622
43849
|
},
|
|
43623
43850
|
post: {
|
|
43851
|
+
description: "Returns a list of all [webhooks](https://docs.seam.co/latest/developer-tools/webhooks).",
|
|
43624
43852
|
operationId: "webhooksListPost",
|
|
43625
43853
|
responses: {
|
|
43626
43854
|
200: {
|
|
@@ -43654,19 +43882,28 @@ var openapi_default = {
|
|
|
43654
43882
|
"x-fern-sdk-group-name": ["webhooks"],
|
|
43655
43883
|
"x-fern-sdk-method-name": "list",
|
|
43656
43884
|
"x-fern-sdk-return-value": "webhooks",
|
|
43657
|
-
"x-response-key": "webhooks"
|
|
43885
|
+
"x-response-key": "webhooks",
|
|
43886
|
+
"x-title": "List Webhooks"
|
|
43658
43887
|
}
|
|
43659
43888
|
},
|
|
43660
43889
|
"/webhooks/update": {
|
|
43661
43890
|
post: {
|
|
43891
|
+
description: "Updates a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).",
|
|
43662
43892
|
operationId: "webhooksUpdatePost",
|
|
43663
43893
|
requestBody: {
|
|
43664
43894
|
content: {
|
|
43665
43895
|
"application/json": {
|
|
43666
43896
|
schema: {
|
|
43667
43897
|
properties: {
|
|
43668
|
-
event_types: {
|
|
43669
|
-
|
|
43898
|
+
event_types: {
|
|
43899
|
+
description: "Types of events that you want the webhook to receive.",
|
|
43900
|
+
items: { type: "string" },
|
|
43901
|
+
type: "array"
|
|
43902
|
+
},
|
|
43903
|
+
webhook_id: {
|
|
43904
|
+
description: "ID of the webhook that you want to update.",
|
|
43905
|
+
type: "string"
|
|
43906
|
+
}
|
|
43670
43907
|
},
|
|
43671
43908
|
required: ["webhook_id", "event_types"],
|
|
43672
43909
|
type: "object"
|
|
@@ -43699,17 +43936,26 @@ var openapi_default = {
|
|
|
43699
43936
|
tags: ["/webhooks"],
|
|
43700
43937
|
"x-fern-sdk-group-name": ["webhooks"],
|
|
43701
43938
|
"x-fern-sdk-method-name": "update",
|
|
43702
|
-
"x-response-key": null
|
|
43939
|
+
"x-response-key": null,
|
|
43940
|
+
"x-title": "Update a Webhook"
|
|
43703
43941
|
},
|
|
43704
43942
|
put: {
|
|
43943
|
+
description: "Updates a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).",
|
|
43705
43944
|
operationId: "webhooksUpdatePut",
|
|
43706
43945
|
requestBody: {
|
|
43707
43946
|
content: {
|
|
43708
43947
|
"application/json": {
|
|
43709
43948
|
schema: {
|
|
43710
43949
|
properties: {
|
|
43711
|
-
event_types: {
|
|
43712
|
-
|
|
43950
|
+
event_types: {
|
|
43951
|
+
description: "Types of events that you want the webhook to receive.",
|
|
43952
|
+
items: { type: "string" },
|
|
43953
|
+
type: "array"
|
|
43954
|
+
},
|
|
43955
|
+
webhook_id: {
|
|
43956
|
+
description: "ID of the webhook that you want to update.",
|
|
43957
|
+
type: "string"
|
|
43958
|
+
}
|
|
43713
43959
|
},
|
|
43714
43960
|
required: ["webhook_id", "event_types"],
|
|
43715
43961
|
type: "object"
|
|
@@ -43741,42 +43987,66 @@ var openapi_default = {
|
|
|
43741
43987
|
summary: "/webhooks/update",
|
|
43742
43988
|
tags: ["/webhooks"],
|
|
43743
43989
|
"x-fern-ignore": true,
|
|
43744
|
-
"x-response-key": null
|
|
43990
|
+
"x-response-key": null,
|
|
43991
|
+
"x-title": "Update a Webhook"
|
|
43745
43992
|
}
|
|
43746
43993
|
},
|
|
43747
43994
|
"/workspaces/create": {
|
|
43748
43995
|
post: {
|
|
43996
|
+
description: "Creates a new [workspace](https://docs.seam.co/latest/core-concepts/workspaces).",
|
|
43749
43997
|
operationId: "workspacesCreatePost",
|
|
43750
43998
|
requestBody: {
|
|
43751
43999
|
content: {
|
|
43752
44000
|
"application/json": {
|
|
43753
44001
|
schema: {
|
|
43754
44002
|
properties: {
|
|
43755
|
-
company_name: {
|
|
44003
|
+
company_name: {
|
|
44004
|
+
description: "Company name for the new workspace.",
|
|
44005
|
+
type: "string"
|
|
44006
|
+
},
|
|
43756
44007
|
connect_partner_name: {
|
|
43757
44008
|
deprecated: true,
|
|
44009
|
+
description: "Connect partner name for the new workspace.",
|
|
43758
44010
|
nullable: true,
|
|
43759
44011
|
type: "string",
|
|
43760
44012
|
"x-deprecated": "use company_name"
|
|
43761
44013
|
},
|
|
43762
44014
|
connect_webview_customization: {
|
|
44015
|
+
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
44016
|
properties: {
|
|
43764
44017
|
logo_shape: {
|
|
44018
|
+
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
44019
|
enum: ["circle", "square"],
|
|
43766
44020
|
nullable: true,
|
|
43767
44021
|
type: "string"
|
|
43768
44022
|
},
|
|
43769
|
-
primary_button_color: {
|
|
44023
|
+
primary_button_color: {
|
|
44024
|
+
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).",
|
|
44025
|
+
nullable: true,
|
|
44026
|
+
type: "string"
|
|
44027
|
+
},
|
|
43770
44028
|
primary_button_text_color: {
|
|
44029
|
+
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
44030
|
nullable: true,
|
|
43772
44031
|
type: "string"
|
|
43773
44032
|
},
|
|
43774
|
-
success_message: {
|
|
44033
|
+
success_message: {
|
|
44034
|
+
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).",
|
|
44035
|
+
nullable: true,
|
|
44036
|
+
type: "string"
|
|
44037
|
+
}
|
|
43775
44038
|
},
|
|
43776
44039
|
type: "object"
|
|
43777
44040
|
},
|
|
43778
|
-
is_sandbox: {
|
|
43779
|
-
|
|
44041
|
+
is_sandbox: {
|
|
44042
|
+
default: false,
|
|
44043
|
+
description: "Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).",
|
|
44044
|
+
type: "boolean"
|
|
44045
|
+
},
|
|
44046
|
+
name: {
|
|
44047
|
+
description: "Name of the new workspace.",
|
|
44048
|
+
type: "string"
|
|
44049
|
+
},
|
|
43780
44050
|
webview_logo_shape: {
|
|
43781
44051
|
deprecated: true,
|
|
43782
44052
|
enum: ["circle", "square"],
|
|
@@ -43834,11 +44104,13 @@ var openapi_default = {
|
|
|
43834
44104
|
"x-fern-sdk-group-name": ["workspaces"],
|
|
43835
44105
|
"x-fern-sdk-method-name": "create",
|
|
43836
44106
|
"x-fern-sdk-return-value": "workspace",
|
|
43837
|
-
"x-response-key": "workspace"
|
|
44107
|
+
"x-response-key": "workspace",
|
|
44108
|
+
"x-title": "Create a Workspace"
|
|
43838
44109
|
}
|
|
43839
44110
|
},
|
|
43840
44111
|
"/workspaces/get": {
|
|
43841
44112
|
get: {
|
|
44113
|
+
description: "Returns the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.",
|
|
43842
44114
|
operationId: "workspacesGetGet",
|
|
43843
44115
|
responses: {
|
|
43844
44116
|
200: {
|
|
@@ -43863,14 +44135,17 @@ var openapi_default = {
|
|
|
43863
44135
|
{ api_key: [] },
|
|
43864
44136
|
{ console_session_with_workspace: [] },
|
|
43865
44137
|
{ client_session: [] },
|
|
44138
|
+
{ client_session_with_customer: [] },
|
|
43866
44139
|
{ pat_with_workspace: [] }
|
|
43867
44140
|
],
|
|
43868
44141
|
summary: "/workspaces/get",
|
|
43869
44142
|
tags: ["/workspaces"],
|
|
43870
44143
|
"x-fern-ignore": true,
|
|
43871
|
-
"x-response-key": "workspace"
|
|
44144
|
+
"x-response-key": "workspace",
|
|
44145
|
+
"x-title": "Get a Workspace"
|
|
43872
44146
|
},
|
|
43873
44147
|
post: {
|
|
44148
|
+
description: "Returns the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.",
|
|
43874
44149
|
operationId: "workspacesGetPost",
|
|
43875
44150
|
responses: {
|
|
43876
44151
|
200: {
|
|
@@ -43895,6 +44170,7 @@ var openapi_default = {
|
|
|
43895
44170
|
{ api_key: [] },
|
|
43896
44171
|
{ console_session_with_workspace: [] },
|
|
43897
44172
|
{ client_session: [] },
|
|
44173
|
+
{ client_session_with_customer: [] },
|
|
43898
44174
|
{ pat_with_workspace: [] }
|
|
43899
44175
|
],
|
|
43900
44176
|
summary: "/workspaces/get",
|
|
@@ -43902,11 +44178,13 @@ var openapi_default = {
|
|
|
43902
44178
|
"x-fern-sdk-group-name": ["workspaces"],
|
|
43903
44179
|
"x-fern-sdk-method-name": "get",
|
|
43904
44180
|
"x-fern-sdk-return-value": "workspace",
|
|
43905
|
-
"x-response-key": "workspace"
|
|
44181
|
+
"x-response-key": "workspace",
|
|
44182
|
+
"x-title": "Get a Workspace"
|
|
43906
44183
|
}
|
|
43907
44184
|
},
|
|
43908
44185
|
"/workspaces/list": {
|
|
43909
44186
|
get: {
|
|
44187
|
+
description: "Returns a list of [workspaces](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.",
|
|
43910
44188
|
operationId: "workspacesListGet",
|
|
43911
44189
|
responses: {
|
|
43912
44190
|
200: {
|
|
@@ -43941,9 +44219,11 @@ var openapi_default = {
|
|
|
43941
44219
|
summary: "/workspaces/list",
|
|
43942
44220
|
tags: ["/workspaces"],
|
|
43943
44221
|
"x-fern-ignore": true,
|
|
43944
|
-
"x-response-key": "workspaces"
|
|
44222
|
+
"x-response-key": "workspaces",
|
|
44223
|
+
"x-title": "List Workspaces"
|
|
43945
44224
|
},
|
|
43946
44225
|
post: {
|
|
44226
|
+
description: "Returns a list of [workspaces](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.",
|
|
43947
44227
|
operationId: "workspacesListPost",
|
|
43948
44228
|
responses: {
|
|
43949
44229
|
200: {
|
|
@@ -43980,12 +44260,13 @@ var openapi_default = {
|
|
|
43980
44260
|
"x-fern-sdk-group-name": ["workspaces"],
|
|
43981
44261
|
"x-fern-sdk-method-name": "list",
|
|
43982
44262
|
"x-fern-sdk-return-value": "workspaces",
|
|
43983
|
-
"x-response-key": "workspaces"
|
|
44263
|
+
"x-response-key": "workspaces",
|
|
44264
|
+
"x-title": "List Workspaces"
|
|
43984
44265
|
}
|
|
43985
44266
|
},
|
|
43986
44267
|
"/workspaces/reset_sandbox": {
|
|
43987
44268
|
post: {
|
|
43988
|
-
description: "Resets
|
|
44269
|
+
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
44270
|
operationId: "workspacesResetSandboxPost",
|
|
43990
44271
|
responses: {
|
|
43991
44272
|
200: {
|
|
@@ -44019,36 +44300,58 @@ var openapi_default = {
|
|
|
44019
44300
|
"x-fern-sdk-group-name": ["workspaces"],
|
|
44020
44301
|
"x-fern-sdk-method-name": "reset_sandbox",
|
|
44021
44302
|
"x-fern-sdk-return-value": "action_attempt",
|
|
44022
|
-
"x-response-key": "action_attempt"
|
|
44303
|
+
"x-response-key": "action_attempt",
|
|
44304
|
+
"x-title": "Reset a Sandbox Workspace"
|
|
44023
44305
|
}
|
|
44024
44306
|
},
|
|
44025
44307
|
"/workspaces/update": {
|
|
44026
44308
|
patch: {
|
|
44309
|
+
description: "Updates the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.",
|
|
44027
44310
|
operationId: "workspacesUpdatePatch",
|
|
44028
44311
|
requestBody: {
|
|
44029
44312
|
content: {
|
|
44030
44313
|
"application/json": {
|
|
44031
44314
|
schema: {
|
|
44032
44315
|
properties: {
|
|
44033
|
-
connect_partner_name: {
|
|
44316
|
+
connect_partner_name: {
|
|
44317
|
+
description: "Connect partner name for the workspace.",
|
|
44318
|
+
type: "string"
|
|
44319
|
+
},
|
|
44034
44320
|
connect_webview_customization: {
|
|
44321
|
+
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
44322
|
properties: {
|
|
44036
44323
|
logo_shape: {
|
|
44324
|
+
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
44325
|
enum: ["circle", "square"],
|
|
44038
44326
|
nullable: true,
|
|
44039
44327
|
type: "string"
|
|
44040
44328
|
},
|
|
44041
|
-
primary_button_color: {
|
|
44329
|
+
primary_button_color: {
|
|
44330
|
+
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).",
|
|
44331
|
+
nullable: true,
|
|
44332
|
+
type: "string"
|
|
44333
|
+
},
|
|
44042
44334
|
primary_button_text_color: {
|
|
44335
|
+
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
44336
|
nullable: true,
|
|
44044
44337
|
type: "string"
|
|
44045
44338
|
},
|
|
44046
|
-
success_message: {
|
|
44339
|
+
success_message: {
|
|
44340
|
+
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).",
|
|
44341
|
+
nullable: true,
|
|
44342
|
+
type: "string"
|
|
44343
|
+
}
|
|
44047
44344
|
},
|
|
44048
44345
|
type: "object"
|
|
44049
44346
|
},
|
|
44050
|
-
is_suspended: {
|
|
44051
|
-
|
|
44347
|
+
is_suspended: {
|
|
44348
|
+
description: "Indicates whether the workspace is suspended.",
|
|
44349
|
+
type: "boolean"
|
|
44350
|
+
},
|
|
44351
|
+
name: {
|
|
44352
|
+
description: "Name of the workspace.",
|
|
44353
|
+
type: "string"
|
|
44354
|
+
}
|
|
44052
44355
|
},
|
|
44053
44356
|
type: "object"
|
|
44054
44357
|
}
|
|
@@ -44068,34 +44371,56 @@ var openapi_default = {
|
|
|
44068
44371
|
summary: "/workspaces/update",
|
|
44069
44372
|
tags: ["/workspaces"],
|
|
44070
44373
|
"x-fern-ignore": true,
|
|
44071
|
-
"x-response-key": null
|
|
44374
|
+
"x-response-key": null,
|
|
44375
|
+
"x-title": "Udpate a Workspace"
|
|
44072
44376
|
},
|
|
44073
44377
|
post: {
|
|
44378
|
+
description: "Updates the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.",
|
|
44074
44379
|
operationId: "workspacesUpdatePost",
|
|
44075
44380
|
requestBody: {
|
|
44076
44381
|
content: {
|
|
44077
44382
|
"application/json": {
|
|
44078
44383
|
schema: {
|
|
44079
44384
|
properties: {
|
|
44080
|
-
connect_partner_name: {
|
|
44385
|
+
connect_partner_name: {
|
|
44386
|
+
description: "Connect partner name for the workspace.",
|
|
44387
|
+
type: "string"
|
|
44388
|
+
},
|
|
44081
44389
|
connect_webview_customization: {
|
|
44390
|
+
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
44391
|
properties: {
|
|
44083
44392
|
logo_shape: {
|
|
44393
|
+
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
44394
|
enum: ["circle", "square"],
|
|
44085
44395
|
nullable: true,
|
|
44086
44396
|
type: "string"
|
|
44087
44397
|
},
|
|
44088
|
-
primary_button_color: {
|
|
44398
|
+
primary_button_color: {
|
|
44399
|
+
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).",
|
|
44400
|
+
nullable: true,
|
|
44401
|
+
type: "string"
|
|
44402
|
+
},
|
|
44089
44403
|
primary_button_text_color: {
|
|
44404
|
+
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
44405
|
nullable: true,
|
|
44091
44406
|
type: "string"
|
|
44092
44407
|
},
|
|
44093
|
-
success_message: {
|
|
44408
|
+
success_message: {
|
|
44409
|
+
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).",
|
|
44410
|
+
nullable: true,
|
|
44411
|
+
type: "string"
|
|
44412
|
+
}
|
|
44094
44413
|
},
|
|
44095
44414
|
type: "object"
|
|
44096
44415
|
},
|
|
44097
|
-
is_suspended: {
|
|
44098
|
-
|
|
44416
|
+
is_suspended: {
|
|
44417
|
+
description: "Indicates whether the workspace is suspended.",
|
|
44418
|
+
type: "boolean"
|
|
44419
|
+
},
|
|
44420
|
+
name: {
|
|
44421
|
+
description: "Name of the workspace.",
|
|
44422
|
+
type: "string"
|
|
44423
|
+
}
|
|
44099
44424
|
},
|
|
44100
44425
|
type: "object"
|
|
44101
44426
|
}
|
|
@@ -44116,7 +44441,8 @@ var openapi_default = {
|
|
|
44116
44441
|
tags: ["/workspaces"],
|
|
44117
44442
|
"x-fern-sdk-group-name": ["workspaces"],
|
|
44118
44443
|
"x-fern-sdk-method-name": "update",
|
|
44119
|
-
"x-response-key": null
|
|
44444
|
+
"x-response-key": null,
|
|
44445
|
+
"x-title": "Udpate a Workspace"
|
|
44120
44446
|
}
|
|
44121
44447
|
}
|
|
44122
44448
|
},
|