@seamapi/types 1.410.1 → 1.410.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +653 -304
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +447 -111
- package/lib/seam/connect/openapi.d.ts +254 -0
- package/lib/seam/connect/openapi.js +632 -283
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +193 -111
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +763 -294
- package/src/lib/seam/connect/route-types.ts +193 -111
|
@@ -20277,6 +20277,7 @@ export default {
|
|
|
20277
20277
|
},
|
|
20278
20278
|
security: [
|
|
20279
20279
|
{ client_session: [] },
|
|
20280
|
+
{ client_session_with_customer: [] },
|
|
20280
20281
|
{ pat_with_workspace: [] },
|
|
20281
20282
|
{ console_session_with_workspace: [] },
|
|
20282
20283
|
{ api_key: [] },
|
|
@@ -20409,6 +20410,7 @@ export default {
|
|
|
20409
20410
|
},
|
|
20410
20411
|
security: [
|
|
20411
20412
|
{ client_session: [] },
|
|
20413
|
+
{ client_session_with_customer: [] },
|
|
20412
20414
|
{ pat_with_workspace: [] },
|
|
20413
20415
|
{ console_session_with_workspace: [] },
|
|
20414
20416
|
{ api_key: [] },
|
|
@@ -20542,6 +20544,7 @@ export default {
|
|
|
20542
20544
|
},
|
|
20543
20545
|
security: [
|
|
20544
20546
|
{ client_session: [] },
|
|
20547
|
+
{ client_session_with_customer: [] },
|
|
20545
20548
|
{ pat_with_workspace: [] },
|
|
20546
20549
|
{ console_session_with_workspace: [] },
|
|
20547
20550
|
{ api_key: [] },
|
|
@@ -26751,6 +26754,7 @@ export default {
|
|
|
26751
26754
|
},
|
|
26752
26755
|
security: [
|
|
26753
26756
|
{ client_session: [] },
|
|
26757
|
+
{ client_session_with_customer: [] },
|
|
26754
26758
|
{ api_key: [] },
|
|
26755
26759
|
{ pat_with_workspace: [] },
|
|
26756
26760
|
{ console_session_with_workspace: [] },
|
|
@@ -27504,6 +27508,7 @@ export default {
|
|
|
27504
27508
|
{ api_key: [] },
|
|
27505
27509
|
{ pat_with_workspace: [] },
|
|
27506
27510
|
{ console_session_with_workspace: [] },
|
|
27511
|
+
{ client_session_with_customer: [] },
|
|
27507
27512
|
],
|
|
27508
27513
|
summary: '/devices/simulate/connect',
|
|
27509
27514
|
tags: ['/devices'],
|
|
@@ -27554,6 +27559,7 @@ export default {
|
|
|
27554
27559
|
{ api_key: [] },
|
|
27555
27560
|
{ pat_with_workspace: [] },
|
|
27556
27561
|
{ console_session_with_workspace: [] },
|
|
27562
|
+
{ client_session_with_customer: [] },
|
|
27557
27563
|
],
|
|
27558
27564
|
summary: '/devices/simulate/disconnect',
|
|
27559
27565
|
tags: ['/devices'],
|
|
@@ -27604,6 +27610,7 @@ export default {
|
|
|
27604
27610
|
{ api_key: [] },
|
|
27605
27611
|
{ pat_with_workspace: [] },
|
|
27606
27612
|
{ console_session_with_workspace: [] },
|
|
27613
|
+
{ client_session_with_customer: [] },
|
|
27607
27614
|
],
|
|
27608
27615
|
summary: '/devices/simulate/remove',
|
|
27609
27616
|
tags: ['/devices'],
|
|
@@ -28173,6 +28180,7 @@ export default {
|
|
|
28173
28180
|
{ pat_with_workspace: [] },
|
|
28174
28181
|
{ console_session_with_workspace: [] },
|
|
28175
28182
|
{ client_session: [] },
|
|
28183
|
+
{ client_session_with_customer: [] },
|
|
28176
28184
|
],
|
|
28177
28185
|
summary: '/devices/update',
|
|
28178
28186
|
tags: ['/devices'],
|
|
@@ -28252,6 +28260,7 @@ export default {
|
|
|
28252
28260
|
{ pat_with_workspace: [] },
|
|
28253
28261
|
{ console_session_with_workspace: [] },
|
|
28254
28262
|
{ client_session: [] },
|
|
28263
|
+
{ client_session_with_customer: [] },
|
|
28255
28264
|
],
|
|
28256
28265
|
summary: '/devices/update',
|
|
28257
28266
|
tags: ['/devices'],
|
|
@@ -28315,6 +28324,7 @@ export default {
|
|
|
28315
28324
|
{ api_key: [] },
|
|
28316
28325
|
{ pat_with_workspace: [] },
|
|
28317
28326
|
{ console_session_with_workspace: [] },
|
|
28327
|
+
{ client_session_with_customer: [] },
|
|
28318
28328
|
],
|
|
28319
28329
|
summary: '/events/get',
|
|
28320
28330
|
tags: ['/events'],
|
|
@@ -30108,7 +30118,7 @@ export default {
|
|
|
30108
30118
|
schema: {
|
|
30109
30119
|
properties: {
|
|
30110
30120
|
device_id: {
|
|
30111
|
-
description: 'Device ID of the
|
|
30121
|
+
description: 'Device ID of the phone that you want to deactivate.',
|
|
30112
30122
|
type: 'string',
|
|
30113
30123
|
},
|
|
30114
30124
|
},
|
|
@@ -30150,7 +30160,7 @@ export default {
|
|
|
30150
30160
|
},
|
|
30151
30161
|
'/phones/get': {
|
|
30152
30162
|
post: {
|
|
30153
|
-
description: 'Returns a
|
|
30163
|
+
description: 'Returns a specified [phone](https://docs.seam.co/latest/capability-guides/mobile-access/managing-phones-for-a-user-identity).',
|
|
30154
30164
|
operationId: 'phonesGetPost',
|
|
30155
30165
|
requestBody: {
|
|
30156
30166
|
content: {
|
|
@@ -30158,7 +30168,7 @@ export default {
|
|
|
30158
30168
|
schema: {
|
|
30159
30169
|
properties: {
|
|
30160
30170
|
device_id: {
|
|
30161
|
-
description: 'Device ID of the
|
|
30171
|
+
description: 'Device ID of the phone that you want to get.',
|
|
30162
30172
|
format: 'uuid',
|
|
30163
30173
|
type: 'string',
|
|
30164
30174
|
},
|
|
@@ -30199,12 +30209,12 @@ export default {
|
|
|
30199
30209
|
'x-fern-sdk-method-name': 'get',
|
|
30200
30210
|
'x-fern-sdk-return-value': 'phone',
|
|
30201
30211
|
'x-response-key': 'phone',
|
|
30202
|
-
'x-title': 'Get Phone',
|
|
30212
|
+
'x-title': 'Get a Phone',
|
|
30203
30213
|
},
|
|
30204
30214
|
},
|
|
30205
30215
|
'/phones/list': {
|
|
30206
30216
|
post: {
|
|
30207
|
-
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.',
|
|
30217
|
+
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.',
|
|
30208
30218
|
operationId: 'phonesListPost',
|
|
30209
30219
|
requestBody: {
|
|
30210
30220
|
content: {
|
|
@@ -30212,12 +30222,12 @@ export default {
|
|
|
30212
30222
|
schema: {
|
|
30213
30223
|
properties: {
|
|
30214
30224
|
acs_credential_id: {
|
|
30215
|
-
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.',
|
|
30225
|
+
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.',
|
|
30216
30226
|
format: 'uuid',
|
|
30217
30227
|
type: 'string',
|
|
30218
30228
|
},
|
|
30219
30229
|
owner_user_identity_id: {
|
|
30220
|
-
description: 'ID of the user identity that represents the owner by which to filter the list of returned phones.',
|
|
30230
|
+
description: 'ID of the user identity that represents the owner by which you want to filter the list of returned phones.',
|
|
30221
30231
|
format: 'uuid',
|
|
30222
30232
|
type: 'string',
|
|
30223
30233
|
},
|
|
@@ -30265,7 +30275,7 @@ export default {
|
|
|
30265
30275
|
},
|
|
30266
30276
|
'/phones/simulate/create_sandbox_phone': {
|
|
30267
30277
|
post: {
|
|
30268
|
-
description: 'Creates a new simulated phone in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).
|
|
30278
|
+
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).',
|
|
30269
30279
|
operationId: 'phonesSimulateCreateSandboxPhonePost',
|
|
30270
30280
|
requestBody: {
|
|
30271
30281
|
content: {
|
|
@@ -30274,7 +30284,7 @@ export default {
|
|
|
30274
30284
|
properties: {
|
|
30275
30285
|
assa_abloy_metadata: {
|
|
30276
30286
|
default: {},
|
|
30277
|
-
description: 'ASSA ABLOY metadata to associate with the simulated phone.',
|
|
30287
|
+
description: 'ASSA ABLOY metadata that you want to associate with the simulated phone.',
|
|
30278
30288
|
properties: {
|
|
30279
30289
|
application_version: {
|
|
30280
30290
|
default: '1.0.0',
|
|
@@ -30311,12 +30321,12 @@ export default {
|
|
|
30311
30321
|
type: 'object',
|
|
30312
30322
|
},
|
|
30313
30323
|
custom_sdk_installation_id: {
|
|
30314
|
-
description: 'ID of the custom SDK installation to use for the simulated phone.',
|
|
30324
|
+
description: 'ID of the custom SDK installation that you want to use for the simulated phone.',
|
|
30315
30325
|
type: 'string',
|
|
30316
30326
|
},
|
|
30317
30327
|
phone_metadata: {
|
|
30318
30328
|
default: {},
|
|
30319
|
-
description: 'Metadata to associate with the simulated phone.',
|
|
30329
|
+
description: 'Metadata that you want to associate with the simulated phone.',
|
|
30320
30330
|
properties: {
|
|
30321
30331
|
device_manufacturer: {
|
|
30322
30332
|
default: 'Samsung',
|
|
@@ -30343,7 +30353,7 @@ export default {
|
|
|
30343
30353
|
type: 'object',
|
|
30344
30354
|
},
|
|
30345
30355
|
user_identity_id: {
|
|
30346
|
-
description: 'ID of the user identity to associate with the simulated phone.',
|
|
30356
|
+
description: 'ID of the user identity that you want to associate with the simulated phone.',
|
|
30347
30357
|
format: 'uuid',
|
|
30348
30358
|
type: 'string',
|
|
30349
30359
|
},
|
|
@@ -30389,16 +30399,25 @@ export default {
|
|
|
30389
30399
|
},
|
|
30390
30400
|
'/seam/bridge/v1/bridge_client_sessions/create': {
|
|
30391
30401
|
post: {
|
|
30392
|
-
description: 'Creates a new bridge client session.',
|
|
30402
|
+
description: 'Creates a new [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.',
|
|
30393
30403
|
operationId: 'seamBridgeV1BridgeClientSessionsCreatePost',
|
|
30394
30404
|
requestBody: {
|
|
30395
30405
|
content: {
|
|
30396
30406
|
'application/json': {
|
|
30397
30407
|
schema: {
|
|
30398
30408
|
properties: {
|
|
30399
|
-
bridge_client_machine_identifier_key: {
|
|
30400
|
-
|
|
30401
|
-
|
|
30409
|
+
bridge_client_machine_identifier_key: {
|
|
30410
|
+
description: 'Identifier key of the client machine for the Seam Bridge client that you want to create.',
|
|
30411
|
+
type: 'string',
|
|
30412
|
+
},
|
|
30413
|
+
bridge_client_name: {
|
|
30414
|
+
description: 'Name of the Seam Bridge client that you want to create.',
|
|
30415
|
+
type: 'string',
|
|
30416
|
+
},
|
|
30417
|
+
bridge_client_time_zone: {
|
|
30418
|
+
description: 'Time zone for the Seam Bridge that you want to create.',
|
|
30419
|
+
type: 'string',
|
|
30420
|
+
},
|
|
30402
30421
|
},
|
|
30403
30422
|
required: [
|
|
30404
30423
|
'bridge_client_name',
|
|
@@ -30574,12 +30593,12 @@ export default {
|
|
|
30574
30593
|
'x-fern-sdk-return-value': 'bridge_client_session',
|
|
30575
30594
|
'x-response-key': 'bridge_client_session',
|
|
30576
30595
|
'x-title': 'Create a Bridge Client Session',
|
|
30577
|
-
'x-undocumented': 'Seam Bridge
|
|
30596
|
+
'x-undocumented': 'Seam Bridge client only.',
|
|
30578
30597
|
},
|
|
30579
30598
|
},
|
|
30580
30599
|
'/seam/bridge/v1/bridge_client_sessions/get': {
|
|
30581
30600
|
get: {
|
|
30582
|
-
description: 'Returns the bridge client session associated with the session token used.',
|
|
30601
|
+
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.',
|
|
30583
30602
|
operationId: 'seamBridgeV1BridgeClientSessionsGetGet',
|
|
30584
30603
|
responses: {
|
|
30585
30604
|
200: {
|
|
@@ -30737,11 +30756,11 @@ export default {
|
|
|
30737
30756
|
tags: [],
|
|
30738
30757
|
'x-fern-ignore': true,
|
|
30739
30758
|
'x-response-key': 'bridge_client_session',
|
|
30740
|
-
'x-title': 'Get a Bridge Client Session',
|
|
30759
|
+
'x-title': 'Get a Seam Bridge Client Session',
|
|
30741
30760
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
30742
30761
|
},
|
|
30743
30762
|
post: {
|
|
30744
|
-
description: 'Returns the bridge client session associated with the session token used.',
|
|
30763
|
+
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.',
|
|
30745
30764
|
operationId: 'seamBridgeV1BridgeClientSessionsGetPost',
|
|
30746
30765
|
responses: {
|
|
30747
30766
|
200: {
|
|
@@ -30906,13 +30925,13 @@ export default {
|
|
|
30906
30925
|
'x-fern-sdk-method-name': 'get',
|
|
30907
30926
|
'x-fern-sdk-return-value': 'bridge_client_session',
|
|
30908
30927
|
'x-response-key': 'bridge_client_session',
|
|
30909
|
-
'x-title': 'Get a Bridge Client Session',
|
|
30928
|
+
'x-title': 'Get a Seam Bridge Client Session',
|
|
30910
30929
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
30911
30930
|
},
|
|
30912
30931
|
},
|
|
30913
30932
|
'/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token': {
|
|
30914
30933
|
post: {
|
|
30915
|
-
description: 'Returns the bridge client session associated with the session token and refreshed telemetry token.',
|
|
30934
|
+
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.',
|
|
30916
30935
|
operationId: 'seamBridgeV1BridgeClientSessionsRefreshTelemetryTokenPost',
|
|
30917
30936
|
responses: {
|
|
30918
30937
|
200: {
|
|
@@ -31077,13 +31096,13 @@ export default {
|
|
|
31077
31096
|
'x-fern-sdk-method-name': 'refresh_telemetry_token',
|
|
31078
31097
|
'x-fern-sdk-return-value': 'bridge_client_session',
|
|
31079
31098
|
'x-response-key': 'bridge_client_session',
|
|
31080
|
-
'x-title': 'Refresh
|
|
31099
|
+
'x-title': 'Refresh the Telemetry Token for a Seam Bridge Client Session',
|
|
31081
31100
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
31082
31101
|
},
|
|
31083
31102
|
},
|
|
31084
31103
|
'/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code': {
|
|
31085
31104
|
post: {
|
|
31086
|
-
description: 'Generate a new pairing code and return the updated bridge client session.',
|
|
31105
|
+
description: 'Generate a new pairing code and return the updated [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.',
|
|
31087
31106
|
operationId: 'seamBridgeV1BridgeClientSessionsRegeneratePairingCodePost',
|
|
31088
31107
|
responses: {
|
|
31089
31108
|
200: {
|
|
@@ -31248,21 +31267,29 @@ export default {
|
|
|
31248
31267
|
'x-fern-sdk-method-name': 'regenerate_pairing_code',
|
|
31249
31268
|
'x-fern-sdk-return-value': 'bridge_client_session',
|
|
31250
31269
|
'x-response-key': 'bridge_client_session',
|
|
31251
|
-
'x-title': 'Regenerate a Bridge Client Session Pairing Code',
|
|
31270
|
+
'x-title': 'Regenerate a Seam Bridge Client Session Pairing Code',
|
|
31252
31271
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
31253
31272
|
},
|
|
31254
31273
|
},
|
|
31255
31274
|
'/seam/bridge/v1/bridge_client_sessions/report_status': {
|
|
31256
31275
|
post: {
|
|
31257
|
-
description:
|
|
31276
|
+
description: 'Report the status of a [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client.',
|
|
31258
31277
|
operationId: 'seamBridgeV1BridgeClientSessionsReportStatusPost',
|
|
31259
31278
|
requestBody: {
|
|
31260
31279
|
content: {
|
|
31261
31280
|
'application/json': {
|
|
31262
31281
|
schema: {
|
|
31263
31282
|
properties: {
|
|
31264
|
-
is_tailscale_connected: {
|
|
31265
|
-
|
|
31283
|
+
is_tailscale_connected: {
|
|
31284
|
+
description: 'Indicates whether Tailscale is connected.',
|
|
31285
|
+
nullable: true,
|
|
31286
|
+
type: 'boolean',
|
|
31287
|
+
},
|
|
31288
|
+
tailscale_ip_v4: {
|
|
31289
|
+
description: 'Tailscale IPv4 address.',
|
|
31290
|
+
nullable: true,
|
|
31291
|
+
type: 'string',
|
|
31292
|
+
},
|
|
31266
31293
|
},
|
|
31267
31294
|
required: ['is_tailscale_connected', 'tailscale_ip_v4'],
|
|
31268
31295
|
type: 'object',
|
|
@@ -31297,13 +31324,13 @@ export default {
|
|
|
31297
31324
|
],
|
|
31298
31325
|
'x-fern-sdk-method-name': 'report_status',
|
|
31299
31326
|
'x-response-key': null,
|
|
31300
|
-
'x-title':
|
|
31327
|
+
'x-title': 'Report the Status of a Seam Bridge Client',
|
|
31301
31328
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
31302
31329
|
},
|
|
31303
31330
|
},
|
|
31304
31331
|
'/seam/bridge/v1/bridge_connected_systems/list': {
|
|
31305
31332
|
get: {
|
|
31306
|
-
description: 'Returns the bridge
|
|
31333
|
+
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.',
|
|
31307
31334
|
operationId: 'seamBridgeV1BridgeConnectedSystemsListGet',
|
|
31308
31335
|
responses: {
|
|
31309
31336
|
200: {
|
|
@@ -31365,11 +31392,11 @@ export default {
|
|
|
31365
31392
|
tags: [],
|
|
31366
31393
|
'x-fern-ignore': true,
|
|
31367
31394
|
'x-response-key': 'bridge_connected_systems',
|
|
31368
|
-
'x-title': 'List Bridge
|
|
31395
|
+
'x-title': 'List Bridge-Connected Systems',
|
|
31369
31396
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
31370
31397
|
},
|
|
31371
31398
|
post: {
|
|
31372
|
-
description: 'Returns the bridge
|
|
31399
|
+
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.',
|
|
31373
31400
|
operationId: 'seamBridgeV1BridgeConnectedSystemsListPost',
|
|
31374
31401
|
responses: {
|
|
31375
31402
|
200: {
|
|
@@ -31438,13 +31465,13 @@ export default {
|
|
|
31438
31465
|
'x-fern-sdk-method-name': 'list',
|
|
31439
31466
|
'x-fern-sdk-return-value': 'bridge_connected_systems',
|
|
31440
31467
|
'x-response-key': 'bridge_connected_systems',
|
|
31441
|
-
'x-title': 'List Bridge
|
|
31468
|
+
'x-title': 'List Bridge-Connected Systems',
|
|
31442
31469
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
31443
31470
|
},
|
|
31444
31471
|
},
|
|
31445
31472
|
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
31446
31473
|
post: {
|
|
31447
|
-
description: 'Exchanges a short code for a
|
|
31474
|
+
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.',
|
|
31448
31475
|
operationId: 'seamInstantKeyV1ClientSessionsExchangeShortCodePost',
|
|
31449
31476
|
requestBody: {
|
|
31450
31477
|
content: {
|
|
@@ -31452,7 +31479,7 @@ export default {
|
|
|
31452
31479
|
schema: {
|
|
31453
31480
|
properties: {
|
|
31454
31481
|
short_code: {
|
|
31455
|
-
description: '
|
|
31482
|
+
description: 'Short code that you want to exchange for a client session token.',
|
|
31456
31483
|
type: 'string',
|
|
31457
31484
|
},
|
|
31458
31485
|
},
|
|
@@ -31501,7 +31528,7 @@ export default {
|
|
|
31501
31528
|
},
|
|
31502
31529
|
'/seam/mobile_sdk/v1/acs/credentials/list': {
|
|
31503
31530
|
post: {
|
|
31504
|
-
description: 'Returns a list of all
|
|
31531
|
+
description: 'Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
31505
31532
|
operationId: 'seamMobileSdkV1AcsCredentialsListPost',
|
|
31506
31533
|
requestBody: {
|
|
31507
31534
|
content: {
|
|
@@ -31549,15 +31576,19 @@ export default {
|
|
|
31549
31576
|
},
|
|
31550
31577
|
'/seam/mobile_sdk/v1/phone_sessions/get_or_create': {
|
|
31551
31578
|
post: {
|
|
31552
|
-
description: '
|
|
31579
|
+
description: 'Gets or creates a session for a mobile SDK phone.',
|
|
31553
31580
|
operationId: 'seamMobileSdkV1PhoneSessionsGetOrCreatePost',
|
|
31554
31581
|
requestBody: {
|
|
31555
31582
|
content: {
|
|
31556
31583
|
'application/json': {
|
|
31557
31584
|
schema: {
|
|
31558
31585
|
properties: {
|
|
31559
|
-
custom_sdk_installation_id: {
|
|
31586
|
+
custom_sdk_installation_id: {
|
|
31587
|
+
description: 'ID of the custom SDK installation that you want to use for the new session.',
|
|
31588
|
+
type: 'string',
|
|
31589
|
+
},
|
|
31560
31590
|
phone_device_metadata: {
|
|
31591
|
+
description: 'Phone device metadata that you want to use for the new session.',
|
|
31561
31592
|
properties: {
|
|
31562
31593
|
manufacturer: { type: 'string' },
|
|
31563
31594
|
model: { type: 'string' },
|
|
@@ -31565,7 +31596,11 @@ export default {
|
|
|
31565
31596
|
},
|
|
31566
31597
|
type: 'object',
|
|
31567
31598
|
},
|
|
31568
|
-
phone_os: {
|
|
31599
|
+
phone_os: {
|
|
31600
|
+
description: 'Phone operating system that you want to use for the new session.',
|
|
31601
|
+
enum: ['ios', 'android'],
|
|
31602
|
+
type: 'string',
|
|
31603
|
+
},
|
|
31569
31604
|
},
|
|
31570
31605
|
required: ['custom_sdk_installation_id', 'phone_os'],
|
|
31571
31606
|
type: 'object',
|
|
@@ -31607,13 +31642,18 @@ export default {
|
|
|
31607
31642
|
},
|
|
31608
31643
|
'/seam/partner/v1/building_blocks/spaces/auto_map': {
|
|
31609
31644
|
post: {
|
|
31610
|
-
description: 'Auto
|
|
31645
|
+
description: 'Auto-maps partner resources that have been pushed to Seam.',
|
|
31611
31646
|
operationId: 'seamPartnerV1BuildingBlocksSpacesAutoMapPost',
|
|
31612
31647
|
requestBody: {
|
|
31613
31648
|
content: {
|
|
31614
31649
|
'application/json': {
|
|
31615
31650
|
schema: {
|
|
31616
|
-
properties: {
|
|
31651
|
+
properties: {
|
|
31652
|
+
collection_key: {
|
|
31653
|
+
description: 'Collection key.',
|
|
31654
|
+
type: 'string',
|
|
31655
|
+
},
|
|
31656
|
+
},
|
|
31617
31657
|
required: ['collection_key'],
|
|
31618
31658
|
type: 'object',
|
|
31619
31659
|
},
|
|
@@ -31694,13 +31734,13 @@ export default {
|
|
|
31694
31734
|
'x-fern-sdk-method-name': 'auto_map',
|
|
31695
31735
|
'x-fern-sdk-return-value': 'spaces',
|
|
31696
31736
|
'x-response-key': 'spaces',
|
|
31697
|
-
'x-title': 'Do
|
|
31737
|
+
'x-title': 'Do Auto-Mapping for Partner Resources that Map to Spaces',
|
|
31698
31738
|
'x-undocumented': 'Partner building blocks/UI only.',
|
|
31699
31739
|
},
|
|
31700
31740
|
},
|
|
31701
31741
|
'/seam/partner/v1/resources/list': {
|
|
31702
31742
|
post: {
|
|
31703
|
-
description: '
|
|
31743
|
+
description: 'Lists partner resources that have been pushed to Seam.',
|
|
31704
31744
|
operationId: 'seamPartnerV1ResourcesListPost',
|
|
31705
31745
|
requestBody: {
|
|
31706
31746
|
content: {
|
|
@@ -31708,7 +31748,7 @@ export default {
|
|
|
31708
31748
|
schema: {
|
|
31709
31749
|
properties: {
|
|
31710
31750
|
resource_type_alias: {
|
|
31711
|
-
description: '
|
|
31751
|
+
description: 'Resource type alias by which you want to filter partner resources.',
|
|
31712
31752
|
type: 'string',
|
|
31713
31753
|
},
|
|
31714
31754
|
},
|
|
@@ -31775,13 +31815,13 @@ export default {
|
|
|
31775
31815
|
'x-fern-sdk-method-name': 'list',
|
|
31776
31816
|
'x-fern-sdk-return-value': 'partner_resources',
|
|
31777
31817
|
'x-response-key': 'partner_resources',
|
|
31778
|
-
'x-title': 'List
|
|
31818
|
+
'x-title': 'List Partner Resources at Seam',
|
|
31779
31819
|
'x-undocumented': 'Partner building blocks/UI only.',
|
|
31780
31820
|
},
|
|
31781
31821
|
},
|
|
31782
31822
|
'/spaces/add_acs_entrances': {
|
|
31783
31823
|
post: {
|
|
31784
|
-
description: '
|
|
31824
|
+
description: 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.',
|
|
31785
31825
|
operationId: 'spacesAddAcsEntrancesPost',
|
|
31786
31826
|
requestBody: {
|
|
31787
31827
|
content: {
|
|
@@ -31789,11 +31829,16 @@ export default {
|
|
|
31789
31829
|
schema: {
|
|
31790
31830
|
properties: {
|
|
31791
31831
|
acs_entrance_ids: {
|
|
31832
|
+
description: 'IDs of the entrances that you want to add to the space.',
|
|
31792
31833
|
items: { format: 'uuid', type: 'string' },
|
|
31793
31834
|
minItems: 1,
|
|
31794
31835
|
type: 'array',
|
|
31795
31836
|
},
|
|
31796
|
-
space_id: {
|
|
31837
|
+
space_id: {
|
|
31838
|
+
description: 'ID of the space to which you want to add entrances.',
|
|
31839
|
+
format: 'uuid',
|
|
31840
|
+
type: 'string',
|
|
31841
|
+
},
|
|
31797
31842
|
},
|
|
31798
31843
|
required: ['space_id', 'acs_entrance_ids'],
|
|
31799
31844
|
type: 'object',
|
|
@@ -31828,10 +31873,10 @@ export default {
|
|
|
31828
31873
|
'x-fern-sdk-group-name': ['spaces'],
|
|
31829
31874
|
'x-fern-sdk-method-name': 'add_acs_entrances',
|
|
31830
31875
|
'x-response-key': null,
|
|
31831
|
-
'x-title': 'Add
|
|
31876
|
+
'x-title': 'Add Entrances to a Space',
|
|
31832
31877
|
},
|
|
31833
31878
|
put: {
|
|
31834
|
-
description: '
|
|
31879
|
+
description: 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific space.',
|
|
31835
31880
|
operationId: 'spacesAddAcsEntrancesPut',
|
|
31836
31881
|
requestBody: {
|
|
31837
31882
|
content: {
|
|
@@ -31839,11 +31884,16 @@ export default {
|
|
|
31839
31884
|
schema: {
|
|
31840
31885
|
properties: {
|
|
31841
31886
|
acs_entrance_ids: {
|
|
31887
|
+
description: 'IDs of the entrances that you want to add to the space.',
|
|
31842
31888
|
items: { format: 'uuid', type: 'string' },
|
|
31843
31889
|
minItems: 1,
|
|
31844
31890
|
type: 'array',
|
|
31845
31891
|
},
|
|
31846
|
-
space_id: {
|
|
31892
|
+
space_id: {
|
|
31893
|
+
description: 'ID of the space to which you want to add entrances.',
|
|
31894
|
+
format: 'uuid',
|
|
31895
|
+
type: 'string',
|
|
31896
|
+
},
|
|
31847
31897
|
},
|
|
31848
31898
|
required: ['space_id', 'acs_entrance_ids'],
|
|
31849
31899
|
type: 'object',
|
|
@@ -31877,12 +31927,12 @@ export default {
|
|
|
31877
31927
|
'x-draft': 'Early access.',
|
|
31878
31928
|
'x-fern-ignore': true,
|
|
31879
31929
|
'x-response-key': null,
|
|
31880
|
-
'x-title': 'Add
|
|
31930
|
+
'x-title': 'Add Entrances to a Space',
|
|
31881
31931
|
},
|
|
31882
31932
|
},
|
|
31883
31933
|
'/spaces/add_devices': {
|
|
31884
31934
|
post: {
|
|
31885
|
-
description: '
|
|
31935
|
+
description: 'Adds devices to a specific space.',
|
|
31886
31936
|
operationId: 'spacesAddDevicesPost',
|
|
31887
31937
|
requestBody: {
|
|
31888
31938
|
content: {
|
|
@@ -31890,11 +31940,16 @@ export default {
|
|
|
31890
31940
|
schema: {
|
|
31891
31941
|
properties: {
|
|
31892
31942
|
device_ids: {
|
|
31943
|
+
description: 'IDs of the devices that you want to add to the space.',
|
|
31893
31944
|
items: { format: 'uuid', type: 'string' },
|
|
31894
31945
|
minItems: 1,
|
|
31895
31946
|
type: 'array',
|
|
31896
31947
|
},
|
|
31897
|
-
space_id: {
|
|
31948
|
+
space_id: {
|
|
31949
|
+
description: 'ID of the space to which you want to add devices.',
|
|
31950
|
+
format: 'uuid',
|
|
31951
|
+
type: 'string',
|
|
31952
|
+
},
|
|
31898
31953
|
},
|
|
31899
31954
|
required: ['space_id', 'device_ids'],
|
|
31900
31955
|
type: 'object',
|
|
@@ -31929,10 +31984,10 @@ export default {
|
|
|
31929
31984
|
'x-fern-sdk-group-name': ['spaces'],
|
|
31930
31985
|
'x-fern-sdk-method-name': 'add_devices',
|
|
31931
31986
|
'x-response-key': null,
|
|
31932
|
-
'x-title': 'Add Space
|
|
31987
|
+
'x-title': 'Add Devices to a Space',
|
|
31933
31988
|
},
|
|
31934
31989
|
put: {
|
|
31935
|
-
description: '
|
|
31990
|
+
description: 'Adds devices to a specific space.',
|
|
31936
31991
|
operationId: 'spacesAddDevicesPut',
|
|
31937
31992
|
requestBody: {
|
|
31938
31993
|
content: {
|
|
@@ -31940,11 +31995,16 @@ export default {
|
|
|
31940
31995
|
schema: {
|
|
31941
31996
|
properties: {
|
|
31942
31997
|
device_ids: {
|
|
31998
|
+
description: 'IDs of the devices that you want to add to the space.',
|
|
31943
31999
|
items: { format: 'uuid', type: 'string' },
|
|
31944
32000
|
minItems: 1,
|
|
31945
32001
|
type: 'array',
|
|
31946
32002
|
},
|
|
31947
|
-
space_id: {
|
|
32003
|
+
space_id: {
|
|
32004
|
+
description: 'ID of the space to which you want to add devices.',
|
|
32005
|
+
format: 'uuid',
|
|
32006
|
+
type: 'string',
|
|
32007
|
+
},
|
|
31948
32008
|
},
|
|
31949
32009
|
required: ['space_id', 'device_ids'],
|
|
31950
32010
|
type: 'object',
|
|
@@ -31978,12 +32038,12 @@ export default {
|
|
|
31978
32038
|
'x-draft': 'Early access.',
|
|
31979
32039
|
'x-fern-ignore': true,
|
|
31980
32040
|
'x-response-key': null,
|
|
31981
|
-
'x-title': 'Add Space
|
|
32041
|
+
'x-title': 'Add Devices to a Space',
|
|
31982
32042
|
},
|
|
31983
32043
|
},
|
|
31984
32044
|
'/spaces/create': {
|
|
31985
32045
|
post: {
|
|
31986
|
-
description: '
|
|
32046
|
+
description: 'Creates a new space.',
|
|
31987
32047
|
operationId: 'spacesCreatePost',
|
|
31988
32048
|
requestBody: {
|
|
31989
32049
|
content: {
|
|
@@ -31991,14 +32051,19 @@ export default {
|
|
|
31991
32051
|
schema: {
|
|
31992
32052
|
properties: {
|
|
31993
32053
|
acs_entrance_ids: {
|
|
32054
|
+
description: 'IDs of the entrances that you want to add to the new space.',
|
|
31994
32055
|
items: { format: 'uuid', type: 'string' },
|
|
31995
32056
|
type: 'array',
|
|
31996
32057
|
},
|
|
31997
32058
|
device_ids: {
|
|
32059
|
+
description: 'IDs of the devices that you want to add to the new space.',
|
|
31998
32060
|
items: { format: 'uuid', type: 'string' },
|
|
31999
32061
|
type: 'array',
|
|
32000
32062
|
},
|
|
32001
|
-
name: {
|
|
32063
|
+
name: {
|
|
32064
|
+
description: 'Name of the space that you want to create.',
|
|
32065
|
+
type: 'string',
|
|
32066
|
+
},
|
|
32002
32067
|
},
|
|
32003
32068
|
required: ['name'],
|
|
32004
32069
|
type: 'object',
|
|
@@ -32037,18 +32102,24 @@ export default {
|
|
|
32037
32102
|
'x-fern-sdk-method-name': 'create',
|
|
32038
32103
|
'x-fern-sdk-return-value': 'space',
|
|
32039
32104
|
'x-response-key': 'space',
|
|
32040
|
-
'x-title': 'Create Space',
|
|
32105
|
+
'x-title': 'Create a Space',
|
|
32041
32106
|
},
|
|
32042
32107
|
},
|
|
32043
32108
|
'/spaces/delete': {
|
|
32044
32109
|
post: {
|
|
32045
|
-
description: '
|
|
32110
|
+
description: 'Deletes a space.',
|
|
32046
32111
|
operationId: 'spacesDeletePost',
|
|
32047
32112
|
requestBody: {
|
|
32048
32113
|
content: {
|
|
32049
32114
|
'application/json': {
|
|
32050
32115
|
schema: {
|
|
32051
|
-
properties: {
|
|
32116
|
+
properties: {
|
|
32117
|
+
space_id: {
|
|
32118
|
+
description: 'ID of the space that you want to delete.',
|
|
32119
|
+
format: 'uuid',
|
|
32120
|
+
type: 'string',
|
|
32121
|
+
},
|
|
32122
|
+
},
|
|
32052
32123
|
required: ['space_id'],
|
|
32053
32124
|
type: 'object',
|
|
32054
32125
|
},
|
|
@@ -32078,21 +32149,28 @@ export default {
|
|
|
32078
32149
|
],
|
|
32079
32150
|
summary: '/spaces/delete',
|
|
32080
32151
|
tags: [],
|
|
32152
|
+
'x-draft': 'Early access.',
|
|
32081
32153
|
'x-fern-sdk-group-name': ['spaces'],
|
|
32082
32154
|
'x-fern-sdk-method-name': 'delete',
|
|
32083
32155
|
'x-response-key': null,
|
|
32084
|
-
'x-title': 'Delete Space',
|
|
32156
|
+
'x-title': 'Delete a Space',
|
|
32085
32157
|
},
|
|
32086
32158
|
},
|
|
32087
32159
|
'/spaces/get': {
|
|
32088
32160
|
post: {
|
|
32089
|
-
description: '
|
|
32161
|
+
description: 'Gets a space.',
|
|
32090
32162
|
operationId: 'spacesGetPost',
|
|
32091
32163
|
requestBody: {
|
|
32092
32164
|
content: {
|
|
32093
32165
|
'application/json': {
|
|
32094
32166
|
schema: {
|
|
32095
|
-
properties: {
|
|
32167
|
+
properties: {
|
|
32168
|
+
space_id: {
|
|
32169
|
+
description: 'ID of the space that you want to get.',
|
|
32170
|
+
format: 'uuid',
|
|
32171
|
+
type: 'string',
|
|
32172
|
+
},
|
|
32173
|
+
},
|
|
32096
32174
|
required: ['space_id'],
|
|
32097
32175
|
type: 'object',
|
|
32098
32176
|
},
|
|
@@ -32125,11 +32203,12 @@ export default {
|
|
|
32125
32203
|
],
|
|
32126
32204
|
summary: '/spaces/get',
|
|
32127
32205
|
tags: [],
|
|
32206
|
+
'x-draft': 'Early access.',
|
|
32128
32207
|
'x-fern-sdk-group-name': ['spaces'],
|
|
32129
32208
|
'x-fern-sdk-method-name': 'get',
|
|
32130
32209
|
'x-fern-sdk-return-value': 'space',
|
|
32131
32210
|
'x-response-key': 'space',
|
|
32132
|
-
'x-title': 'Get Space',
|
|
32211
|
+
'x-title': 'Get a Space',
|
|
32133
32212
|
},
|
|
32134
32213
|
},
|
|
32135
32214
|
'/spaces/list': {
|
|
@@ -32212,7 +32291,7 @@ export default {
|
|
|
32212
32291
|
},
|
|
32213
32292
|
'/spaces/remove_acs_entrances': {
|
|
32214
32293
|
post: {
|
|
32215
|
-
description: '
|
|
32294
|
+
description: 'Removes [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) from a specific space.',
|
|
32216
32295
|
operationId: 'spacesRemoveAcsEntrancesPost',
|
|
32217
32296
|
requestBody: {
|
|
32218
32297
|
content: {
|
|
@@ -32220,10 +32299,15 @@ export default {
|
|
|
32220
32299
|
schema: {
|
|
32221
32300
|
properties: {
|
|
32222
32301
|
acs_entrance_ids: {
|
|
32302
|
+
description: 'IDs of the entrances that you want to remove from the space.',
|
|
32223
32303
|
items: { format: 'uuid', type: 'string' },
|
|
32224
32304
|
type: 'array',
|
|
32225
32305
|
},
|
|
32226
|
-
space_id: {
|
|
32306
|
+
space_id: {
|
|
32307
|
+
description: 'ID of the space from which you want to remove entrances.',
|
|
32308
|
+
format: 'uuid',
|
|
32309
|
+
type: 'string',
|
|
32310
|
+
},
|
|
32227
32311
|
},
|
|
32228
32312
|
required: ['space_id', 'acs_entrance_ids'],
|
|
32229
32313
|
type: 'object',
|
|
@@ -32258,12 +32342,12 @@ export default {
|
|
|
32258
32342
|
'x-fern-sdk-group-name': ['spaces'],
|
|
32259
32343
|
'x-fern-sdk-method-name': 'remove_acs_entrances',
|
|
32260
32344
|
'x-response-key': null,
|
|
32261
|
-
'x-title': 'Remove
|
|
32345
|
+
'x-title': 'Remove Entrances from a Space',
|
|
32262
32346
|
},
|
|
32263
32347
|
},
|
|
32264
32348
|
'/spaces/remove_devices': {
|
|
32265
32349
|
post: {
|
|
32266
|
-
description: '
|
|
32350
|
+
description: 'Removes devices from a specific space.',
|
|
32267
32351
|
operationId: 'spacesRemoveDevicesPost',
|
|
32268
32352
|
requestBody: {
|
|
32269
32353
|
content: {
|
|
@@ -32271,10 +32355,15 @@ export default {
|
|
|
32271
32355
|
schema: {
|
|
32272
32356
|
properties: {
|
|
32273
32357
|
device_ids: {
|
|
32358
|
+
description: 'IDs of the devices that you want to remove from the space.',
|
|
32274
32359
|
items: { format: 'uuid', type: 'string' },
|
|
32275
32360
|
type: 'array',
|
|
32276
32361
|
},
|
|
32277
|
-
space_id: {
|
|
32362
|
+
space_id: {
|
|
32363
|
+
description: 'ID of the space from which you want to remove devices.',
|
|
32364
|
+
format: 'uuid',
|
|
32365
|
+
type: 'string',
|
|
32366
|
+
},
|
|
32278
32367
|
},
|
|
32279
32368
|
required: ['space_id', 'device_ids'],
|
|
32280
32369
|
type: 'object',
|
|
@@ -32309,20 +32398,24 @@ export default {
|
|
|
32309
32398
|
'x-fern-sdk-group-name': ['spaces'],
|
|
32310
32399
|
'x-fern-sdk-method-name': 'remove_devices',
|
|
32311
32400
|
'x-response-key': null,
|
|
32312
|
-
'x-title': 'Remove Space
|
|
32401
|
+
'x-title': 'Remove Devices from a Space',
|
|
32313
32402
|
},
|
|
32314
32403
|
},
|
|
32315
32404
|
'/spaces/update': {
|
|
32316
32405
|
patch: {
|
|
32317
|
-
description: '
|
|
32406
|
+
description: 'Updates an existing space.',
|
|
32318
32407
|
operationId: 'spacesUpdatePatch',
|
|
32319
32408
|
requestBody: {
|
|
32320
32409
|
content: {
|
|
32321
32410
|
'application/json': {
|
|
32322
32411
|
schema: {
|
|
32323
32412
|
properties: {
|
|
32324
|
-
name: { type: 'string' },
|
|
32325
|
-
space_id: {
|
|
32413
|
+
name: { description: 'Name of the space.', type: 'string' },
|
|
32414
|
+
space_id: {
|
|
32415
|
+
description: 'ID of the space that you want to update.',
|
|
32416
|
+
format: 'uuid',
|
|
32417
|
+
type: 'string',
|
|
32418
|
+
},
|
|
32326
32419
|
},
|
|
32327
32420
|
required: ['space_id'],
|
|
32328
32421
|
type: 'object',
|
|
@@ -32359,18 +32452,22 @@ export default {
|
|
|
32359
32452
|
'x-draft': 'Early access.',
|
|
32360
32453
|
'x-fern-ignore': true,
|
|
32361
32454
|
'x-response-key': 'space',
|
|
32362
|
-
'x-title': 'Update Space',
|
|
32455
|
+
'x-title': 'Update a Space',
|
|
32363
32456
|
},
|
|
32364
32457
|
post: {
|
|
32365
|
-
description: '
|
|
32458
|
+
description: 'Updates an existing space.',
|
|
32366
32459
|
operationId: 'spacesUpdatePost',
|
|
32367
32460
|
requestBody: {
|
|
32368
32461
|
content: {
|
|
32369
32462
|
'application/json': {
|
|
32370
32463
|
schema: {
|
|
32371
32464
|
properties: {
|
|
32372
|
-
name: { type: 'string' },
|
|
32373
|
-
space_id: {
|
|
32465
|
+
name: { description: 'Name of the space.', type: 'string' },
|
|
32466
|
+
space_id: {
|
|
32467
|
+
description: 'ID of the space that you want to update.',
|
|
32468
|
+
format: 'uuid',
|
|
32469
|
+
type: 'string',
|
|
32470
|
+
},
|
|
32374
32471
|
},
|
|
32375
32472
|
required: ['space_id'],
|
|
32376
32473
|
type: 'object',
|
|
@@ -32409,7 +32506,7 @@ export default {
|
|
|
32409
32506
|
'x-fern-sdk-method-name': 'update',
|
|
32410
32507
|
'x-fern-sdk-return-value': 'space',
|
|
32411
32508
|
'x-response-key': 'space',
|
|
32412
|
-
'x-title': 'Update Space',
|
|
32509
|
+
'x-title': 'Update a Space',
|
|
32413
32510
|
},
|
|
32414
32511
|
},
|
|
32415
32512
|
'/thermostats/activate_climate_preset': {
|
|
@@ -32483,12 +32580,12 @@ export default {
|
|
|
32483
32580
|
schema: {
|
|
32484
32581
|
properties: {
|
|
32485
32582
|
cooling_set_point_celsius: {
|
|
32486
|
-
description: '
|
|
32583
|
+
description: '[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.',
|
|
32487
32584
|
format: 'float',
|
|
32488
32585
|
type: 'number',
|
|
32489
32586
|
},
|
|
32490
32587
|
cooling_set_point_fahrenheit: {
|
|
32491
|
-
description: '
|
|
32588
|
+
description: '[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.',
|
|
32492
32589
|
format: 'float',
|
|
32493
32590
|
type: 'number',
|
|
32494
32591
|
},
|
|
@@ -32646,7 +32743,7 @@ export default {
|
|
|
32646
32743
|
},
|
|
32647
32744
|
'/thermostats/daily_programs/create': {
|
|
32648
32745
|
post: {
|
|
32649
|
-
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.',
|
|
32746
|
+
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.',
|
|
32650
32747
|
operationId: 'thermostatsDailyProgramsCreatePost',
|
|
32651
32748
|
requestBody: {
|
|
32652
32749
|
content: {
|
|
@@ -32659,7 +32756,7 @@ export default {
|
|
|
32659
32756
|
type: 'string',
|
|
32660
32757
|
},
|
|
32661
32758
|
name: {
|
|
32662
|
-
description: '
|
|
32759
|
+
description: 'Name of the thermostat daily program.',
|
|
32663
32760
|
type: 'string',
|
|
32664
32761
|
},
|
|
32665
32762
|
periods: {
|
|
@@ -32843,7 +32940,7 @@ export default {
|
|
|
32843
32940
|
schema: {
|
|
32844
32941
|
properties: {
|
|
32845
32942
|
name: {
|
|
32846
|
-
description: '
|
|
32943
|
+
description: 'Name of the thermostat daily program that you want to update.',
|
|
32847
32944
|
type: 'string',
|
|
32848
32945
|
},
|
|
32849
32946
|
periods: {
|
|
@@ -32921,7 +33018,7 @@ export default {
|
|
|
32921
33018
|
schema: {
|
|
32922
33019
|
properties: {
|
|
32923
33020
|
name: {
|
|
32924
|
-
description: '
|
|
33021
|
+
description: 'Name of the thermostat daily program that you want to update.',
|
|
32925
33022
|
type: 'string',
|
|
32926
33023
|
},
|
|
32927
33024
|
periods: {
|
|
@@ -33050,7 +33147,7 @@ export default {
|
|
|
33050
33147
|
},
|
|
33051
33148
|
'/thermostats/get': {
|
|
33052
33149
|
post: {
|
|
33053
|
-
description: 'Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
|
|
33150
|
+
description: 'Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). **Deprecated:** Will be removed. Use `/devices/get` instead.',
|
|
33054
33151
|
operationId: 'thermostatsGetPost',
|
|
33055
33152
|
requestBody: {
|
|
33056
33153
|
content: {
|
|
@@ -33058,12 +33155,12 @@ export default {
|
|
|
33058
33155
|
schema: {
|
|
33059
33156
|
properties: {
|
|
33060
33157
|
device_id: {
|
|
33061
|
-
description: 'ID of the thermostat device that you want to
|
|
33158
|
+
description: 'ID of the thermostat device that you want to get.',
|
|
33062
33159
|
format: 'uuid',
|
|
33063
33160
|
type: 'string',
|
|
33064
33161
|
},
|
|
33065
33162
|
name: {
|
|
33066
|
-
description: '
|
|
33163
|
+
description: 'Name of the thermostat device that you want to retrieve.',
|
|
33067
33164
|
type: 'string',
|
|
33068
33165
|
},
|
|
33069
33166
|
},
|
|
@@ -33123,12 +33220,12 @@ export default {
|
|
|
33123
33220
|
type: 'string',
|
|
33124
33221
|
},
|
|
33125
33222
|
heating_set_point_celsius: {
|
|
33126
|
-
description: '
|
|
33223
|
+
description: '[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.',
|
|
33127
33224
|
format: 'float',
|
|
33128
33225
|
type: 'number',
|
|
33129
33226
|
},
|
|
33130
33227
|
heating_set_point_fahrenheit: {
|
|
33131
|
-
description: '
|
|
33228
|
+
description: '[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.',
|
|
33132
33229
|
format: 'float',
|
|
33133
33230
|
type: 'number',
|
|
33134
33231
|
},
|
|
@@ -33191,12 +33288,12 @@ export default {
|
|
|
33191
33288
|
schema: {
|
|
33192
33289
|
properties: {
|
|
33193
33290
|
cooling_set_point_celsius: {
|
|
33194
|
-
description: '
|
|
33291
|
+
description: '[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.',
|
|
33195
33292
|
format: 'float',
|
|
33196
33293
|
type: 'number',
|
|
33197
33294
|
},
|
|
33198
33295
|
cooling_set_point_fahrenheit: {
|
|
33199
|
-
description: '
|
|
33296
|
+
description: '[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.',
|
|
33200
33297
|
format: 'float',
|
|
33201
33298
|
type: 'number',
|
|
33202
33299
|
},
|
|
@@ -33206,12 +33303,12 @@ export default {
|
|
|
33206
33303
|
type: 'string',
|
|
33207
33304
|
},
|
|
33208
33305
|
heating_set_point_celsius: {
|
|
33209
|
-
description: '
|
|
33306
|
+
description: '[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.',
|
|
33210
33307
|
format: 'float',
|
|
33211
33308
|
type: 'number',
|
|
33212
33309
|
},
|
|
33213
33310
|
heating_set_point_fahrenheit: {
|
|
33214
|
-
description: '
|
|
33311
|
+
description: '[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.',
|
|
33215
33312
|
format: 'float',
|
|
33216
33313
|
type: 'number',
|
|
33217
33314
|
},
|
|
@@ -33310,7 +33407,7 @@ export default {
|
|
|
33310
33407
|
type: 'array',
|
|
33311
33408
|
},
|
|
33312
33409
|
device_type: {
|
|
33313
|
-
description: 'Device type by which to filter thermostat devices.',
|
|
33410
|
+
description: 'Device type by which you want to filter thermostat devices.',
|
|
33314
33411
|
enum: [
|
|
33315
33412
|
'ecobee_thermostat',
|
|
33316
33413
|
'nest_thermostat',
|
|
@@ -33322,7 +33419,7 @@ export default {
|
|
|
33322
33419
|
type: 'string',
|
|
33323
33420
|
},
|
|
33324
33421
|
device_types: {
|
|
33325
|
-
description: 'Array of device types by which to filter thermostat devices.',
|
|
33422
|
+
description: 'Array of device types by which you want to filter thermostat devices.',
|
|
33326
33423
|
items: {
|
|
33327
33424
|
description: 'Device type for thermostats.\n ',
|
|
33328
33425
|
enum: [
|
|
@@ -33384,7 +33481,7 @@ export default {
|
|
|
33384
33481
|
type: 'number',
|
|
33385
33482
|
},
|
|
33386
33483
|
manufacturer: {
|
|
33387
|
-
description: 'Manufacturer by which to filter thermostat devices.',
|
|
33484
|
+
description: 'Manufacturer by which you want to filter thermostat devices.',
|
|
33388
33485
|
enum: [
|
|
33389
33486
|
'ecobee',
|
|
33390
33487
|
'honeywell_resideo',
|
|
@@ -33528,7 +33625,7 @@ export default {
|
|
|
33528
33625
|
},
|
|
33529
33626
|
'/thermostats/schedules/create': {
|
|
33530
33627
|
post: {
|
|
33531
|
-
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).',
|
|
33628
|
+
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).',
|
|
33532
33629
|
operationId: 'thermostatsSchedulesCreatePost',
|
|
33533
33630
|
requestBody: {
|
|
33534
33631
|
content: {
|
|
@@ -33536,19 +33633,19 @@ export default {
|
|
|
33536
33633
|
schema: {
|
|
33537
33634
|
properties: {
|
|
33538
33635
|
climate_preset_key: {
|
|
33539
|
-
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.',
|
|
33636
|
+
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.',
|
|
33540
33637
|
type: 'string',
|
|
33541
33638
|
},
|
|
33542
33639
|
device_id: {
|
|
33543
|
-
description: 'ID of the
|
|
33640
|
+
description: 'ID of the thermostat device for which you want to create a schedule.',
|
|
33544
33641
|
type: 'string',
|
|
33545
33642
|
},
|
|
33546
33643
|
ends_at: {
|
|
33547
|
-
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.',
|
|
33644
|
+
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.',
|
|
33548
33645
|
type: 'string',
|
|
33549
33646
|
},
|
|
33550
33647
|
is_override_allowed: {
|
|
33551
|
-
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).",
|
|
33648
|
+
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).",
|
|
33552
33649
|
type: 'boolean',
|
|
33553
33650
|
},
|
|
33554
33651
|
max_override_period_minutes: {
|
|
@@ -33559,11 +33656,11 @@ export default {
|
|
|
33559
33656
|
type: 'integer',
|
|
33560
33657
|
},
|
|
33561
33658
|
name: {
|
|
33562
|
-
description: '
|
|
33659
|
+
description: 'Name of the thermostat schedule.',
|
|
33563
33660
|
type: 'string',
|
|
33564
33661
|
},
|
|
33565
33662
|
starts_at: {
|
|
33566
|
-
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.',
|
|
33663
|
+
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.',
|
|
33567
33664
|
type: 'string',
|
|
33568
33665
|
},
|
|
33569
33666
|
},
|
|
@@ -33624,7 +33721,7 @@ export default {
|
|
|
33624
33721
|
schema: {
|
|
33625
33722
|
properties: {
|
|
33626
33723
|
thermostat_schedule_id: {
|
|
33627
|
-
description: 'ID of the
|
|
33724
|
+
description: 'ID of the thermostat schedule that you want to delete.',
|
|
33628
33725
|
format: 'uuid',
|
|
33629
33726
|
type: 'string',
|
|
33630
33727
|
},
|
|
@@ -33675,7 +33772,7 @@ export default {
|
|
|
33675
33772
|
schema: {
|
|
33676
33773
|
properties: {
|
|
33677
33774
|
thermostat_schedule_id: {
|
|
33678
|
-
description: 'ID of the
|
|
33775
|
+
description: 'ID of the thermostat schedule that you want to get.',
|
|
33679
33776
|
format: 'uuid',
|
|
33680
33777
|
type: 'string',
|
|
33681
33778
|
},
|
|
@@ -33732,7 +33829,7 @@ export default {
|
|
|
33732
33829
|
schema: {
|
|
33733
33830
|
properties: {
|
|
33734
33831
|
device_id: {
|
|
33735
|
-
description: 'ID of the
|
|
33832
|
+
description: 'ID of the thermostat device for which you want to list schedules.',
|
|
33736
33833
|
format: 'uuid',
|
|
33737
33834
|
type: 'string',
|
|
33738
33835
|
},
|
|
@@ -33815,7 +33912,7 @@ export default {
|
|
|
33815
33912
|
type: 'integer',
|
|
33816
33913
|
},
|
|
33817
33914
|
name: {
|
|
33818
|
-
description: '
|
|
33915
|
+
description: 'Name of the thermostat schedule.',
|
|
33819
33916
|
type: 'string',
|
|
33820
33917
|
},
|
|
33821
33918
|
starts_at: {
|
|
@@ -33823,7 +33920,7 @@ export default {
|
|
|
33823
33920
|
type: 'string',
|
|
33824
33921
|
},
|
|
33825
33922
|
thermostat_schedule_id: {
|
|
33826
|
-
description: 'ID of the
|
|
33923
|
+
description: 'ID of the thermostat schedule that you want to update.',
|
|
33827
33924
|
format: 'uuid',
|
|
33828
33925
|
type: 'string',
|
|
33829
33926
|
},
|
|
@@ -33890,7 +33987,7 @@ export default {
|
|
|
33890
33987
|
type: 'integer',
|
|
33891
33988
|
},
|
|
33892
33989
|
name: {
|
|
33893
|
-
description: '
|
|
33990
|
+
description: 'Name of the thermostat schedule.',
|
|
33894
33991
|
type: 'string',
|
|
33895
33992
|
},
|
|
33896
33993
|
starts_at: {
|
|
@@ -33898,7 +33995,7 @@ export default {
|
|
|
33898
33995
|
type: 'string',
|
|
33899
33996
|
},
|
|
33900
33997
|
thermostat_schedule_id: {
|
|
33901
|
-
description: 'ID of the
|
|
33998
|
+
description: 'ID of the thermostat schedule that you want to update.',
|
|
33902
33999
|
format: 'uuid',
|
|
33903
34000
|
type: 'string',
|
|
33904
34001
|
},
|
|
@@ -34014,7 +34111,7 @@ export default {
|
|
|
34014
34111
|
'x-deprecated': 'Use `fan_mode_setting` instead.',
|
|
34015
34112
|
},
|
|
34016
34113
|
fan_mode_setting: {
|
|
34017
|
-
description: '
|
|
34114
|
+
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.',
|
|
34018
34115
|
enum: ['auto', 'on', 'circulate'],
|
|
34019
34116
|
type: 'string',
|
|
34020
34117
|
},
|
|
@@ -34092,12 +34189,12 @@ export default {
|
|
|
34092
34189
|
{
|
|
34093
34190
|
properties: {
|
|
34094
34191
|
cooling_set_point_celsius: {
|
|
34095
|
-
description: '
|
|
34192
|
+
description: '[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.',
|
|
34096
34193
|
format: 'float',
|
|
34097
34194
|
type: 'number',
|
|
34098
34195
|
},
|
|
34099
34196
|
cooling_set_point_fahrenheit: {
|
|
34100
|
-
description: '
|
|
34197
|
+
description: '[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.',
|
|
34101
34198
|
format: 'float',
|
|
34102
34199
|
type: 'number',
|
|
34103
34200
|
},
|
|
@@ -34119,12 +34216,12 @@ export default {
|
|
|
34119
34216
|
type: 'string',
|
|
34120
34217
|
},
|
|
34121
34218
|
heating_set_point_celsius: {
|
|
34122
|
-
description: '
|
|
34219
|
+
description: '[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.',
|
|
34123
34220
|
format: 'float',
|
|
34124
34221
|
type: 'number',
|
|
34125
34222
|
},
|
|
34126
34223
|
heating_set_point_fahrenheit: {
|
|
34127
|
-
description: '
|
|
34224
|
+
description: '[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.',
|
|
34128
34225
|
format: 'float',
|
|
34129
34226
|
type: 'number',
|
|
34130
34227
|
},
|
|
@@ -34136,12 +34233,12 @@ export default {
|
|
|
34136
34233
|
{
|
|
34137
34234
|
properties: {
|
|
34138
34235
|
cooling_set_point_celsius: {
|
|
34139
|
-
description: '
|
|
34236
|
+
description: '[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.',
|
|
34140
34237
|
format: 'float',
|
|
34141
34238
|
type: 'number',
|
|
34142
34239
|
},
|
|
34143
34240
|
cooling_set_point_fahrenheit: {
|
|
34144
|
-
description: '
|
|
34241
|
+
description: '[Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.',
|
|
34145
34242
|
format: 'float',
|
|
34146
34243
|
type: 'number',
|
|
34147
34244
|
},
|
|
@@ -34151,12 +34248,12 @@ export default {
|
|
|
34151
34248
|
type: 'string',
|
|
34152
34249
|
},
|
|
34153
34250
|
heating_set_point_celsius: {
|
|
34154
|
-
description: '
|
|
34251
|
+
description: '[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.',
|
|
34155
34252
|
format: 'float',
|
|
34156
34253
|
type: 'number',
|
|
34157
34254
|
},
|
|
34158
34255
|
heating_set_point_fahrenheit: {
|
|
34159
|
-
description: '
|
|
34256
|
+
description: '[Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.',
|
|
34160
34257
|
format: 'float',
|
|
34161
34258
|
type: 'number',
|
|
34162
34259
|
},
|
|
@@ -34376,12 +34473,12 @@ export default {
|
|
|
34376
34473
|
{
|
|
34377
34474
|
properties: {
|
|
34378
34475
|
device_id: {
|
|
34379
|
-
description: 'ID of the
|
|
34476
|
+
description: 'ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.',
|
|
34380
34477
|
format: 'uuid',
|
|
34381
34478
|
type: 'string',
|
|
34382
34479
|
},
|
|
34383
34480
|
hvac_mode: {
|
|
34384
|
-
description: '
|
|
34481
|
+
description: 'HVAC mode that you want to simulate.',
|
|
34385
34482
|
enum: ['off'],
|
|
34386
34483
|
type: 'string',
|
|
34387
34484
|
},
|
|
@@ -34392,22 +34489,22 @@ export default {
|
|
|
34392
34489
|
{
|
|
34393
34490
|
properties: {
|
|
34394
34491
|
cooling_set_point_celsius: {
|
|
34395
|
-
description: '
|
|
34492
|
+
description: 'Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.',
|
|
34396
34493
|
format: 'float',
|
|
34397
34494
|
type: 'number',
|
|
34398
34495
|
},
|
|
34399
34496
|
cooling_set_point_fahrenheit: {
|
|
34400
|
-
description: '
|
|
34497
|
+
description: 'Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.',
|
|
34401
34498
|
format: 'float',
|
|
34402
34499
|
type: 'number',
|
|
34403
34500
|
},
|
|
34404
34501
|
device_id: {
|
|
34405
|
-
description: 'ID of the
|
|
34502
|
+
description: 'ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.',
|
|
34406
34503
|
format: 'uuid',
|
|
34407
34504
|
type: 'string',
|
|
34408
34505
|
},
|
|
34409
34506
|
hvac_mode: {
|
|
34410
|
-
description: '
|
|
34507
|
+
description: 'HVAC mode that you want to simulate.',
|
|
34411
34508
|
enum: ['cool'],
|
|
34412
34509
|
type: 'string',
|
|
34413
34510
|
},
|
|
@@ -34418,22 +34515,22 @@ export default {
|
|
|
34418
34515
|
{
|
|
34419
34516
|
properties: {
|
|
34420
34517
|
device_id: {
|
|
34421
|
-
description: 'ID of the
|
|
34518
|
+
description: 'ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.',
|
|
34422
34519
|
format: 'uuid',
|
|
34423
34520
|
type: 'string',
|
|
34424
34521
|
},
|
|
34425
34522
|
heating_set_point_celsius: {
|
|
34426
|
-
description: '
|
|
34523
|
+
description: 'Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.',
|
|
34427
34524
|
format: 'float',
|
|
34428
34525
|
type: 'number',
|
|
34429
34526
|
},
|
|
34430
34527
|
heating_set_point_fahrenheit: {
|
|
34431
|
-
description: '
|
|
34528
|
+
description: 'Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.',
|
|
34432
34529
|
format: 'float',
|
|
34433
34530
|
type: 'number',
|
|
34434
34531
|
},
|
|
34435
34532
|
hvac_mode: {
|
|
34436
|
-
description: '
|
|
34533
|
+
description: 'HVAC mode that you want to simulate.',
|
|
34437
34534
|
enum: ['heat'],
|
|
34438
34535
|
type: 'string',
|
|
34439
34536
|
},
|
|
@@ -34444,32 +34541,32 @@ export default {
|
|
|
34444
34541
|
{
|
|
34445
34542
|
properties: {
|
|
34446
34543
|
cooling_set_point_celsius: {
|
|
34447
|
-
description: '
|
|
34544
|
+
description: 'Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.',
|
|
34448
34545
|
format: 'float',
|
|
34449
34546
|
type: 'number',
|
|
34450
34547
|
},
|
|
34451
34548
|
cooling_set_point_fahrenheit: {
|
|
34452
|
-
description: '
|
|
34549
|
+
description: 'Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.',
|
|
34453
34550
|
format: 'float',
|
|
34454
34551
|
type: 'number',
|
|
34455
34552
|
},
|
|
34456
34553
|
device_id: {
|
|
34457
|
-
description: 'ID of the
|
|
34554
|
+
description: 'ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.',
|
|
34458
34555
|
format: 'uuid',
|
|
34459
34556
|
type: 'string',
|
|
34460
34557
|
},
|
|
34461
34558
|
heating_set_point_celsius: {
|
|
34462
|
-
description: '
|
|
34559
|
+
description: 'Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.',
|
|
34463
34560
|
format: 'float',
|
|
34464
34561
|
type: 'number',
|
|
34465
34562
|
},
|
|
34466
34563
|
heating_set_point_fahrenheit: {
|
|
34467
|
-
description: '
|
|
34564
|
+
description: 'Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.',
|
|
34468
34565
|
format: 'float',
|
|
34469
34566
|
type: 'number',
|
|
34470
34567
|
},
|
|
34471
34568
|
hvac_mode: {
|
|
34472
|
-
description: '
|
|
34569
|
+
description: 'HVAC mode that you want to simulate.',
|
|
34473
34570
|
enum: ['heat_cool'],
|
|
34474
34571
|
type: 'string',
|
|
34475
34572
|
},
|
|
@@ -34521,17 +34618,17 @@ export default {
|
|
|
34521
34618
|
schema: {
|
|
34522
34619
|
properties: {
|
|
34523
34620
|
device_id: {
|
|
34524
|
-
description: 'ID of the
|
|
34621
|
+
description: 'ID of the thermostat device that you want to simulate reaching a specified temperature.',
|
|
34525
34622
|
format: 'uuid',
|
|
34526
34623
|
type: 'string',
|
|
34527
34624
|
},
|
|
34528
34625
|
temperature_celsius: {
|
|
34529
|
-
description: '
|
|
34626
|
+
description: 'Temperature in °C that you want simulate the thermostat reaching. You must set `temperature_celsius` or `temperature_fahrenheit`.',
|
|
34530
34627
|
format: 'float',
|
|
34531
34628
|
type: 'number',
|
|
34532
34629
|
},
|
|
34533
34630
|
temperature_fahrenheit: {
|
|
34534
|
-
description: '
|
|
34631
|
+
description: 'Temperature in °F that you want simulate the thermostat reaching. You must set `temperature_fahrenheit` or `temperature_celsius`.',
|
|
34535
34632
|
format: 'float',
|
|
34536
34633
|
type: 'number',
|
|
34537
34634
|
},
|
|
@@ -34876,7 +34973,7 @@ export default {
|
|
|
34876
34973
|
{
|
|
34877
34974
|
properties: {
|
|
34878
34975
|
user_identity_id: {
|
|
34879
|
-
description: 'ID of user identity for whom
|
|
34976
|
+
description: 'ID of user identity for whom you want to grant access.',
|
|
34880
34977
|
format: 'uuid',
|
|
34881
34978
|
type: 'string',
|
|
34882
34979
|
},
|
|
@@ -34887,7 +34984,7 @@ export default {
|
|
|
34887
34984
|
{
|
|
34888
34985
|
properties: {
|
|
34889
34986
|
user_identity: {
|
|
34890
|
-
description: 'When used, creates a new user identity with the
|
|
34987
|
+
description: 'User identity. When used, creates a new user identity with the specified details and grants them access.',
|
|
34891
34988
|
properties: {
|
|
34892
34989
|
email_address: {
|
|
34893
34990
|
description: 'Unique email address for the user identity.',
|
|
@@ -34918,13 +35015,13 @@ export default {
|
|
|
34918
35015
|
properties: {
|
|
34919
35016
|
acs_entrance_ids: {
|
|
34920
35017
|
default: [],
|
|
34921
|
-
description: '
|
|
35018
|
+
description: 'IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to which you want to grant access.',
|
|
34922
35019
|
items: { format: 'uuid', type: 'string' },
|
|
34923
35020
|
type: 'array',
|
|
34924
35021
|
},
|
|
34925
35022
|
device_ids: {
|
|
34926
35023
|
default: [],
|
|
34927
|
-
description: '
|
|
35024
|
+
description: 'IDs of the devices to which you want to grant access.',
|
|
34928
35025
|
items: { format: 'uuid', type: 'string' },
|
|
34929
35026
|
type: 'array',
|
|
34930
35027
|
},
|
|
@@ -34934,7 +35031,7 @@ export default {
|
|
|
34934
35031
|
type: 'string',
|
|
34935
35032
|
},
|
|
34936
35033
|
location: {
|
|
34937
|
-
description: 'When used, creates a new location with the
|
|
35034
|
+
description: 'Location. When used, creates a new location with the specified entrances and devices, and gives the user access to this location.',
|
|
34938
35035
|
properties: {
|
|
34939
35036
|
acs_entrance_ids: {
|
|
34940
35037
|
default: [],
|
|
@@ -34967,7 +35064,7 @@ export default {
|
|
|
34967
35064
|
items: {
|
|
34968
35065
|
properties: {
|
|
34969
35066
|
mode: {
|
|
34970
|
-
description: 'Access method mode.
|
|
35067
|
+
description: 'Access method mode.',
|
|
34971
35068
|
enum: ['code', 'card', 'mobile_key'],
|
|
34972
35069
|
type: 'string',
|
|
34973
35070
|
},
|
|
@@ -34978,7 +35075,7 @@ export default {
|
|
|
34978
35075
|
type: 'array',
|
|
34979
35076
|
},
|
|
34980
35077
|
space_ids: {
|
|
34981
|
-
description: '
|
|
35078
|
+
description: 'IDs of the existing spaces to which you want to grant access.',
|
|
34982
35079
|
items: { format: 'uuid', type: 'string' },
|
|
34983
35080
|
type: 'array',
|
|
34984
35081
|
},
|
|
@@ -35124,7 +35221,7 @@ export default {
|
|
|
35124
35221
|
},
|
|
35125
35222
|
'/unstable_access_grants/delete': {
|
|
35126
35223
|
post: {
|
|
35127
|
-
description: '
|
|
35224
|
+
description: 'Deletes an access grant.',
|
|
35128
35225
|
operationId: 'unstableAccessGrantsDeletePost',
|
|
35129
35226
|
requestBody: {
|
|
35130
35227
|
content: {
|
|
@@ -35132,7 +35229,7 @@ export default {
|
|
|
35132
35229
|
schema: {
|
|
35133
35230
|
properties: {
|
|
35134
35231
|
access_grant_id: {
|
|
35135
|
-
description: 'ID of access grant to delete.',
|
|
35232
|
+
description: 'ID of access grant that you want to delete.',
|
|
35136
35233
|
format: 'uuid',
|
|
35137
35234
|
type: 'string',
|
|
35138
35235
|
},
|
|
@@ -35176,7 +35273,7 @@ export default {
|
|
|
35176
35273
|
},
|
|
35177
35274
|
'/unstable_access_grants/get': {
|
|
35178
35275
|
post: {
|
|
35179
|
-
description: '
|
|
35276
|
+
description: 'Gets an access grant.',
|
|
35180
35277
|
operationId: 'unstableAccessGrantsGetPost',
|
|
35181
35278
|
requestBody: {
|
|
35182
35279
|
content: {
|
|
@@ -35184,7 +35281,7 @@ export default {
|
|
|
35184
35281
|
schema: {
|
|
35185
35282
|
properties: {
|
|
35186
35283
|
access_grant_id: {
|
|
35187
|
-
description: 'ID of access grant to get.',
|
|
35284
|
+
description: 'ID of access grant that you want to get.',
|
|
35188
35285
|
format: 'uuid',
|
|
35189
35286
|
type: 'string',
|
|
35190
35287
|
},
|
|
@@ -35323,7 +35420,7 @@ export default {
|
|
|
35323
35420
|
},
|
|
35324
35421
|
'/unstable_access_grants/list': {
|
|
35325
35422
|
post: {
|
|
35326
|
-
description: '
|
|
35423
|
+
description: 'Returns a list of all access grants.',
|
|
35327
35424
|
operationId: 'unstableAccessGrantsListPost',
|
|
35328
35425
|
requestBody: {
|
|
35329
35426
|
content: {
|
|
@@ -35331,12 +35428,12 @@ export default {
|
|
|
35331
35428
|
schema: {
|
|
35332
35429
|
properties: {
|
|
35333
35430
|
acs_entrance_id: {
|
|
35334
|
-
description: 'ID of entrance to filter list of access grants
|
|
35431
|
+
description: 'ID of the entrance by which you want to filter the list of access grants.',
|
|
35335
35432
|
format: 'uuid',
|
|
35336
35433
|
type: 'string',
|
|
35337
35434
|
},
|
|
35338
35435
|
acs_system_id: {
|
|
35339
|
-
description: 'ID of system to filter list of access grants
|
|
35436
|
+
description: 'ID of the access system by which you want to filter the list of access grants.',
|
|
35340
35437
|
format: 'uuid',
|
|
35341
35438
|
type: 'string',
|
|
35342
35439
|
},
|
|
@@ -35347,12 +35444,12 @@ export default {
|
|
|
35347
35444
|
'x-deprecated': 'Use `space_id`.',
|
|
35348
35445
|
},
|
|
35349
35446
|
space_id: {
|
|
35350
|
-
description: 'ID of space to filter list of access grants
|
|
35447
|
+
description: 'ID of the space by which you want to filter the list of access grants.',
|
|
35351
35448
|
format: 'uuid',
|
|
35352
35449
|
type: 'string',
|
|
35353
35450
|
},
|
|
35354
35451
|
user_identity_id: {
|
|
35355
|
-
description: 'ID of user identity to filter list of access grants
|
|
35452
|
+
description: 'ID of the user identity by which you want to filter the list of access grants.',
|
|
35356
35453
|
format: 'uuid',
|
|
35357
35454
|
type: 'string',
|
|
35358
35455
|
},
|
|
@@ -35493,7 +35590,7 @@ export default {
|
|
|
35493
35590
|
},
|
|
35494
35591
|
'/unstable_access_methods/delete': {
|
|
35495
35592
|
post: {
|
|
35496
|
-
description: '
|
|
35593
|
+
description: 'Deletes an access method.',
|
|
35497
35594
|
operationId: 'unstableAccessMethodsDeletePost',
|
|
35498
35595
|
requestBody: {
|
|
35499
35596
|
content: {
|
|
@@ -35501,7 +35598,7 @@ export default {
|
|
|
35501
35598
|
schema: {
|
|
35502
35599
|
properties: {
|
|
35503
35600
|
access_method_id: {
|
|
35504
|
-
description: 'ID of access method to
|
|
35601
|
+
description: 'ID of the access method that you want to delete.',
|
|
35505
35602
|
format: 'uuid',
|
|
35506
35603
|
type: 'string',
|
|
35507
35604
|
},
|
|
@@ -35544,7 +35641,7 @@ export default {
|
|
|
35544
35641
|
},
|
|
35545
35642
|
'/unstable_access_methods/get': {
|
|
35546
35643
|
post: {
|
|
35547
|
-
description: '
|
|
35644
|
+
description: 'Gets an access method.',
|
|
35548
35645
|
operationId: 'unstableAccessMethodsGetPost',
|
|
35549
35646
|
requestBody: {
|
|
35550
35647
|
content: {
|
|
@@ -35552,7 +35649,7 @@ export default {
|
|
|
35552
35649
|
schema: {
|
|
35553
35650
|
properties: {
|
|
35554
35651
|
access_method_id: {
|
|
35555
|
-
description: 'ID of access method to get.',
|
|
35652
|
+
description: 'ID of the access method that you want to get.',
|
|
35556
35653
|
format: 'uuid',
|
|
35557
35654
|
type: 'string',
|
|
35558
35655
|
},
|
|
@@ -35649,7 +35746,7 @@ export default {
|
|
|
35649
35746
|
},
|
|
35650
35747
|
'/unstable_access_methods/list': {
|
|
35651
35748
|
post: {
|
|
35652
|
-
description: '
|
|
35749
|
+
description: 'Lists all access methods, usually filtered by access grant.',
|
|
35653
35750
|
operationId: 'unstableAccessMethodsListPost',
|
|
35654
35751
|
requestBody: {
|
|
35655
35752
|
content: {
|
|
@@ -35657,7 +35754,7 @@ export default {
|
|
|
35657
35754
|
schema: {
|
|
35658
35755
|
properties: {
|
|
35659
35756
|
access_grant_id: {
|
|
35660
|
-
description: 'ID of access grant to list access methods
|
|
35757
|
+
description: 'ID of the access grant by which to filter the list of access methods.',
|
|
35661
35758
|
format: 'uuid',
|
|
35662
35759
|
type: 'string',
|
|
35663
35760
|
},
|
|
@@ -35757,7 +35854,7 @@ export default {
|
|
|
35757
35854
|
},
|
|
35758
35855
|
'/unstable_locations/add_acs_entrances': {
|
|
35759
35856
|
post: {
|
|
35760
|
-
description: '
|
|
35857
|
+
description: 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.',
|
|
35761
35858
|
operationId: 'unstableLocationsAddAcsEntrancesPost',
|
|
35762
35859
|
requestBody: {
|
|
35763
35860
|
content: {
|
|
@@ -35765,11 +35862,16 @@ export default {
|
|
|
35765
35862
|
schema: {
|
|
35766
35863
|
properties: {
|
|
35767
35864
|
acs_entrance_ids: {
|
|
35865
|
+
description: 'IDs of the entrances that you want to add to the location.',
|
|
35768
35866
|
items: { format: 'uuid', type: 'string' },
|
|
35769
35867
|
minItems: 1,
|
|
35770
35868
|
type: 'array',
|
|
35771
35869
|
},
|
|
35772
|
-
location_id: {
|
|
35870
|
+
location_id: {
|
|
35871
|
+
description: 'ID of the location to which you want to add entrances.',
|
|
35872
|
+
format: 'uuid',
|
|
35873
|
+
type: 'string',
|
|
35874
|
+
},
|
|
35773
35875
|
},
|
|
35774
35876
|
required: ['location_id', 'acs_entrance_ids'],
|
|
35775
35877
|
type: 'object',
|
|
@@ -35803,11 +35905,11 @@ export default {
|
|
|
35803
35905
|
'x-fern-sdk-group-name': ['unstable_locations'],
|
|
35804
35906
|
'x-fern-sdk-method-name': 'add_acs_entrances',
|
|
35805
35907
|
'x-response-key': null,
|
|
35806
|
-
'x-title': 'Add
|
|
35908
|
+
'x-title': 'Add Entrances to a Location',
|
|
35807
35909
|
'x-undocumented': 'Experimental locations.',
|
|
35808
35910
|
},
|
|
35809
35911
|
put: {
|
|
35810
|
-
description: '
|
|
35912
|
+
description: 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.',
|
|
35811
35913
|
operationId: 'unstableLocationsAddAcsEntrancesPut',
|
|
35812
35914
|
requestBody: {
|
|
35813
35915
|
content: {
|
|
@@ -35815,11 +35917,16 @@ export default {
|
|
|
35815
35917
|
schema: {
|
|
35816
35918
|
properties: {
|
|
35817
35919
|
acs_entrance_ids: {
|
|
35920
|
+
description: 'IDs of the entrances that you want to add to the location.',
|
|
35818
35921
|
items: { format: 'uuid', type: 'string' },
|
|
35819
35922
|
minItems: 1,
|
|
35820
35923
|
type: 'array',
|
|
35821
35924
|
},
|
|
35822
|
-
location_id: {
|
|
35925
|
+
location_id: {
|
|
35926
|
+
description: 'ID of the location to which you want to add entrances.',
|
|
35927
|
+
format: 'uuid',
|
|
35928
|
+
type: 'string',
|
|
35929
|
+
},
|
|
35823
35930
|
},
|
|
35824
35931
|
required: ['location_id', 'acs_entrance_ids'],
|
|
35825
35932
|
type: 'object',
|
|
@@ -35852,13 +35959,13 @@ export default {
|
|
|
35852
35959
|
tags: [],
|
|
35853
35960
|
'x-fern-ignore': true,
|
|
35854
35961
|
'x-response-key': null,
|
|
35855
|
-
'x-title': 'Add
|
|
35962
|
+
'x-title': 'Add Entrances to a Location',
|
|
35856
35963
|
'x-undocumented': 'Experimental locations.',
|
|
35857
35964
|
},
|
|
35858
35965
|
},
|
|
35859
35966
|
'/unstable_locations/add_devices': {
|
|
35860
35967
|
post: {
|
|
35861
|
-
description: '
|
|
35968
|
+
description: 'Adds devices to a specific location.',
|
|
35862
35969
|
operationId: 'unstableLocationsAddDevicesPost',
|
|
35863
35970
|
requestBody: {
|
|
35864
35971
|
content: {
|
|
@@ -35866,11 +35973,16 @@ export default {
|
|
|
35866
35973
|
schema: {
|
|
35867
35974
|
properties: {
|
|
35868
35975
|
device_ids: {
|
|
35976
|
+
description: 'IDs of the devices that you want to add to the location.',
|
|
35869
35977
|
items: { format: 'uuid', type: 'string' },
|
|
35870
35978
|
minItems: 1,
|
|
35871
35979
|
type: 'array',
|
|
35872
35980
|
},
|
|
35873
|
-
location_id: {
|
|
35981
|
+
location_id: {
|
|
35982
|
+
description: 'ID of the location to which you want to add devices.',
|
|
35983
|
+
format: 'uuid',
|
|
35984
|
+
type: 'string',
|
|
35985
|
+
},
|
|
35874
35986
|
},
|
|
35875
35987
|
required: ['location_id', 'device_ids'],
|
|
35876
35988
|
type: 'object',
|
|
@@ -35904,11 +36016,11 @@ export default {
|
|
|
35904
36016
|
'x-fern-sdk-group-name': ['unstable_locations'],
|
|
35905
36017
|
'x-fern-sdk-method-name': 'add_devices',
|
|
35906
36018
|
'x-response-key': null,
|
|
35907
|
-
'x-title': 'Add Location
|
|
36019
|
+
'x-title': 'Add Devices to a Location',
|
|
35908
36020
|
'x-undocumented': 'Experimental locations.',
|
|
35909
36021
|
},
|
|
35910
36022
|
put: {
|
|
35911
|
-
description: '
|
|
36023
|
+
description: 'Adds devices to a specific location.',
|
|
35912
36024
|
operationId: 'unstableLocationsAddDevicesPut',
|
|
35913
36025
|
requestBody: {
|
|
35914
36026
|
content: {
|
|
@@ -35916,11 +36028,16 @@ export default {
|
|
|
35916
36028
|
schema: {
|
|
35917
36029
|
properties: {
|
|
35918
36030
|
device_ids: {
|
|
36031
|
+
description: 'IDs of the devices that you want to add to the location.',
|
|
35919
36032
|
items: { format: 'uuid', type: 'string' },
|
|
35920
36033
|
minItems: 1,
|
|
35921
36034
|
type: 'array',
|
|
35922
36035
|
},
|
|
35923
|
-
location_id: {
|
|
36036
|
+
location_id: {
|
|
36037
|
+
description: 'ID of the location to which you want to add devices.',
|
|
36038
|
+
format: 'uuid',
|
|
36039
|
+
type: 'string',
|
|
36040
|
+
},
|
|
35924
36041
|
},
|
|
35925
36042
|
required: ['location_id', 'device_ids'],
|
|
35926
36043
|
type: 'object',
|
|
@@ -35953,13 +36070,13 @@ export default {
|
|
|
35953
36070
|
tags: [],
|
|
35954
36071
|
'x-fern-ignore': true,
|
|
35955
36072
|
'x-response-key': null,
|
|
35956
|
-
'x-title': 'Add Location
|
|
36073
|
+
'x-title': 'Add Devices to a Location',
|
|
35957
36074
|
'x-undocumented': 'Experimental locations.',
|
|
35958
36075
|
},
|
|
35959
36076
|
},
|
|
35960
36077
|
'/unstable_locations/create': {
|
|
35961
36078
|
post: {
|
|
35962
|
-
description: '
|
|
36079
|
+
description: 'Creates a new location.',
|
|
35963
36080
|
operationId: 'unstableLocationsCreatePost',
|
|
35964
36081
|
requestBody: {
|
|
35965
36082
|
content: {
|
|
@@ -35967,14 +36084,17 @@ export default {
|
|
|
35967
36084
|
schema: {
|
|
35968
36085
|
properties: {
|
|
35969
36086
|
acs_entrance_ids: {
|
|
36087
|
+
description: 'IDs of the entrances that you want to add to the new location.',
|
|
35970
36088
|
items: { format: 'uuid', type: 'string' },
|
|
35971
36089
|
type: 'array',
|
|
35972
36090
|
},
|
|
35973
36091
|
device_ids: {
|
|
36092
|
+
description: 'IDs of the devices that you want to add to the new location.',
|
|
35974
36093
|
items: { format: 'uuid', type: 'string' },
|
|
35975
36094
|
type: 'array',
|
|
35976
36095
|
},
|
|
35977
36096
|
geolocation: {
|
|
36097
|
+
description: 'Geolocation of the new location.',
|
|
35978
36098
|
properties: {
|
|
35979
36099
|
latitude: { format: 'float', type: 'number' },
|
|
35980
36100
|
longitude: { format: 'float', type: 'number' },
|
|
@@ -35982,8 +36102,14 @@ export default {
|
|
|
35982
36102
|
required: ['latitude', 'longitude'],
|
|
35983
36103
|
type: 'object',
|
|
35984
36104
|
},
|
|
35985
|
-
name: {
|
|
35986
|
-
|
|
36105
|
+
name: {
|
|
36106
|
+
description: 'Name of the new location.',
|
|
36107
|
+
type: 'string',
|
|
36108
|
+
},
|
|
36109
|
+
time_zone: {
|
|
36110
|
+
description: 'Time zone of the new location.',
|
|
36111
|
+
type: 'string',
|
|
36112
|
+
},
|
|
35987
36113
|
},
|
|
35988
36114
|
required: ['name'],
|
|
35989
36115
|
type: 'object',
|
|
@@ -36068,19 +36194,25 @@ export default {
|
|
|
36068
36194
|
'x-fern-sdk-method-name': 'create',
|
|
36069
36195
|
'x-fern-sdk-return-value': 'location',
|
|
36070
36196
|
'x-response-key': 'location',
|
|
36071
|
-
'x-title': 'Create Location',
|
|
36197
|
+
'x-title': 'Create a Location',
|
|
36072
36198
|
'x-undocumented': 'Experimental locations.',
|
|
36073
36199
|
},
|
|
36074
36200
|
},
|
|
36075
36201
|
'/unstable_locations/delete': {
|
|
36076
36202
|
post: {
|
|
36077
|
-
description: '
|
|
36203
|
+
description: 'Deletes a location.',
|
|
36078
36204
|
operationId: 'unstableLocationsDeletePost',
|
|
36079
36205
|
requestBody: {
|
|
36080
36206
|
content: {
|
|
36081
36207
|
'application/json': {
|
|
36082
36208
|
schema: {
|
|
36083
|
-
properties: {
|
|
36209
|
+
properties: {
|
|
36210
|
+
location_id: {
|
|
36211
|
+
description: 'ID of the location that you want to delete.',
|
|
36212
|
+
format: 'uuid',
|
|
36213
|
+
type: 'string',
|
|
36214
|
+
},
|
|
36215
|
+
},
|
|
36084
36216
|
required: ['location_id'],
|
|
36085
36217
|
type: 'object',
|
|
36086
36218
|
},
|
|
@@ -36113,19 +36245,25 @@ export default {
|
|
|
36113
36245
|
'x-fern-sdk-group-name': ['unstable_locations'],
|
|
36114
36246
|
'x-fern-sdk-method-name': 'delete',
|
|
36115
36247
|
'x-response-key': null,
|
|
36116
|
-
'x-title': 'Delete Location',
|
|
36248
|
+
'x-title': 'Delete a Location',
|
|
36117
36249
|
'x-undocumented': 'Experimental locations.',
|
|
36118
36250
|
},
|
|
36119
36251
|
},
|
|
36120
36252
|
'/unstable_locations/get': {
|
|
36121
36253
|
post: {
|
|
36122
|
-
description: '
|
|
36254
|
+
description: 'Gets a location.',
|
|
36123
36255
|
operationId: 'unstableLocationsGetPost',
|
|
36124
36256
|
requestBody: {
|
|
36125
36257
|
content: {
|
|
36126
36258
|
'application/json': {
|
|
36127
36259
|
schema: {
|
|
36128
|
-
properties: {
|
|
36260
|
+
properties: {
|
|
36261
|
+
location_id: {
|
|
36262
|
+
description: 'ID of the location that you want to get.',
|
|
36263
|
+
format: 'uuid',
|
|
36264
|
+
type: 'string',
|
|
36265
|
+
},
|
|
36266
|
+
},
|
|
36129
36267
|
required: ['location_id'],
|
|
36130
36268
|
type: 'object',
|
|
36131
36269
|
},
|
|
@@ -36209,7 +36347,7 @@ export default {
|
|
|
36209
36347
|
'x-fern-sdk-method-name': 'get',
|
|
36210
36348
|
'x-fern-sdk-return-value': 'location',
|
|
36211
36349
|
'x-response-key': 'location',
|
|
36212
|
-
'x-title': 'Get Location',
|
|
36350
|
+
'x-title': 'Get a Location',
|
|
36213
36351
|
'x-undocumented': 'Experimental locations.',
|
|
36214
36352
|
},
|
|
36215
36353
|
},
|
|
@@ -36387,7 +36525,7 @@ export default {
|
|
|
36387
36525
|
},
|
|
36388
36526
|
'/unstable_locations/remove_acs_entrances': {
|
|
36389
36527
|
post: {
|
|
36390
|
-
description: '
|
|
36528
|
+
description: 'Removes entrances from a specific location.',
|
|
36391
36529
|
operationId: 'unstableLocationsRemoveAcsEntrancesPost',
|
|
36392
36530
|
requestBody: {
|
|
36393
36531
|
content: {
|
|
@@ -36395,10 +36533,15 @@ export default {
|
|
|
36395
36533
|
schema: {
|
|
36396
36534
|
properties: {
|
|
36397
36535
|
acs_entrance_ids: {
|
|
36536
|
+
description: 'IDs of the entrances that you want to remove from the location.',
|
|
36398
36537
|
items: { format: 'uuid', type: 'string' },
|
|
36399
36538
|
type: 'array',
|
|
36400
36539
|
},
|
|
36401
|
-
location_id: {
|
|
36540
|
+
location_id: {
|
|
36541
|
+
description: 'ID of the location from which you want to remove entrances.',
|
|
36542
|
+
format: 'uuid',
|
|
36543
|
+
type: 'string',
|
|
36544
|
+
},
|
|
36402
36545
|
},
|
|
36403
36546
|
required: ['location_id', 'acs_entrance_ids'],
|
|
36404
36547
|
type: 'object',
|
|
@@ -36432,13 +36575,13 @@ export default {
|
|
|
36432
36575
|
'x-fern-sdk-group-name': ['unstable_locations'],
|
|
36433
36576
|
'x-fern-sdk-method-name': 'remove_acs_entrances',
|
|
36434
36577
|
'x-response-key': null,
|
|
36435
|
-
'x-title': 'Remove
|
|
36578
|
+
'x-title': 'Remove Entrances from a Location',
|
|
36436
36579
|
'x-undocumented': 'Experimental locations.',
|
|
36437
36580
|
},
|
|
36438
36581
|
},
|
|
36439
36582
|
'/unstable_locations/remove_devices': {
|
|
36440
36583
|
post: {
|
|
36441
|
-
description: '
|
|
36584
|
+
description: 'Removes devices from a specific location.',
|
|
36442
36585
|
operationId: 'unstableLocationsRemoveDevicesPost',
|
|
36443
36586
|
requestBody: {
|
|
36444
36587
|
content: {
|
|
@@ -36446,10 +36589,15 @@ export default {
|
|
|
36446
36589
|
schema: {
|
|
36447
36590
|
properties: {
|
|
36448
36591
|
device_ids: {
|
|
36592
|
+
description: 'IDs of the devices that you want to remove from the location.',
|
|
36449
36593
|
items: { format: 'uuid', type: 'string' },
|
|
36450
36594
|
type: 'array',
|
|
36451
36595
|
},
|
|
36452
|
-
location_id: {
|
|
36596
|
+
location_id: {
|
|
36597
|
+
description: 'ID of the location from which you want to remove devices.',
|
|
36598
|
+
format: 'uuid',
|
|
36599
|
+
type: 'string',
|
|
36600
|
+
},
|
|
36453
36601
|
},
|
|
36454
36602
|
required: ['location_id', 'device_ids'],
|
|
36455
36603
|
type: 'object',
|
|
@@ -36483,13 +36631,13 @@ export default {
|
|
|
36483
36631
|
'x-fern-sdk-group-name': ['unstable_locations'],
|
|
36484
36632
|
'x-fern-sdk-method-name': 'remove_devices',
|
|
36485
36633
|
'x-response-key': null,
|
|
36486
|
-
'x-title': 'Remove Location
|
|
36634
|
+
'x-title': 'Remove Devices from a Location',
|
|
36487
36635
|
'x-undocumented': 'Experimental locations.',
|
|
36488
36636
|
},
|
|
36489
36637
|
},
|
|
36490
36638
|
'/unstable_locations/update': {
|
|
36491
36639
|
patch: {
|
|
36492
|
-
description: '
|
|
36640
|
+
description: 'Updates a location.',
|
|
36493
36641
|
operationId: 'unstableLocationsUpdatePatch',
|
|
36494
36642
|
requestBody: {
|
|
36495
36643
|
content: {
|
|
@@ -36497,6 +36645,7 @@ export default {
|
|
|
36497
36645
|
schema: {
|
|
36498
36646
|
properties: {
|
|
36499
36647
|
geolocation: {
|
|
36648
|
+
description: 'Geolocation of the location.',
|
|
36500
36649
|
properties: {
|
|
36501
36650
|
latitude: { format: 'float', type: 'number' },
|
|
36502
36651
|
longitude: { format: 'float', type: 'number' },
|
|
@@ -36504,9 +36653,19 @@ export default {
|
|
|
36504
36653
|
required: ['latitude', 'longitude'],
|
|
36505
36654
|
type: 'object',
|
|
36506
36655
|
},
|
|
36507
|
-
location_id: {
|
|
36508
|
-
|
|
36509
|
-
|
|
36656
|
+
location_id: {
|
|
36657
|
+
description: 'ID of the location that you want to update.',
|
|
36658
|
+
format: 'uuid',
|
|
36659
|
+
type: 'string',
|
|
36660
|
+
},
|
|
36661
|
+
name: {
|
|
36662
|
+
description: 'Name of the location.',
|
|
36663
|
+
type: 'string',
|
|
36664
|
+
},
|
|
36665
|
+
time_zone: {
|
|
36666
|
+
description: 'Time zone of the the location.',
|
|
36667
|
+
type: 'string',
|
|
36668
|
+
},
|
|
36510
36669
|
},
|
|
36511
36670
|
required: ['location_id'],
|
|
36512
36671
|
type: 'object',
|
|
@@ -36589,11 +36748,11 @@ export default {
|
|
|
36589
36748
|
tags: [],
|
|
36590
36749
|
'x-fern-ignore': true,
|
|
36591
36750
|
'x-response-key': 'location',
|
|
36592
|
-
'x-title': 'Update Location',
|
|
36751
|
+
'x-title': 'Update a Location',
|
|
36593
36752
|
'x-undocumented': 'Experimental locations.',
|
|
36594
36753
|
},
|
|
36595
36754
|
post: {
|
|
36596
|
-
description: '
|
|
36755
|
+
description: 'Updates a location.',
|
|
36597
36756
|
operationId: 'unstableLocationsUpdatePost',
|
|
36598
36757
|
requestBody: {
|
|
36599
36758
|
content: {
|
|
@@ -36601,6 +36760,7 @@ export default {
|
|
|
36601
36760
|
schema: {
|
|
36602
36761
|
properties: {
|
|
36603
36762
|
geolocation: {
|
|
36763
|
+
description: 'Geolocation of the location.',
|
|
36604
36764
|
properties: {
|
|
36605
36765
|
latitude: { format: 'float', type: 'number' },
|
|
36606
36766
|
longitude: { format: 'float', type: 'number' },
|
|
@@ -36608,9 +36768,19 @@ export default {
|
|
|
36608
36768
|
required: ['latitude', 'longitude'],
|
|
36609
36769
|
type: 'object',
|
|
36610
36770
|
},
|
|
36611
|
-
location_id: {
|
|
36612
|
-
|
|
36613
|
-
|
|
36771
|
+
location_id: {
|
|
36772
|
+
description: 'ID of the location that you want to update.',
|
|
36773
|
+
format: 'uuid',
|
|
36774
|
+
type: 'string',
|
|
36775
|
+
},
|
|
36776
|
+
name: {
|
|
36777
|
+
description: 'Name of the location.',
|
|
36778
|
+
type: 'string',
|
|
36779
|
+
},
|
|
36780
|
+
time_zone: {
|
|
36781
|
+
description: 'Time zone of the the location.',
|
|
36782
|
+
type: 'string',
|
|
36783
|
+
},
|
|
36614
36784
|
},
|
|
36615
36785
|
required: ['location_id'],
|
|
36616
36786
|
type: 'object',
|
|
@@ -36695,7 +36865,7 @@ export default {
|
|
|
36695
36865
|
'x-fern-sdk-method-name': 'update',
|
|
36696
36866
|
'x-fern-sdk-return-value': 'location',
|
|
36697
36867
|
'x-response-key': 'location',
|
|
36698
|
-
'x-title': 'Update Location',
|
|
36868
|
+
'x-title': 'Update a Location',
|
|
36699
36869
|
'x-undocumented': 'Experimental locations.',
|
|
36700
36870
|
},
|
|
36701
36871
|
},
|
|
@@ -36707,7 +36877,12 @@ export default {
|
|
|
36707
36877
|
content: {
|
|
36708
36878
|
'application/json': {
|
|
36709
36879
|
schema: {
|
|
36710
|
-
properties: {
|
|
36880
|
+
properties: {
|
|
36881
|
+
customer_key: {
|
|
36882
|
+
description: 'Customer key for which you want to connect accounts.',
|
|
36883
|
+
type: 'string',
|
|
36884
|
+
},
|
|
36885
|
+
},
|
|
36711
36886
|
required: ['customer_key'],
|
|
36712
36887
|
type: 'object',
|
|
36713
36888
|
},
|
|
@@ -36744,7 +36919,7 @@ export default {
|
|
|
36744
36919
|
'x-fern-sdk-method-name': 'connect_accounts',
|
|
36745
36920
|
'x-fern-sdk-return-value': 'magic_link',
|
|
36746
36921
|
'x-response-key': 'magic_link',
|
|
36747
|
-
'x-title': 'Connect Accounts',
|
|
36922
|
+
'x-title': 'Generate a Connect Accounts Building Block Magic Link',
|
|
36748
36923
|
'x-undocumented': 'Experimental partner building blocks.',
|
|
36749
36924
|
},
|
|
36750
36925
|
},
|
|
@@ -36760,10 +36935,14 @@ export default {
|
|
|
36760
36935
|
{
|
|
36761
36936
|
properties: {
|
|
36762
36937
|
building_block_type: {
|
|
36938
|
+
description: '`connect_accounts` building block type.',
|
|
36763
36939
|
enum: ['connect_accounts'],
|
|
36764
36940
|
type: 'string',
|
|
36765
36941
|
},
|
|
36766
|
-
customer_key: {
|
|
36942
|
+
customer_key: {
|
|
36943
|
+
description: 'Customer key for which you want to create a new building block magic link.',
|
|
36944
|
+
type: 'string',
|
|
36945
|
+
},
|
|
36767
36946
|
},
|
|
36768
36947
|
required: ['building_block_type', 'customer_key'],
|
|
36769
36948
|
type: 'object',
|
|
@@ -36771,10 +36950,14 @@ export default {
|
|
|
36771
36950
|
{
|
|
36772
36951
|
properties: {
|
|
36773
36952
|
building_block_type: {
|
|
36953
|
+
description: '`manage_devices` building block type.',
|
|
36774
36954
|
enum: ['manage_devices'],
|
|
36775
36955
|
type: 'string',
|
|
36776
36956
|
},
|
|
36777
|
-
customer_key: {
|
|
36957
|
+
customer_key: {
|
|
36958
|
+
description: 'Customer key for which you want to create a new building block magic link.',
|
|
36959
|
+
type: 'string',
|
|
36960
|
+
},
|
|
36778
36961
|
},
|
|
36779
36962
|
required: ['building_block_type', 'customer_key'],
|
|
36780
36963
|
type: 'object',
|
|
@@ -36782,12 +36965,16 @@ export default {
|
|
|
36782
36965
|
{
|
|
36783
36966
|
properties: {
|
|
36784
36967
|
building_block_type: {
|
|
36968
|
+
description: '`organize_spaces` building block type.',
|
|
36785
36969
|
enum: ['organize_spaces'],
|
|
36786
36970
|
type: 'string',
|
|
36787
36971
|
},
|
|
36788
|
-
customer_key: {
|
|
36972
|
+
customer_key: {
|
|
36973
|
+
description: 'Customer key for which you want to create a new building block magic link.',
|
|
36974
|
+
type: 'string',
|
|
36975
|
+
},
|
|
36789
36976
|
partner_resources: {
|
|
36790
|
-
description: 'Optional list of partner resources to include in the magic link.',
|
|
36977
|
+
description: 'Optional list of partner resources that you want to include in the new building block magic link.',
|
|
36791
36978
|
items: {
|
|
36792
36979
|
properties: {
|
|
36793
36980
|
custom_metadata: {
|
|
@@ -36844,7 +37031,7 @@ export default {
|
|
|
36844
37031
|
'x-fern-sdk-method-name': 'generate_magic_link',
|
|
36845
37032
|
'x-fern-sdk-return-value': 'magic_link',
|
|
36846
37033
|
'x-response-key': 'magic_link',
|
|
36847
|
-
'x-title': 'Generate a
|
|
37034
|
+
'x-title': 'Generate a Building Block Magic Link',
|
|
36848
37035
|
'x-undocumented': 'Experimental partner building blocks.',
|
|
36849
37036
|
},
|
|
36850
37037
|
},
|
|
@@ -36856,7 +37043,12 @@ export default {
|
|
|
36856
37043
|
content: {
|
|
36857
37044
|
'application/json': {
|
|
36858
37045
|
schema: {
|
|
36859
|
-
properties: {
|
|
37046
|
+
properties: {
|
|
37047
|
+
customer_key: {
|
|
37048
|
+
description: 'Customer key for which you want to manage devices.',
|
|
37049
|
+
type: 'string',
|
|
37050
|
+
},
|
|
37051
|
+
},
|
|
36860
37052
|
required: ['customer_key'],
|
|
36861
37053
|
type: 'object',
|
|
36862
37054
|
},
|
|
@@ -36893,7 +37085,7 @@ export default {
|
|
|
36893
37085
|
'x-fern-sdk-method-name': 'manage_devices',
|
|
36894
37086
|
'x-fern-sdk-return-value': 'magic_link',
|
|
36895
37087
|
'x-response-key': 'magic_link',
|
|
36896
|
-
'x-title': 'Manage Devices',
|
|
37088
|
+
'x-title': 'Generate a Manage Devices Building Block Magic Link',
|
|
36897
37089
|
'x-undocumented': 'Experimental partner building blocks.',
|
|
36898
37090
|
},
|
|
36899
37091
|
},
|
|
@@ -36906,8 +37098,12 @@ export default {
|
|
|
36906
37098
|
'application/json': {
|
|
36907
37099
|
schema: {
|
|
36908
37100
|
properties: {
|
|
36909
|
-
customer_key: {
|
|
37101
|
+
customer_key: {
|
|
37102
|
+
description: 'Customer key for which you want to organize spaces.',
|
|
37103
|
+
type: 'string',
|
|
37104
|
+
},
|
|
36910
37105
|
partner_resources: {
|
|
37106
|
+
description: 'Optional list of partner resources that you want to include in the new building block magic link.',
|
|
36911
37107
|
items: {
|
|
36912
37108
|
properties: {
|
|
36913
37109
|
custom_metadata: {
|
|
@@ -36962,13 +37158,13 @@ export default {
|
|
|
36962
37158
|
'x-fern-sdk-method-name': 'organize_spaces',
|
|
36963
37159
|
'x-fern-sdk-return-value': 'magic_link',
|
|
36964
37160
|
'x-response-key': 'magic_link',
|
|
36965
|
-
'x-title': 'Organize Spaces',
|
|
37161
|
+
'x-title': 'Generate an Organize Spaces Building Block Magic Link',
|
|
36966
37162
|
'x-undocumented': 'Experimental partner building blocks.',
|
|
36967
37163
|
},
|
|
36968
37164
|
},
|
|
36969
37165
|
'/unstable_partner/resources/push': {
|
|
36970
37166
|
post: {
|
|
36971
|
-
description: '
|
|
37167
|
+
description: 'Sends Seam some of your resources.',
|
|
36972
37168
|
operationId: 'unstablePartnerResourcesPushPost',
|
|
36973
37169
|
requestBody: {
|
|
36974
37170
|
content: {
|
|
@@ -36982,7 +37178,10 @@ export default {
|
|
|
36982
37178
|
additionalProperties: { type: 'string' },
|
|
36983
37179
|
type: 'object',
|
|
36984
37180
|
},
|
|
36985
|
-
customer_key: {
|
|
37181
|
+
customer_key: {
|
|
37182
|
+
description: 'Customer key associated with the resource that you want to push to Seam.',
|
|
37183
|
+
type: 'string',
|
|
37184
|
+
},
|
|
36986
37185
|
description: { type: 'string' },
|
|
36987
37186
|
email_address: { type: 'string' },
|
|
36988
37187
|
ends_at: { type: 'string' },
|
|
@@ -36991,8 +37190,14 @@ export default {
|
|
|
36991
37190
|
type: 'array',
|
|
36992
37191
|
},
|
|
36993
37192
|
name: { type: 'string' },
|
|
36994
|
-
partner_resource_key: {
|
|
36995
|
-
|
|
37193
|
+
partner_resource_key: {
|
|
37194
|
+
description: 'Key of the resource that you want to push to Seam.',
|
|
37195
|
+
type: 'string',
|
|
37196
|
+
},
|
|
37197
|
+
partner_resource_type: {
|
|
37198
|
+
description: 'Type of the resource that you want to push to Seam.',
|
|
37199
|
+
type: 'string',
|
|
37200
|
+
},
|
|
36996
37201
|
phone_number: { type: 'string' },
|
|
36997
37202
|
starts_at: { type: 'string' },
|
|
36998
37203
|
user_identity_key: { type: 'string' },
|
|
@@ -37009,7 +37214,10 @@ export default {
|
|
|
37009
37214
|
additionalProperties: { type: 'string' },
|
|
37010
37215
|
type: 'object',
|
|
37011
37216
|
},
|
|
37012
|
-
customer_key: {
|
|
37217
|
+
customer_key: {
|
|
37218
|
+
description: 'Customer key associated with the resource that you want to push to Seam.',
|
|
37219
|
+
type: 'string',
|
|
37220
|
+
},
|
|
37013
37221
|
description: { type: 'string' },
|
|
37014
37222
|
email_address: { type: 'string' },
|
|
37015
37223
|
ends_at: { type: 'string' },
|
|
@@ -37018,8 +37226,14 @@ export default {
|
|
|
37018
37226
|
type: 'array',
|
|
37019
37227
|
},
|
|
37020
37228
|
name: { type: 'string' },
|
|
37021
|
-
partner_resource_key: {
|
|
37022
|
-
|
|
37229
|
+
partner_resource_key: {
|
|
37230
|
+
description: 'Key of the resource that you want to push to Seam.',
|
|
37231
|
+
type: 'string',
|
|
37232
|
+
},
|
|
37233
|
+
partner_resource_type: {
|
|
37234
|
+
description: 'Type of the resource that you want to push to Seam.',
|
|
37235
|
+
type: 'string',
|
|
37236
|
+
},
|
|
37023
37237
|
phone_number: { type: 'string' },
|
|
37024
37238
|
starts_at: { type: 'string' },
|
|
37025
37239
|
user_identity_key: { type: 'string' },
|
|
@@ -37059,13 +37273,13 @@ export default {
|
|
|
37059
37273
|
'x-fern-sdk-group-name': ['unstable_partner', 'resources'],
|
|
37060
37274
|
'x-fern-sdk-method-name': 'push',
|
|
37061
37275
|
'x-response-key': null,
|
|
37062
|
-
'x-title': 'Push
|
|
37276
|
+
'x-title': 'Push Partner Resources at Seam',
|
|
37063
37277
|
'x-undocumented': 'Experimental partner resources.',
|
|
37064
37278
|
},
|
|
37065
37279
|
},
|
|
37066
37280
|
'/user_identities/add_acs_user': {
|
|
37067
37281
|
post: {
|
|
37068
|
-
description: 'Adds a specified [
|
|
37282
|
+
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).',
|
|
37069
37283
|
operationId: 'userIdentitiesAddAcsUserPost',
|
|
37070
37284
|
requestBody: {
|
|
37071
37285
|
content: {
|
|
@@ -37073,12 +37287,12 @@ export default {
|
|
|
37073
37287
|
schema: {
|
|
37074
37288
|
properties: {
|
|
37075
37289
|
acs_user_id: {
|
|
37076
|
-
description: 'ID of the
|
|
37290
|
+
description: 'ID of the access system user that you want to add to the user identity.',
|
|
37077
37291
|
format: 'uuid',
|
|
37078
37292
|
type: 'string',
|
|
37079
37293
|
},
|
|
37080
37294
|
user_identity_id: {
|
|
37081
|
-
description: 'ID of the
|
|
37295
|
+
description: 'ID of the user identity to which you want to add an access system user.',
|
|
37082
37296
|
format: 'uuid',
|
|
37083
37297
|
type: 'string',
|
|
37084
37298
|
},
|
|
@@ -37118,7 +37332,7 @@ export default {
|
|
|
37118
37332
|
'x-title': 'Add an ACS User to a User Identity',
|
|
37119
37333
|
},
|
|
37120
37334
|
put: {
|
|
37121
|
-
description: 'Adds a specified [
|
|
37335
|
+
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).',
|
|
37122
37336
|
operationId: 'userIdentitiesAddAcsUserPut',
|
|
37123
37337
|
requestBody: {
|
|
37124
37338
|
content: {
|
|
@@ -37126,12 +37340,12 @@ export default {
|
|
|
37126
37340
|
schema: {
|
|
37127
37341
|
properties: {
|
|
37128
37342
|
acs_user_id: {
|
|
37129
|
-
description: 'ID of the
|
|
37343
|
+
description: 'ID of the access system user that you want to add to the user identity.',
|
|
37130
37344
|
format: 'uuid',
|
|
37131
37345
|
type: 'string',
|
|
37132
37346
|
},
|
|
37133
37347
|
user_identity_id: {
|
|
37134
|
-
description: 'ID of the
|
|
37348
|
+
description: 'ID of the user identity to which you want to add an access system user.',
|
|
37135
37349
|
format: 'uuid',
|
|
37136
37350
|
type: 'string',
|
|
37137
37351
|
},
|
|
@@ -37180,29 +37394,29 @@ export default {
|
|
|
37180
37394
|
schema: {
|
|
37181
37395
|
properties: {
|
|
37182
37396
|
acs_system_ids: {
|
|
37183
|
-
description: "List of
|
|
37397
|
+
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.",
|
|
37184
37398
|
items: { format: 'uuid', type: 'string' },
|
|
37185
37399
|
type: 'array',
|
|
37186
37400
|
},
|
|
37187
37401
|
email_address: {
|
|
37188
|
-
description: 'Unique email address for the user identity.',
|
|
37402
|
+
description: 'Unique email address for the new user identity.',
|
|
37189
37403
|
format: 'email',
|
|
37190
37404
|
nullable: true,
|
|
37191
37405
|
type: 'string',
|
|
37192
37406
|
},
|
|
37193
37407
|
full_name: {
|
|
37194
|
-
description: 'Full name of the user associated with the user identity.',
|
|
37408
|
+
description: 'Full name of the user associated with the new user identity.',
|
|
37195
37409
|
minLength: 1,
|
|
37196
37410
|
nullable: true,
|
|
37197
37411
|
type: 'string',
|
|
37198
37412
|
},
|
|
37199
37413
|
phone_number: {
|
|
37200
|
-
description: 'Unique phone number for the user identity in E.164 format (for example, +15555550100).',
|
|
37414
|
+
description: 'Unique phone number for the new user identity in E.164 format (for example, +15555550100).',
|
|
37201
37415
|
nullable: true,
|
|
37202
37416
|
type: 'string',
|
|
37203
37417
|
},
|
|
37204
37418
|
user_identity_key: {
|
|
37205
|
-
description: 'Unique key for the user identity.',
|
|
37419
|
+
description: 'Unique key for the new user identity.',
|
|
37206
37420
|
minLength: 1,
|
|
37207
37421
|
nullable: true,
|
|
37208
37422
|
type: 'string',
|
|
@@ -37258,7 +37472,7 @@ export default {
|
|
|
37258
37472
|
schema: {
|
|
37259
37473
|
properties: {
|
|
37260
37474
|
user_identity_id: {
|
|
37261
|
-
description: 'ID of the
|
|
37475
|
+
description: 'ID of the user identity that you want to delete.',
|
|
37262
37476
|
format: 'uuid',
|
|
37263
37477
|
type: 'string',
|
|
37264
37478
|
},
|
|
@@ -37308,7 +37522,7 @@ export default {
|
|
|
37308
37522
|
schema: {
|
|
37309
37523
|
properties: {
|
|
37310
37524
|
enrollment_automation_id: {
|
|
37311
|
-
description: 'ID of the
|
|
37525
|
+
description: 'ID of the enrollment automation that you want to delete.',
|
|
37312
37526
|
format: 'uuid',
|
|
37313
37527
|
type: 'string',
|
|
37314
37528
|
},
|
|
@@ -37358,7 +37572,7 @@ export default {
|
|
|
37358
37572
|
schema: {
|
|
37359
37573
|
properties: {
|
|
37360
37574
|
enrollment_automation_id: {
|
|
37361
|
-
description: 'ID of the
|
|
37575
|
+
description: 'ID of the enrollment automation that you want to get.',
|
|
37362
37576
|
format: 'uuid',
|
|
37363
37577
|
type: 'string',
|
|
37364
37578
|
},
|
|
@@ -37415,7 +37629,7 @@ export default {
|
|
|
37415
37629
|
schema: {
|
|
37416
37630
|
properties: {
|
|
37417
37631
|
acs_credential_pool_id: {
|
|
37418
|
-
description: 'ID of the
|
|
37632
|
+
description: 'ID of the credential pool from which to obtain credentials for the user identity.',
|
|
37419
37633
|
format: 'uuid',
|
|
37420
37634
|
type: 'string',
|
|
37421
37635
|
},
|
|
@@ -37424,17 +37638,17 @@ export default {
|
|
|
37424
37638
|
type: 'boolean',
|
|
37425
37639
|
},
|
|
37426
37640
|
credential_manager_acs_system_id: {
|
|
37427
|
-
description: 'ID of the desired
|
|
37641
|
+
description: 'ID of the desired access system that serves as the credential manager for the enrollment automation.',
|
|
37428
37642
|
format: 'uuid',
|
|
37429
37643
|
type: 'string',
|
|
37430
37644
|
},
|
|
37431
37645
|
credential_manager_acs_user_id: {
|
|
37432
|
-
description: 'ID of the associated
|
|
37646
|
+
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`.',
|
|
37433
37647
|
format: 'uuid',
|
|
37434
37648
|
type: 'string',
|
|
37435
37649
|
},
|
|
37436
37650
|
user_identity_id: {
|
|
37437
|
-
description: 'ID of the
|
|
37651
|
+
description: 'ID of the user identity for which you want to launch an enrollment automation.',
|
|
37438
37652
|
format: 'uuid',
|
|
37439
37653
|
type: 'string',
|
|
37440
37654
|
},
|
|
@@ -37518,7 +37732,7 @@ export default {
|
|
|
37518
37732
|
schema: {
|
|
37519
37733
|
properties: {
|
|
37520
37734
|
user_identity_id: {
|
|
37521
|
-
description: 'ID of the user identity for which you want to retrieve
|
|
37735
|
+
description: 'ID of the user identity for which you want to retrieve enrollment automations.',
|
|
37522
37736
|
format: 'uuid',
|
|
37523
37737
|
type: 'string',
|
|
37524
37738
|
},
|
|
@@ -37579,7 +37793,7 @@ export default {
|
|
|
37579
37793
|
properties: {
|
|
37580
37794
|
max_use_count: {
|
|
37581
37795
|
default: 1,
|
|
37582
|
-
description: '
|
|
37796
|
+
description: 'Maximum number of times the instant key can be used. Default: 1.',
|
|
37583
37797
|
format: 'float',
|
|
37584
37798
|
type: 'number',
|
|
37585
37799
|
},
|
|
@@ -37640,7 +37854,7 @@ export default {
|
|
|
37640
37854
|
{
|
|
37641
37855
|
properties: {
|
|
37642
37856
|
user_identity_id: {
|
|
37643
|
-
description: 'ID of the
|
|
37857
|
+
description: 'ID of the user identity that you want to get.',
|
|
37644
37858
|
format: 'uuid',
|
|
37645
37859
|
type: 'string',
|
|
37646
37860
|
},
|
|
@@ -37703,12 +37917,12 @@ export default {
|
|
|
37703
37917
|
schema: {
|
|
37704
37918
|
properties: {
|
|
37705
37919
|
device_id: {
|
|
37706
|
-
description: 'ID of the
|
|
37920
|
+
description: 'ID of the managed device to which you want to grant access to the user identity.',
|
|
37707
37921
|
format: 'uuid',
|
|
37708
37922
|
type: 'string',
|
|
37709
37923
|
},
|
|
37710
37924
|
user_identity_id: {
|
|
37711
|
-
description: 'ID of the
|
|
37925
|
+
description: 'ID of the user identity that you want to grant access to a device.',
|
|
37712
37926
|
format: 'uuid',
|
|
37713
37927
|
type: 'string',
|
|
37714
37928
|
},
|
|
@@ -37756,12 +37970,12 @@ export default {
|
|
|
37756
37970
|
schema: {
|
|
37757
37971
|
properties: {
|
|
37758
37972
|
device_id: {
|
|
37759
|
-
description: 'ID of the
|
|
37973
|
+
description: 'ID of the managed device to which you want to grant access to the user identity.',
|
|
37760
37974
|
format: 'uuid',
|
|
37761
37975
|
type: 'string',
|
|
37762
37976
|
},
|
|
37763
37977
|
user_identity_id: {
|
|
37764
|
-
description: 'ID of the
|
|
37978
|
+
description: 'ID of the user identity that you want to grant access to a device.',
|
|
37765
37979
|
format: 'uuid',
|
|
37766
37980
|
type: 'string',
|
|
37767
37981
|
},
|
|
@@ -37810,6 +38024,7 @@ export default {
|
|
|
37810
38024
|
schema: {
|
|
37811
38025
|
properties: {
|
|
37812
38026
|
credential_manager_acs_system_id: {
|
|
38027
|
+
description: '`acs_system_id` of the credential manager by which you want to filter the list of user identities.',
|
|
37813
38028
|
format: 'uuid',
|
|
37814
38029
|
type: 'string',
|
|
37815
38030
|
},
|
|
@@ -37887,7 +38102,7 @@ export default {
|
|
|
37887
38102
|
deprecated: true,
|
|
37888
38103
|
items: { $ref: '#/components/schemas/device' },
|
|
37889
38104
|
type: 'array',
|
|
37890
|
-
'x-deprecated': '
|
|
38105
|
+
'x-deprecated': 'Use devices.',
|
|
37891
38106
|
},
|
|
37892
38107
|
devices: {
|
|
37893
38108
|
items: { $ref: '#/components/schemas/device' },
|
|
@@ -37921,7 +38136,7 @@ export default {
|
|
|
37921
38136
|
},
|
|
37922
38137
|
'/user_identities/list_acs_systems': {
|
|
37923
38138
|
post: {
|
|
37924
|
-
description: 'Returns a list of all [access
|
|
38139
|
+
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).',
|
|
37925
38140
|
operationId: 'userIdentitiesListAcsSystemsPost',
|
|
37926
38141
|
requestBody: {
|
|
37927
38142
|
content: {
|
|
@@ -37929,7 +38144,7 @@ export default {
|
|
|
37929
38144
|
schema: {
|
|
37930
38145
|
properties: {
|
|
37931
38146
|
user_identity_id: {
|
|
37932
|
-
description: 'ID of the user identity for which you want to retrieve all access
|
|
38147
|
+
description: 'ID of the user identity for which you want to retrieve all access systems.',
|
|
37933
38148
|
format: 'uuid',
|
|
37934
38149
|
type: 'string',
|
|
37935
38150
|
},
|
|
@@ -37979,7 +38194,7 @@ export default {
|
|
|
37979
38194
|
},
|
|
37980
38195
|
'/user_identities/list_acs_users': {
|
|
37981
38196
|
post: {
|
|
37982
|
-
description: 'Returns a list of all [
|
|
38197
|
+
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).',
|
|
37983
38198
|
operationId: 'userIdentitiesListAcsUsersPost',
|
|
37984
38199
|
requestBody: {
|
|
37985
38200
|
content: {
|
|
@@ -37987,7 +38202,7 @@ export default {
|
|
|
37987
38202
|
schema: {
|
|
37988
38203
|
properties: {
|
|
37989
38204
|
user_identity_id: {
|
|
37990
|
-
description: 'ID of the user identity for which you want to retrieve all
|
|
38205
|
+
description: 'ID of the user identity for which you want to retrieve all access system users.',
|
|
37991
38206
|
format: 'uuid',
|
|
37992
38207
|
type: 'string',
|
|
37993
38208
|
},
|
|
@@ -38036,7 +38251,7 @@ export default {
|
|
|
38036
38251
|
},
|
|
38037
38252
|
'/user_identities/remove_acs_user': {
|
|
38038
38253
|
post: {
|
|
38039
|
-
description: 'Removes a specified [
|
|
38254
|
+
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).',
|
|
38040
38255
|
operationId: 'userIdentitiesRemoveAcsUserPost',
|
|
38041
38256
|
requestBody: {
|
|
38042
38257
|
content: {
|
|
@@ -38044,12 +38259,12 @@ export default {
|
|
|
38044
38259
|
schema: {
|
|
38045
38260
|
properties: {
|
|
38046
38261
|
acs_user_id: {
|
|
38047
|
-
description: 'ID of the
|
|
38262
|
+
description: 'ID of the access system user that you want to remove from the user identity..',
|
|
38048
38263
|
format: 'uuid',
|
|
38049
38264
|
type: 'string',
|
|
38050
38265
|
},
|
|
38051
38266
|
user_identity_id: {
|
|
38052
|
-
description: 'ID of the
|
|
38267
|
+
description: 'ID of the user identity from which you want to remove an access system user.',
|
|
38053
38268
|
format: 'uuid',
|
|
38054
38269
|
type: 'string',
|
|
38055
38270
|
},
|
|
@@ -38099,12 +38314,12 @@ export default {
|
|
|
38099
38314
|
schema: {
|
|
38100
38315
|
properties: {
|
|
38101
38316
|
device_id: {
|
|
38102
|
-
description: 'ID of the
|
|
38317
|
+
description: 'ID of the managed device to which you want to revoke access from the user identity.',
|
|
38103
38318
|
format: 'uuid',
|
|
38104
38319
|
type: 'string',
|
|
38105
38320
|
},
|
|
38106
38321
|
user_identity_id: {
|
|
38107
|
-
description: 'ID of the
|
|
38322
|
+
description: 'ID of the user identity from which you want to revoke access to a device.',
|
|
38108
38323
|
format: 'uuid',
|
|
38109
38324
|
type: 'string',
|
|
38110
38325
|
},
|
|
@@ -38146,6 +38361,7 @@ export default {
|
|
|
38146
38361
|
},
|
|
38147
38362
|
'/user_identities/update': {
|
|
38148
38363
|
patch: {
|
|
38364
|
+
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).',
|
|
38149
38365
|
operationId: 'userIdentitiesUpdatePatch',
|
|
38150
38366
|
requestBody: {
|
|
38151
38367
|
content: {
|
|
@@ -38158,14 +38374,19 @@ export default {
|
|
|
38158
38374
|
nullable: true,
|
|
38159
38375
|
type: 'string',
|
|
38160
38376
|
},
|
|
38161
|
-
full_name: {
|
|
38377
|
+
full_name: {
|
|
38378
|
+
description: 'Full name of the user associated with the user identity.',
|
|
38379
|
+
minLength: 1,
|
|
38380
|
+
nullable: true,
|
|
38381
|
+
type: 'string',
|
|
38382
|
+
},
|
|
38162
38383
|
phone_number: {
|
|
38163
|
-
description: 'Unique phone number for the user identity
|
|
38384
|
+
description: 'Unique phone number for the user identity.',
|
|
38164
38385
|
nullable: true,
|
|
38165
38386
|
type: 'string',
|
|
38166
38387
|
},
|
|
38167
38388
|
user_identity_id: {
|
|
38168
|
-
description: 'ID of the user identity.',
|
|
38389
|
+
description: 'ID of the user identity that you want to update.',
|
|
38169
38390
|
format: 'uuid',
|
|
38170
38391
|
type: 'string',
|
|
38171
38392
|
},
|
|
@@ -38210,6 +38431,7 @@ export default {
|
|
|
38210
38431
|
'x-title': 'Update a User Identity',
|
|
38211
38432
|
},
|
|
38212
38433
|
post: {
|
|
38434
|
+
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).',
|
|
38213
38435
|
operationId: 'userIdentitiesUpdatePost',
|
|
38214
38436
|
requestBody: {
|
|
38215
38437
|
content: {
|
|
@@ -38222,14 +38444,19 @@ export default {
|
|
|
38222
38444
|
nullable: true,
|
|
38223
38445
|
type: 'string',
|
|
38224
38446
|
},
|
|
38225
|
-
full_name: {
|
|
38447
|
+
full_name: {
|
|
38448
|
+
description: 'Full name of the user associated with the user identity.',
|
|
38449
|
+
minLength: 1,
|
|
38450
|
+
nullable: true,
|
|
38451
|
+
type: 'string',
|
|
38452
|
+
},
|
|
38226
38453
|
phone_number: {
|
|
38227
|
-
description: 'Unique phone number for the user identity
|
|
38454
|
+
description: 'Unique phone number for the user identity.',
|
|
38228
38455
|
nullable: true,
|
|
38229
38456
|
type: 'string',
|
|
38230
38457
|
},
|
|
38231
38458
|
user_identity_id: {
|
|
38232
|
-
description: 'ID of the user identity.',
|
|
38459
|
+
description: 'ID of the user identity that you want to update.',
|
|
38233
38460
|
format: 'uuid',
|
|
38234
38461
|
type: 'string',
|
|
38235
38462
|
},
|
|
@@ -38277,6 +38504,7 @@ export default {
|
|
|
38277
38504
|
},
|
|
38278
38505
|
'/webhooks/create': {
|
|
38279
38506
|
post: {
|
|
38507
|
+
description: 'Creates a new [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
38280
38508
|
operationId: 'webhooksCreatePost',
|
|
38281
38509
|
requestBody: {
|
|
38282
38510
|
content: {
|
|
@@ -38285,10 +38513,15 @@ export default {
|
|
|
38285
38513
|
properties: {
|
|
38286
38514
|
event_types: {
|
|
38287
38515
|
default: ['*'],
|
|
38516
|
+
description: 'Types of events that you want the new webhook to receive.',
|
|
38288
38517
|
items: { type: 'string' },
|
|
38289
38518
|
type: 'array',
|
|
38290
38519
|
},
|
|
38291
|
-
url: {
|
|
38520
|
+
url: {
|
|
38521
|
+
description: 'URL for the new webhook.',
|
|
38522
|
+
format: 'uri',
|
|
38523
|
+
type: 'string',
|
|
38524
|
+
},
|
|
38292
38525
|
},
|
|
38293
38526
|
required: ['url'],
|
|
38294
38527
|
type: 'object',
|
|
@@ -38326,16 +38559,23 @@ export default {
|
|
|
38326
38559
|
'x-fern-sdk-method-name': 'create',
|
|
38327
38560
|
'x-fern-sdk-return-value': 'webhook',
|
|
38328
38561
|
'x-response-key': 'webhook',
|
|
38562
|
+
'x-title': 'Create a Webhook',
|
|
38329
38563
|
},
|
|
38330
38564
|
},
|
|
38331
38565
|
'/webhooks/delete': {
|
|
38332
38566
|
post: {
|
|
38567
|
+
description: 'Deletes a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
38333
38568
|
operationId: 'webhooksDeletePost',
|
|
38334
38569
|
requestBody: {
|
|
38335
38570
|
content: {
|
|
38336
38571
|
'application/json': {
|
|
38337
38572
|
schema: {
|
|
38338
|
-
properties: {
|
|
38573
|
+
properties: {
|
|
38574
|
+
webhook_id: {
|
|
38575
|
+
description: 'ID of the webhook that you want to delete.',
|
|
38576
|
+
type: 'string',
|
|
38577
|
+
},
|
|
38578
|
+
},
|
|
38339
38579
|
required: ['webhook_id'],
|
|
38340
38580
|
type: 'object',
|
|
38341
38581
|
},
|
|
@@ -38368,16 +38608,23 @@ export default {
|
|
|
38368
38608
|
'x-fern-sdk-group-name': ['webhooks'],
|
|
38369
38609
|
'x-fern-sdk-method-name': 'delete',
|
|
38370
38610
|
'x-response-key': null,
|
|
38611
|
+
'x-title': 'Delete a Webhook',
|
|
38371
38612
|
},
|
|
38372
38613
|
},
|
|
38373
38614
|
'/webhooks/get': {
|
|
38374
38615
|
post: {
|
|
38616
|
+
description: 'Gets a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
38375
38617
|
operationId: 'webhooksGetPost',
|
|
38376
38618
|
requestBody: {
|
|
38377
38619
|
content: {
|
|
38378
38620
|
'application/json': {
|
|
38379
38621
|
schema: {
|
|
38380
|
-
properties: {
|
|
38622
|
+
properties: {
|
|
38623
|
+
webhook_id: {
|
|
38624
|
+
description: 'ID of the webhook that you want to get.',
|
|
38625
|
+
type: 'string',
|
|
38626
|
+
},
|
|
38627
|
+
},
|
|
38381
38628
|
required: ['webhook_id'],
|
|
38382
38629
|
type: 'object',
|
|
38383
38630
|
},
|
|
@@ -38414,10 +38661,12 @@ export default {
|
|
|
38414
38661
|
'x-fern-sdk-method-name': 'get',
|
|
38415
38662
|
'x-fern-sdk-return-value': 'webhook',
|
|
38416
38663
|
'x-response-key': 'webhook',
|
|
38664
|
+
'x-title': 'Get a Webhook',
|
|
38417
38665
|
},
|
|
38418
38666
|
},
|
|
38419
38667
|
'/webhooks/list': {
|
|
38420
38668
|
get: {
|
|
38669
|
+
description: 'Returns a list of all [webhooks](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
38421
38670
|
operationId: 'webhooksListGet',
|
|
38422
38671
|
responses: {
|
|
38423
38672
|
200: {
|
|
@@ -38450,8 +38699,10 @@ export default {
|
|
|
38450
38699
|
tags: ['/webhooks'],
|
|
38451
38700
|
'x-fern-ignore': true,
|
|
38452
38701
|
'x-response-key': 'webhooks',
|
|
38702
|
+
'x-title': 'List Webhooks',
|
|
38453
38703
|
},
|
|
38454
38704
|
post: {
|
|
38705
|
+
description: 'Returns a list of all [webhooks](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
38455
38706
|
operationId: 'webhooksListPost',
|
|
38456
38707
|
responses: {
|
|
38457
38708
|
200: {
|
|
@@ -38486,18 +38737,27 @@ export default {
|
|
|
38486
38737
|
'x-fern-sdk-method-name': 'list',
|
|
38487
38738
|
'x-fern-sdk-return-value': 'webhooks',
|
|
38488
38739
|
'x-response-key': 'webhooks',
|
|
38740
|
+
'x-title': 'List Webhooks',
|
|
38489
38741
|
},
|
|
38490
38742
|
},
|
|
38491
38743
|
'/webhooks/update': {
|
|
38492
38744
|
post: {
|
|
38745
|
+
description: 'Updates a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
38493
38746
|
operationId: 'webhooksUpdatePost',
|
|
38494
38747
|
requestBody: {
|
|
38495
38748
|
content: {
|
|
38496
38749
|
'application/json': {
|
|
38497
38750
|
schema: {
|
|
38498
38751
|
properties: {
|
|
38499
|
-
event_types: {
|
|
38500
|
-
|
|
38752
|
+
event_types: {
|
|
38753
|
+
description: 'Types of events that you want the webhook to receive.',
|
|
38754
|
+
items: { type: 'string' },
|
|
38755
|
+
type: 'array',
|
|
38756
|
+
},
|
|
38757
|
+
webhook_id: {
|
|
38758
|
+
description: 'ID of the webhook that you want to update.',
|
|
38759
|
+
type: 'string',
|
|
38760
|
+
},
|
|
38501
38761
|
},
|
|
38502
38762
|
required: ['webhook_id', 'event_types'],
|
|
38503
38763
|
type: 'object',
|
|
@@ -38531,16 +38791,25 @@ export default {
|
|
|
38531
38791
|
'x-fern-sdk-group-name': ['webhooks'],
|
|
38532
38792
|
'x-fern-sdk-method-name': 'update',
|
|
38533
38793
|
'x-response-key': null,
|
|
38794
|
+
'x-title': 'Update a Webhook',
|
|
38534
38795
|
},
|
|
38535
38796
|
put: {
|
|
38797
|
+
description: 'Updates a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
38536
38798
|
operationId: 'webhooksUpdatePut',
|
|
38537
38799
|
requestBody: {
|
|
38538
38800
|
content: {
|
|
38539
38801
|
'application/json': {
|
|
38540
38802
|
schema: {
|
|
38541
38803
|
properties: {
|
|
38542
|
-
event_types: {
|
|
38543
|
-
|
|
38804
|
+
event_types: {
|
|
38805
|
+
description: 'Types of events that you want the webhook to receive.',
|
|
38806
|
+
items: { type: 'string' },
|
|
38807
|
+
type: 'array',
|
|
38808
|
+
},
|
|
38809
|
+
webhook_id: {
|
|
38810
|
+
description: 'ID of the webhook that you want to update.',
|
|
38811
|
+
type: 'string',
|
|
38812
|
+
},
|
|
38544
38813
|
},
|
|
38545
38814
|
required: ['webhook_id', 'event_types'],
|
|
38546
38815
|
type: 'object',
|
|
@@ -38573,41 +38842,65 @@ export default {
|
|
|
38573
38842
|
tags: ['/webhooks'],
|
|
38574
38843
|
'x-fern-ignore': true,
|
|
38575
38844
|
'x-response-key': null,
|
|
38845
|
+
'x-title': 'Update a Webhook',
|
|
38576
38846
|
},
|
|
38577
38847
|
},
|
|
38578
38848
|
'/workspaces/create': {
|
|
38579
38849
|
post: {
|
|
38850
|
+
description: 'Creates a new [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
|
|
38580
38851
|
operationId: 'workspacesCreatePost',
|
|
38581
38852
|
requestBody: {
|
|
38582
38853
|
content: {
|
|
38583
38854
|
'application/json': {
|
|
38584
38855
|
schema: {
|
|
38585
38856
|
properties: {
|
|
38586
|
-
company_name: {
|
|
38857
|
+
company_name: {
|
|
38858
|
+
description: 'Company name for the new workspace.',
|
|
38859
|
+
type: 'string',
|
|
38860
|
+
},
|
|
38587
38861
|
connect_partner_name: {
|
|
38588
38862
|
deprecated: true,
|
|
38863
|
+
description: 'Connect partner name for the new workspace.',
|
|
38589
38864
|
nullable: true,
|
|
38590
38865
|
type: 'string',
|
|
38591
38866
|
'x-deprecated': 'use company_name',
|
|
38592
38867
|
},
|
|
38593
38868
|
connect_webview_customization: {
|
|
38869
|
+
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).',
|
|
38594
38870
|
properties: {
|
|
38595
38871
|
logo_shape: {
|
|
38872
|
+
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).',
|
|
38596
38873
|
enum: ['circle', 'square'],
|
|
38597
38874
|
nullable: true,
|
|
38598
38875
|
type: 'string',
|
|
38599
38876
|
},
|
|
38600
|
-
primary_button_color: {
|
|
38877
|
+
primary_button_color: {
|
|
38878
|
+
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).',
|
|
38879
|
+
nullable: true,
|
|
38880
|
+
type: 'string',
|
|
38881
|
+
},
|
|
38601
38882
|
primary_button_text_color: {
|
|
38883
|
+
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).',
|
|
38884
|
+
nullable: true,
|
|
38885
|
+
type: 'string',
|
|
38886
|
+
},
|
|
38887
|
+
success_message: {
|
|
38888
|
+
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).',
|
|
38602
38889
|
nullable: true,
|
|
38603
38890
|
type: 'string',
|
|
38604
38891
|
},
|
|
38605
|
-
success_message: { nullable: true, type: 'string' },
|
|
38606
38892
|
},
|
|
38607
38893
|
type: 'object',
|
|
38608
38894
|
},
|
|
38609
|
-
is_sandbox: {
|
|
38610
|
-
|
|
38895
|
+
is_sandbox: {
|
|
38896
|
+
default: false,
|
|
38897
|
+
description: 'Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
|
|
38898
|
+
type: 'boolean',
|
|
38899
|
+
},
|
|
38900
|
+
name: {
|
|
38901
|
+
description: 'Name of the new workspace.',
|
|
38902
|
+
type: 'string',
|
|
38903
|
+
},
|
|
38611
38904
|
webview_logo_shape: {
|
|
38612
38905
|
deprecated: true,
|
|
38613
38906
|
enum: ['circle', 'square'],
|
|
@@ -38666,10 +38959,12 @@ export default {
|
|
|
38666
38959
|
'x-fern-sdk-method-name': 'create',
|
|
38667
38960
|
'x-fern-sdk-return-value': 'workspace',
|
|
38668
38961
|
'x-response-key': 'workspace',
|
|
38962
|
+
'x-title': 'Create a Workspace',
|
|
38669
38963
|
},
|
|
38670
38964
|
},
|
|
38671
38965
|
'/workspaces/get': {
|
|
38672
38966
|
get: {
|
|
38967
|
+
description: 'Returns the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
|
|
38673
38968
|
operationId: 'workspacesGetGet',
|
|
38674
38969
|
responses: {
|
|
38675
38970
|
200: {
|
|
@@ -38694,14 +38989,17 @@ export default {
|
|
|
38694
38989
|
{ api_key: [] },
|
|
38695
38990
|
{ console_session_with_workspace: [] },
|
|
38696
38991
|
{ client_session: [] },
|
|
38992
|
+
{ client_session_with_customer: [] },
|
|
38697
38993
|
{ pat_with_workspace: [] },
|
|
38698
38994
|
],
|
|
38699
38995
|
summary: '/workspaces/get',
|
|
38700
38996
|
tags: ['/workspaces'],
|
|
38701
38997
|
'x-fern-ignore': true,
|
|
38702
38998
|
'x-response-key': 'workspace',
|
|
38999
|
+
'x-title': 'Get a Workspace',
|
|
38703
39000
|
},
|
|
38704
39001
|
post: {
|
|
39002
|
+
description: 'Returns the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
|
|
38705
39003
|
operationId: 'workspacesGetPost',
|
|
38706
39004
|
responses: {
|
|
38707
39005
|
200: {
|
|
@@ -38726,6 +39024,7 @@ export default {
|
|
|
38726
39024
|
{ api_key: [] },
|
|
38727
39025
|
{ console_session_with_workspace: [] },
|
|
38728
39026
|
{ client_session: [] },
|
|
39027
|
+
{ client_session_with_customer: [] },
|
|
38729
39028
|
{ pat_with_workspace: [] },
|
|
38730
39029
|
],
|
|
38731
39030
|
summary: '/workspaces/get',
|
|
@@ -38734,10 +39033,12 @@ export default {
|
|
|
38734
39033
|
'x-fern-sdk-method-name': 'get',
|
|
38735
39034
|
'x-fern-sdk-return-value': 'workspace',
|
|
38736
39035
|
'x-response-key': 'workspace',
|
|
39036
|
+
'x-title': 'Get a Workspace',
|
|
38737
39037
|
},
|
|
38738
39038
|
},
|
|
38739
39039
|
'/workspaces/list': {
|
|
38740
39040
|
get: {
|
|
39041
|
+
description: 'Returns a list of [workspaces](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
|
|
38741
39042
|
operationId: 'workspacesListGet',
|
|
38742
39043
|
responses: {
|
|
38743
39044
|
200: {
|
|
@@ -38773,8 +39074,10 @@ export default {
|
|
|
38773
39074
|
tags: ['/workspaces'],
|
|
38774
39075
|
'x-fern-ignore': true,
|
|
38775
39076
|
'x-response-key': 'workspaces',
|
|
39077
|
+
'x-title': 'List Workspaces',
|
|
38776
39078
|
},
|
|
38777
39079
|
post: {
|
|
39080
|
+
description: 'Returns a list of [workspaces](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
|
|
38778
39081
|
operationId: 'workspacesListPost',
|
|
38779
39082
|
responses: {
|
|
38780
39083
|
200: {
|
|
@@ -38812,11 +39115,12 @@ export default {
|
|
|
38812
39115
|
'x-fern-sdk-method-name': 'list',
|
|
38813
39116
|
'x-fern-sdk-return-value': 'workspaces',
|
|
38814
39117
|
'x-response-key': 'workspaces',
|
|
39118
|
+
'x-title': 'List Workspaces',
|
|
38815
39119
|
},
|
|
38816
39120
|
},
|
|
38817
39121
|
'/workspaces/reset_sandbox': {
|
|
38818
39122
|
post: {
|
|
38819
|
-
description: 'Resets
|
|
39123
|
+
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.',
|
|
38820
39124
|
operationId: 'workspacesResetSandboxPost',
|
|
38821
39125
|
responses: {
|
|
38822
39126
|
200: {
|
|
@@ -38851,35 +39155,57 @@ export default {
|
|
|
38851
39155
|
'x-fern-sdk-method-name': 'reset_sandbox',
|
|
38852
39156
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
38853
39157
|
'x-response-key': 'action_attempt',
|
|
39158
|
+
'x-title': 'Reset a Sandbox Workspace',
|
|
38854
39159
|
},
|
|
38855
39160
|
},
|
|
38856
39161
|
'/workspaces/update': {
|
|
38857
39162
|
patch: {
|
|
39163
|
+
description: 'Updates the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
|
|
38858
39164
|
operationId: 'workspacesUpdatePatch',
|
|
38859
39165
|
requestBody: {
|
|
38860
39166
|
content: {
|
|
38861
39167
|
'application/json': {
|
|
38862
39168
|
schema: {
|
|
38863
39169
|
properties: {
|
|
38864
|
-
connect_partner_name: {
|
|
39170
|
+
connect_partner_name: {
|
|
39171
|
+
description: 'Connect partner name for the workspace.',
|
|
39172
|
+
type: 'string',
|
|
39173
|
+
},
|
|
38865
39174
|
connect_webview_customization: {
|
|
39175
|
+
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).',
|
|
38866
39176
|
properties: {
|
|
38867
39177
|
logo_shape: {
|
|
39178
|
+
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).',
|
|
38868
39179
|
enum: ['circle', 'square'],
|
|
38869
39180
|
nullable: true,
|
|
38870
39181
|
type: 'string',
|
|
38871
39182
|
},
|
|
38872
|
-
primary_button_color: {
|
|
39183
|
+
primary_button_color: {
|
|
39184
|
+
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).',
|
|
39185
|
+
nullable: true,
|
|
39186
|
+
type: 'string',
|
|
39187
|
+
},
|
|
38873
39188
|
primary_button_text_color: {
|
|
39189
|
+
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).',
|
|
39190
|
+
nullable: true,
|
|
39191
|
+
type: 'string',
|
|
39192
|
+
},
|
|
39193
|
+
success_message: {
|
|
39194
|
+
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).',
|
|
38874
39195
|
nullable: true,
|
|
38875
39196
|
type: 'string',
|
|
38876
39197
|
},
|
|
38877
|
-
success_message: { nullable: true, type: 'string' },
|
|
38878
39198
|
},
|
|
38879
39199
|
type: 'object',
|
|
38880
39200
|
},
|
|
38881
|
-
is_suspended: {
|
|
38882
|
-
|
|
39201
|
+
is_suspended: {
|
|
39202
|
+
description: 'Indicates whether the workspace is suspended.',
|
|
39203
|
+
type: 'boolean',
|
|
39204
|
+
},
|
|
39205
|
+
name: {
|
|
39206
|
+
description: 'Name of the workspace.',
|
|
39207
|
+
type: 'string',
|
|
39208
|
+
},
|
|
38883
39209
|
},
|
|
38884
39210
|
type: 'object',
|
|
38885
39211
|
},
|
|
@@ -38900,33 +39226,55 @@ export default {
|
|
|
38900
39226
|
tags: ['/workspaces'],
|
|
38901
39227
|
'x-fern-ignore': true,
|
|
38902
39228
|
'x-response-key': null,
|
|
39229
|
+
'x-title': 'Udpate a Workspace',
|
|
38903
39230
|
},
|
|
38904
39231
|
post: {
|
|
39232
|
+
description: 'Updates the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
|
|
38905
39233
|
operationId: 'workspacesUpdatePost',
|
|
38906
39234
|
requestBody: {
|
|
38907
39235
|
content: {
|
|
38908
39236
|
'application/json': {
|
|
38909
39237
|
schema: {
|
|
38910
39238
|
properties: {
|
|
38911
|
-
connect_partner_name: {
|
|
39239
|
+
connect_partner_name: {
|
|
39240
|
+
description: 'Connect partner name for the workspace.',
|
|
39241
|
+
type: 'string',
|
|
39242
|
+
},
|
|
38912
39243
|
connect_webview_customization: {
|
|
39244
|
+
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).',
|
|
38913
39245
|
properties: {
|
|
38914
39246
|
logo_shape: {
|
|
39247
|
+
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).',
|
|
38915
39248
|
enum: ['circle', 'square'],
|
|
38916
39249
|
nullable: true,
|
|
38917
39250
|
type: 'string',
|
|
38918
39251
|
},
|
|
38919
|
-
primary_button_color: {
|
|
39252
|
+
primary_button_color: {
|
|
39253
|
+
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).',
|
|
39254
|
+
nullable: true,
|
|
39255
|
+
type: 'string',
|
|
39256
|
+
},
|
|
38920
39257
|
primary_button_text_color: {
|
|
39258
|
+
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).',
|
|
39259
|
+
nullable: true,
|
|
39260
|
+
type: 'string',
|
|
39261
|
+
},
|
|
39262
|
+
success_message: {
|
|
39263
|
+
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).',
|
|
38921
39264
|
nullable: true,
|
|
38922
39265
|
type: 'string',
|
|
38923
39266
|
},
|
|
38924
|
-
success_message: { nullable: true, type: 'string' },
|
|
38925
39267
|
},
|
|
38926
39268
|
type: 'object',
|
|
38927
39269
|
},
|
|
38928
|
-
is_suspended: {
|
|
38929
|
-
|
|
39270
|
+
is_suspended: {
|
|
39271
|
+
description: 'Indicates whether the workspace is suspended.',
|
|
39272
|
+
type: 'boolean',
|
|
39273
|
+
},
|
|
39274
|
+
name: {
|
|
39275
|
+
description: 'Name of the workspace.',
|
|
39276
|
+
type: 'string',
|
|
39277
|
+
},
|
|
38930
39278
|
},
|
|
38931
39279
|
type: 'object',
|
|
38932
39280
|
},
|
|
@@ -38948,6 +39296,7 @@ export default {
|
|
|
38948
39296
|
'x-fern-sdk-group-name': ['workspaces'],
|
|
38949
39297
|
'x-fern-sdk-method-name': 'update',
|
|
38950
39298
|
'x-response-key': null,
|
|
39299
|
+
'x-title': 'Udpate a Workspace',
|
|
38951
39300
|
},
|
|
38952
39301
|
},
|
|
38953
39302
|
},
|