@seamapi/types 1.410.0 → 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 +655 -314
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +448 -112
- package/lib/seam/connect/openapi.d.ts +254 -0
- package/lib/seam/connect/openapi.js +634 -293
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +194 -112
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +765 -304
- package/src/lib/seam/connect/route-types.ts +194 -112
|
@@ -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
|
},
|
|
@@ -34632,11 +34729,7 @@ export default {
|
|
|
34632
34729
|
type: 'string',
|
|
34633
34730
|
},
|
|
34634
34731
|
},
|
|
34635
|
-
required: [
|
|
34636
|
-
'device_id',
|
|
34637
|
-
'climate_preset_key',
|
|
34638
|
-
'manual_override_allowed',
|
|
34639
|
-
],
|
|
34732
|
+
required: ['device_id', 'climate_preset_key'],
|
|
34640
34733
|
type: 'object',
|
|
34641
34734
|
},
|
|
34642
34735
|
},
|
|
@@ -34730,11 +34823,7 @@ export default {
|
|
|
34730
34823
|
type: 'string',
|
|
34731
34824
|
},
|
|
34732
34825
|
},
|
|
34733
|
-
required: [
|
|
34734
|
-
'device_id',
|
|
34735
|
-
'climate_preset_key',
|
|
34736
|
-
'manual_override_allowed',
|
|
34737
|
-
],
|
|
34826
|
+
required: ['device_id', 'climate_preset_key'],
|
|
34738
34827
|
type: 'object',
|
|
34739
34828
|
},
|
|
34740
34829
|
},
|
|
@@ -34884,7 +34973,7 @@ export default {
|
|
|
34884
34973
|
{
|
|
34885
34974
|
properties: {
|
|
34886
34975
|
user_identity_id: {
|
|
34887
|
-
description: 'ID of user identity for whom
|
|
34976
|
+
description: 'ID of user identity for whom you want to grant access.',
|
|
34888
34977
|
format: 'uuid',
|
|
34889
34978
|
type: 'string',
|
|
34890
34979
|
},
|
|
@@ -34895,7 +34984,7 @@ export default {
|
|
|
34895
34984
|
{
|
|
34896
34985
|
properties: {
|
|
34897
34986
|
user_identity: {
|
|
34898
|
-
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.',
|
|
34899
34988
|
properties: {
|
|
34900
34989
|
email_address: {
|
|
34901
34990
|
description: 'Unique email address for the user identity.',
|
|
@@ -34926,13 +35015,13 @@ export default {
|
|
|
34926
35015
|
properties: {
|
|
34927
35016
|
acs_entrance_ids: {
|
|
34928
35017
|
default: [],
|
|
34929
|
-
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.',
|
|
34930
35019
|
items: { format: 'uuid', type: 'string' },
|
|
34931
35020
|
type: 'array',
|
|
34932
35021
|
},
|
|
34933
35022
|
device_ids: {
|
|
34934
35023
|
default: [],
|
|
34935
|
-
description: '
|
|
35024
|
+
description: 'IDs of the devices to which you want to grant access.',
|
|
34936
35025
|
items: { format: 'uuid', type: 'string' },
|
|
34937
35026
|
type: 'array',
|
|
34938
35027
|
},
|
|
@@ -34942,7 +35031,7 @@ export default {
|
|
|
34942
35031
|
type: 'string',
|
|
34943
35032
|
},
|
|
34944
35033
|
location: {
|
|
34945
|
-
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.',
|
|
34946
35035
|
properties: {
|
|
34947
35036
|
acs_entrance_ids: {
|
|
34948
35037
|
default: [],
|
|
@@ -34975,7 +35064,7 @@ export default {
|
|
|
34975
35064
|
items: {
|
|
34976
35065
|
properties: {
|
|
34977
35066
|
mode: {
|
|
34978
|
-
description: 'Access method mode.
|
|
35067
|
+
description: 'Access method mode.',
|
|
34979
35068
|
enum: ['code', 'card', 'mobile_key'],
|
|
34980
35069
|
type: 'string',
|
|
34981
35070
|
},
|
|
@@ -34986,7 +35075,7 @@ export default {
|
|
|
34986
35075
|
type: 'array',
|
|
34987
35076
|
},
|
|
34988
35077
|
space_ids: {
|
|
34989
|
-
description: '
|
|
35078
|
+
description: 'IDs of the existing spaces to which you want to grant access.',
|
|
34990
35079
|
items: { format: 'uuid', type: 'string' },
|
|
34991
35080
|
type: 'array',
|
|
34992
35081
|
},
|
|
@@ -35132,7 +35221,7 @@ export default {
|
|
|
35132
35221
|
},
|
|
35133
35222
|
'/unstable_access_grants/delete': {
|
|
35134
35223
|
post: {
|
|
35135
|
-
description: '
|
|
35224
|
+
description: 'Deletes an access grant.',
|
|
35136
35225
|
operationId: 'unstableAccessGrantsDeletePost',
|
|
35137
35226
|
requestBody: {
|
|
35138
35227
|
content: {
|
|
@@ -35140,7 +35229,7 @@ export default {
|
|
|
35140
35229
|
schema: {
|
|
35141
35230
|
properties: {
|
|
35142
35231
|
access_grant_id: {
|
|
35143
|
-
description: 'ID of access grant to delete.',
|
|
35232
|
+
description: 'ID of access grant that you want to delete.',
|
|
35144
35233
|
format: 'uuid',
|
|
35145
35234
|
type: 'string',
|
|
35146
35235
|
},
|
|
@@ -35184,7 +35273,7 @@ export default {
|
|
|
35184
35273
|
},
|
|
35185
35274
|
'/unstable_access_grants/get': {
|
|
35186
35275
|
post: {
|
|
35187
|
-
description: '
|
|
35276
|
+
description: 'Gets an access grant.',
|
|
35188
35277
|
operationId: 'unstableAccessGrantsGetPost',
|
|
35189
35278
|
requestBody: {
|
|
35190
35279
|
content: {
|
|
@@ -35192,7 +35281,7 @@ export default {
|
|
|
35192
35281
|
schema: {
|
|
35193
35282
|
properties: {
|
|
35194
35283
|
access_grant_id: {
|
|
35195
|
-
description: 'ID of access grant to get.',
|
|
35284
|
+
description: 'ID of access grant that you want to get.',
|
|
35196
35285
|
format: 'uuid',
|
|
35197
35286
|
type: 'string',
|
|
35198
35287
|
},
|
|
@@ -35331,7 +35420,7 @@ export default {
|
|
|
35331
35420
|
},
|
|
35332
35421
|
'/unstable_access_grants/list': {
|
|
35333
35422
|
post: {
|
|
35334
|
-
description: '
|
|
35423
|
+
description: 'Returns a list of all access grants.',
|
|
35335
35424
|
operationId: 'unstableAccessGrantsListPost',
|
|
35336
35425
|
requestBody: {
|
|
35337
35426
|
content: {
|
|
@@ -35339,12 +35428,12 @@ export default {
|
|
|
35339
35428
|
schema: {
|
|
35340
35429
|
properties: {
|
|
35341
35430
|
acs_entrance_id: {
|
|
35342
|
-
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.',
|
|
35343
35432
|
format: 'uuid',
|
|
35344
35433
|
type: 'string',
|
|
35345
35434
|
},
|
|
35346
35435
|
acs_system_id: {
|
|
35347
|
-
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.',
|
|
35348
35437
|
format: 'uuid',
|
|
35349
35438
|
type: 'string',
|
|
35350
35439
|
},
|
|
@@ -35355,12 +35444,12 @@ export default {
|
|
|
35355
35444
|
'x-deprecated': 'Use `space_id`.',
|
|
35356
35445
|
},
|
|
35357
35446
|
space_id: {
|
|
35358
|
-
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.',
|
|
35359
35448
|
format: 'uuid',
|
|
35360
35449
|
type: 'string',
|
|
35361
35450
|
},
|
|
35362
35451
|
user_identity_id: {
|
|
35363
|
-
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.',
|
|
35364
35453
|
format: 'uuid',
|
|
35365
35454
|
type: 'string',
|
|
35366
35455
|
},
|
|
@@ -35501,7 +35590,7 @@ export default {
|
|
|
35501
35590
|
},
|
|
35502
35591
|
'/unstable_access_methods/delete': {
|
|
35503
35592
|
post: {
|
|
35504
|
-
description: '
|
|
35593
|
+
description: 'Deletes an access method.',
|
|
35505
35594
|
operationId: 'unstableAccessMethodsDeletePost',
|
|
35506
35595
|
requestBody: {
|
|
35507
35596
|
content: {
|
|
@@ -35509,7 +35598,7 @@ export default {
|
|
|
35509
35598
|
schema: {
|
|
35510
35599
|
properties: {
|
|
35511
35600
|
access_method_id: {
|
|
35512
|
-
description: 'ID of access method to
|
|
35601
|
+
description: 'ID of the access method that you want to delete.',
|
|
35513
35602
|
format: 'uuid',
|
|
35514
35603
|
type: 'string',
|
|
35515
35604
|
},
|
|
@@ -35552,7 +35641,7 @@ export default {
|
|
|
35552
35641
|
},
|
|
35553
35642
|
'/unstable_access_methods/get': {
|
|
35554
35643
|
post: {
|
|
35555
|
-
description: '
|
|
35644
|
+
description: 'Gets an access method.',
|
|
35556
35645
|
operationId: 'unstableAccessMethodsGetPost',
|
|
35557
35646
|
requestBody: {
|
|
35558
35647
|
content: {
|
|
@@ -35560,7 +35649,7 @@ export default {
|
|
|
35560
35649
|
schema: {
|
|
35561
35650
|
properties: {
|
|
35562
35651
|
access_method_id: {
|
|
35563
|
-
description: 'ID of access method to get.',
|
|
35652
|
+
description: 'ID of the access method that you want to get.',
|
|
35564
35653
|
format: 'uuid',
|
|
35565
35654
|
type: 'string',
|
|
35566
35655
|
},
|
|
@@ -35657,7 +35746,7 @@ export default {
|
|
|
35657
35746
|
},
|
|
35658
35747
|
'/unstable_access_methods/list': {
|
|
35659
35748
|
post: {
|
|
35660
|
-
description: '
|
|
35749
|
+
description: 'Lists all access methods, usually filtered by access grant.',
|
|
35661
35750
|
operationId: 'unstableAccessMethodsListPost',
|
|
35662
35751
|
requestBody: {
|
|
35663
35752
|
content: {
|
|
@@ -35665,7 +35754,7 @@ export default {
|
|
|
35665
35754
|
schema: {
|
|
35666
35755
|
properties: {
|
|
35667
35756
|
access_grant_id: {
|
|
35668
|
-
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.',
|
|
35669
35758
|
format: 'uuid',
|
|
35670
35759
|
type: 'string',
|
|
35671
35760
|
},
|
|
@@ -35765,7 +35854,7 @@ export default {
|
|
|
35765
35854
|
},
|
|
35766
35855
|
'/unstable_locations/add_acs_entrances': {
|
|
35767
35856
|
post: {
|
|
35768
|
-
description: '
|
|
35857
|
+
description: 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.',
|
|
35769
35858
|
operationId: 'unstableLocationsAddAcsEntrancesPost',
|
|
35770
35859
|
requestBody: {
|
|
35771
35860
|
content: {
|
|
@@ -35773,11 +35862,16 @@ export default {
|
|
|
35773
35862
|
schema: {
|
|
35774
35863
|
properties: {
|
|
35775
35864
|
acs_entrance_ids: {
|
|
35865
|
+
description: 'IDs of the entrances that you want to add to the location.',
|
|
35776
35866
|
items: { format: 'uuid', type: 'string' },
|
|
35777
35867
|
minItems: 1,
|
|
35778
35868
|
type: 'array',
|
|
35779
35869
|
},
|
|
35780
|
-
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
|
+
},
|
|
35781
35875
|
},
|
|
35782
35876
|
required: ['location_id', 'acs_entrance_ids'],
|
|
35783
35877
|
type: 'object',
|
|
@@ -35811,11 +35905,11 @@ export default {
|
|
|
35811
35905
|
'x-fern-sdk-group-name': ['unstable_locations'],
|
|
35812
35906
|
'x-fern-sdk-method-name': 'add_acs_entrances',
|
|
35813
35907
|
'x-response-key': null,
|
|
35814
|
-
'x-title': 'Add
|
|
35908
|
+
'x-title': 'Add Entrances to a Location',
|
|
35815
35909
|
'x-undocumented': 'Experimental locations.',
|
|
35816
35910
|
},
|
|
35817
35911
|
put: {
|
|
35818
|
-
description: '
|
|
35912
|
+
description: 'Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.',
|
|
35819
35913
|
operationId: 'unstableLocationsAddAcsEntrancesPut',
|
|
35820
35914
|
requestBody: {
|
|
35821
35915
|
content: {
|
|
@@ -35823,11 +35917,16 @@ export default {
|
|
|
35823
35917
|
schema: {
|
|
35824
35918
|
properties: {
|
|
35825
35919
|
acs_entrance_ids: {
|
|
35920
|
+
description: 'IDs of the entrances that you want to add to the location.',
|
|
35826
35921
|
items: { format: 'uuid', type: 'string' },
|
|
35827
35922
|
minItems: 1,
|
|
35828
35923
|
type: 'array',
|
|
35829
35924
|
},
|
|
35830
|
-
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
|
+
},
|
|
35831
35930
|
},
|
|
35832
35931
|
required: ['location_id', 'acs_entrance_ids'],
|
|
35833
35932
|
type: 'object',
|
|
@@ -35860,13 +35959,13 @@ export default {
|
|
|
35860
35959
|
tags: [],
|
|
35861
35960
|
'x-fern-ignore': true,
|
|
35862
35961
|
'x-response-key': null,
|
|
35863
|
-
'x-title': 'Add
|
|
35962
|
+
'x-title': 'Add Entrances to a Location',
|
|
35864
35963
|
'x-undocumented': 'Experimental locations.',
|
|
35865
35964
|
},
|
|
35866
35965
|
},
|
|
35867
35966
|
'/unstable_locations/add_devices': {
|
|
35868
35967
|
post: {
|
|
35869
|
-
description: '
|
|
35968
|
+
description: 'Adds devices to a specific location.',
|
|
35870
35969
|
operationId: 'unstableLocationsAddDevicesPost',
|
|
35871
35970
|
requestBody: {
|
|
35872
35971
|
content: {
|
|
@@ -35874,11 +35973,16 @@ export default {
|
|
|
35874
35973
|
schema: {
|
|
35875
35974
|
properties: {
|
|
35876
35975
|
device_ids: {
|
|
35976
|
+
description: 'IDs of the devices that you want to add to the location.',
|
|
35877
35977
|
items: { format: 'uuid', type: 'string' },
|
|
35878
35978
|
minItems: 1,
|
|
35879
35979
|
type: 'array',
|
|
35880
35980
|
},
|
|
35881
|
-
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
|
+
},
|
|
35882
35986
|
},
|
|
35883
35987
|
required: ['location_id', 'device_ids'],
|
|
35884
35988
|
type: 'object',
|
|
@@ -35912,11 +36016,11 @@ export default {
|
|
|
35912
36016
|
'x-fern-sdk-group-name': ['unstable_locations'],
|
|
35913
36017
|
'x-fern-sdk-method-name': 'add_devices',
|
|
35914
36018
|
'x-response-key': null,
|
|
35915
|
-
'x-title': 'Add Location
|
|
36019
|
+
'x-title': 'Add Devices to a Location',
|
|
35916
36020
|
'x-undocumented': 'Experimental locations.',
|
|
35917
36021
|
},
|
|
35918
36022
|
put: {
|
|
35919
|
-
description: '
|
|
36023
|
+
description: 'Adds devices to a specific location.',
|
|
35920
36024
|
operationId: 'unstableLocationsAddDevicesPut',
|
|
35921
36025
|
requestBody: {
|
|
35922
36026
|
content: {
|
|
@@ -35924,11 +36028,16 @@ export default {
|
|
|
35924
36028
|
schema: {
|
|
35925
36029
|
properties: {
|
|
35926
36030
|
device_ids: {
|
|
36031
|
+
description: 'IDs of the devices that you want to add to the location.',
|
|
35927
36032
|
items: { format: 'uuid', type: 'string' },
|
|
35928
36033
|
minItems: 1,
|
|
35929
36034
|
type: 'array',
|
|
35930
36035
|
},
|
|
35931
|
-
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
|
+
},
|
|
35932
36041
|
},
|
|
35933
36042
|
required: ['location_id', 'device_ids'],
|
|
35934
36043
|
type: 'object',
|
|
@@ -35961,13 +36070,13 @@ export default {
|
|
|
35961
36070
|
tags: [],
|
|
35962
36071
|
'x-fern-ignore': true,
|
|
35963
36072
|
'x-response-key': null,
|
|
35964
|
-
'x-title': 'Add Location
|
|
36073
|
+
'x-title': 'Add Devices to a Location',
|
|
35965
36074
|
'x-undocumented': 'Experimental locations.',
|
|
35966
36075
|
},
|
|
35967
36076
|
},
|
|
35968
36077
|
'/unstable_locations/create': {
|
|
35969
36078
|
post: {
|
|
35970
|
-
description: '
|
|
36079
|
+
description: 'Creates a new location.',
|
|
35971
36080
|
operationId: 'unstableLocationsCreatePost',
|
|
35972
36081
|
requestBody: {
|
|
35973
36082
|
content: {
|
|
@@ -35975,14 +36084,17 @@ export default {
|
|
|
35975
36084
|
schema: {
|
|
35976
36085
|
properties: {
|
|
35977
36086
|
acs_entrance_ids: {
|
|
36087
|
+
description: 'IDs of the entrances that you want to add to the new location.',
|
|
35978
36088
|
items: { format: 'uuid', type: 'string' },
|
|
35979
36089
|
type: 'array',
|
|
35980
36090
|
},
|
|
35981
36091
|
device_ids: {
|
|
36092
|
+
description: 'IDs of the devices that you want to add to the new location.',
|
|
35982
36093
|
items: { format: 'uuid', type: 'string' },
|
|
35983
36094
|
type: 'array',
|
|
35984
36095
|
},
|
|
35985
36096
|
geolocation: {
|
|
36097
|
+
description: 'Geolocation of the new location.',
|
|
35986
36098
|
properties: {
|
|
35987
36099
|
latitude: { format: 'float', type: 'number' },
|
|
35988
36100
|
longitude: { format: 'float', type: 'number' },
|
|
@@ -35990,8 +36102,14 @@ export default {
|
|
|
35990
36102
|
required: ['latitude', 'longitude'],
|
|
35991
36103
|
type: 'object',
|
|
35992
36104
|
},
|
|
35993
|
-
name: {
|
|
35994
|
-
|
|
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
|
+
},
|
|
35995
36113
|
},
|
|
35996
36114
|
required: ['name'],
|
|
35997
36115
|
type: 'object',
|
|
@@ -36076,19 +36194,25 @@ export default {
|
|
|
36076
36194
|
'x-fern-sdk-method-name': 'create',
|
|
36077
36195
|
'x-fern-sdk-return-value': 'location',
|
|
36078
36196
|
'x-response-key': 'location',
|
|
36079
|
-
'x-title': 'Create Location',
|
|
36197
|
+
'x-title': 'Create a Location',
|
|
36080
36198
|
'x-undocumented': 'Experimental locations.',
|
|
36081
36199
|
},
|
|
36082
36200
|
},
|
|
36083
36201
|
'/unstable_locations/delete': {
|
|
36084
36202
|
post: {
|
|
36085
|
-
description: '
|
|
36203
|
+
description: 'Deletes a location.',
|
|
36086
36204
|
operationId: 'unstableLocationsDeletePost',
|
|
36087
36205
|
requestBody: {
|
|
36088
36206
|
content: {
|
|
36089
36207
|
'application/json': {
|
|
36090
36208
|
schema: {
|
|
36091
|
-
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
|
+
},
|
|
36092
36216
|
required: ['location_id'],
|
|
36093
36217
|
type: 'object',
|
|
36094
36218
|
},
|
|
@@ -36121,19 +36245,25 @@ export default {
|
|
|
36121
36245
|
'x-fern-sdk-group-name': ['unstable_locations'],
|
|
36122
36246
|
'x-fern-sdk-method-name': 'delete',
|
|
36123
36247
|
'x-response-key': null,
|
|
36124
|
-
'x-title': 'Delete Location',
|
|
36248
|
+
'x-title': 'Delete a Location',
|
|
36125
36249
|
'x-undocumented': 'Experimental locations.',
|
|
36126
36250
|
},
|
|
36127
36251
|
},
|
|
36128
36252
|
'/unstable_locations/get': {
|
|
36129
36253
|
post: {
|
|
36130
|
-
description: '
|
|
36254
|
+
description: 'Gets a location.',
|
|
36131
36255
|
operationId: 'unstableLocationsGetPost',
|
|
36132
36256
|
requestBody: {
|
|
36133
36257
|
content: {
|
|
36134
36258
|
'application/json': {
|
|
36135
36259
|
schema: {
|
|
36136
|
-
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
|
+
},
|
|
36137
36267
|
required: ['location_id'],
|
|
36138
36268
|
type: 'object',
|
|
36139
36269
|
},
|
|
@@ -36217,7 +36347,7 @@ export default {
|
|
|
36217
36347
|
'x-fern-sdk-method-name': 'get',
|
|
36218
36348
|
'x-fern-sdk-return-value': 'location',
|
|
36219
36349
|
'x-response-key': 'location',
|
|
36220
|
-
'x-title': 'Get Location',
|
|
36350
|
+
'x-title': 'Get a Location',
|
|
36221
36351
|
'x-undocumented': 'Experimental locations.',
|
|
36222
36352
|
},
|
|
36223
36353
|
},
|
|
@@ -36395,7 +36525,7 @@ export default {
|
|
|
36395
36525
|
},
|
|
36396
36526
|
'/unstable_locations/remove_acs_entrances': {
|
|
36397
36527
|
post: {
|
|
36398
|
-
description: '
|
|
36528
|
+
description: 'Removes entrances from a specific location.',
|
|
36399
36529
|
operationId: 'unstableLocationsRemoveAcsEntrancesPost',
|
|
36400
36530
|
requestBody: {
|
|
36401
36531
|
content: {
|
|
@@ -36403,10 +36533,15 @@ export default {
|
|
|
36403
36533
|
schema: {
|
|
36404
36534
|
properties: {
|
|
36405
36535
|
acs_entrance_ids: {
|
|
36536
|
+
description: 'IDs of the entrances that you want to remove from the location.',
|
|
36406
36537
|
items: { format: 'uuid', type: 'string' },
|
|
36407
36538
|
type: 'array',
|
|
36408
36539
|
},
|
|
36409
|
-
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
|
+
},
|
|
36410
36545
|
},
|
|
36411
36546
|
required: ['location_id', 'acs_entrance_ids'],
|
|
36412
36547
|
type: 'object',
|
|
@@ -36440,13 +36575,13 @@ export default {
|
|
|
36440
36575
|
'x-fern-sdk-group-name': ['unstable_locations'],
|
|
36441
36576
|
'x-fern-sdk-method-name': 'remove_acs_entrances',
|
|
36442
36577
|
'x-response-key': null,
|
|
36443
|
-
'x-title': 'Remove
|
|
36578
|
+
'x-title': 'Remove Entrances from a Location',
|
|
36444
36579
|
'x-undocumented': 'Experimental locations.',
|
|
36445
36580
|
},
|
|
36446
36581
|
},
|
|
36447
36582
|
'/unstable_locations/remove_devices': {
|
|
36448
36583
|
post: {
|
|
36449
|
-
description: '
|
|
36584
|
+
description: 'Removes devices from a specific location.',
|
|
36450
36585
|
operationId: 'unstableLocationsRemoveDevicesPost',
|
|
36451
36586
|
requestBody: {
|
|
36452
36587
|
content: {
|
|
@@ -36454,10 +36589,15 @@ export default {
|
|
|
36454
36589
|
schema: {
|
|
36455
36590
|
properties: {
|
|
36456
36591
|
device_ids: {
|
|
36592
|
+
description: 'IDs of the devices that you want to remove from the location.',
|
|
36457
36593
|
items: { format: 'uuid', type: 'string' },
|
|
36458
36594
|
type: 'array',
|
|
36459
36595
|
},
|
|
36460
|
-
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
|
+
},
|
|
36461
36601
|
},
|
|
36462
36602
|
required: ['location_id', 'device_ids'],
|
|
36463
36603
|
type: 'object',
|
|
@@ -36491,13 +36631,13 @@ export default {
|
|
|
36491
36631
|
'x-fern-sdk-group-name': ['unstable_locations'],
|
|
36492
36632
|
'x-fern-sdk-method-name': 'remove_devices',
|
|
36493
36633
|
'x-response-key': null,
|
|
36494
|
-
'x-title': 'Remove Location
|
|
36634
|
+
'x-title': 'Remove Devices from a Location',
|
|
36495
36635
|
'x-undocumented': 'Experimental locations.',
|
|
36496
36636
|
},
|
|
36497
36637
|
},
|
|
36498
36638
|
'/unstable_locations/update': {
|
|
36499
36639
|
patch: {
|
|
36500
|
-
description: '
|
|
36640
|
+
description: 'Updates a location.',
|
|
36501
36641
|
operationId: 'unstableLocationsUpdatePatch',
|
|
36502
36642
|
requestBody: {
|
|
36503
36643
|
content: {
|
|
@@ -36505,6 +36645,7 @@ export default {
|
|
|
36505
36645
|
schema: {
|
|
36506
36646
|
properties: {
|
|
36507
36647
|
geolocation: {
|
|
36648
|
+
description: 'Geolocation of the location.',
|
|
36508
36649
|
properties: {
|
|
36509
36650
|
latitude: { format: 'float', type: 'number' },
|
|
36510
36651
|
longitude: { format: 'float', type: 'number' },
|
|
@@ -36512,9 +36653,19 @@ export default {
|
|
|
36512
36653
|
required: ['latitude', 'longitude'],
|
|
36513
36654
|
type: 'object',
|
|
36514
36655
|
},
|
|
36515
|
-
location_id: {
|
|
36516
|
-
|
|
36517
|
-
|
|
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
|
+
},
|
|
36518
36669
|
},
|
|
36519
36670
|
required: ['location_id'],
|
|
36520
36671
|
type: 'object',
|
|
@@ -36597,11 +36748,11 @@ export default {
|
|
|
36597
36748
|
tags: [],
|
|
36598
36749
|
'x-fern-ignore': true,
|
|
36599
36750
|
'x-response-key': 'location',
|
|
36600
|
-
'x-title': 'Update Location',
|
|
36751
|
+
'x-title': 'Update a Location',
|
|
36601
36752
|
'x-undocumented': 'Experimental locations.',
|
|
36602
36753
|
},
|
|
36603
36754
|
post: {
|
|
36604
|
-
description: '
|
|
36755
|
+
description: 'Updates a location.',
|
|
36605
36756
|
operationId: 'unstableLocationsUpdatePost',
|
|
36606
36757
|
requestBody: {
|
|
36607
36758
|
content: {
|
|
@@ -36609,6 +36760,7 @@ export default {
|
|
|
36609
36760
|
schema: {
|
|
36610
36761
|
properties: {
|
|
36611
36762
|
geolocation: {
|
|
36763
|
+
description: 'Geolocation of the location.',
|
|
36612
36764
|
properties: {
|
|
36613
36765
|
latitude: { format: 'float', type: 'number' },
|
|
36614
36766
|
longitude: { format: 'float', type: 'number' },
|
|
@@ -36616,9 +36768,19 @@ export default {
|
|
|
36616
36768
|
required: ['latitude', 'longitude'],
|
|
36617
36769
|
type: 'object',
|
|
36618
36770
|
},
|
|
36619
|
-
location_id: {
|
|
36620
|
-
|
|
36621
|
-
|
|
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
|
+
},
|
|
36622
36784
|
},
|
|
36623
36785
|
required: ['location_id'],
|
|
36624
36786
|
type: 'object',
|
|
@@ -36703,7 +36865,7 @@ export default {
|
|
|
36703
36865
|
'x-fern-sdk-method-name': 'update',
|
|
36704
36866
|
'x-fern-sdk-return-value': 'location',
|
|
36705
36867
|
'x-response-key': 'location',
|
|
36706
|
-
'x-title': 'Update Location',
|
|
36868
|
+
'x-title': 'Update a Location',
|
|
36707
36869
|
'x-undocumented': 'Experimental locations.',
|
|
36708
36870
|
},
|
|
36709
36871
|
},
|
|
@@ -36715,7 +36877,12 @@ export default {
|
|
|
36715
36877
|
content: {
|
|
36716
36878
|
'application/json': {
|
|
36717
36879
|
schema: {
|
|
36718
|
-
properties: {
|
|
36880
|
+
properties: {
|
|
36881
|
+
customer_key: {
|
|
36882
|
+
description: 'Customer key for which you want to connect accounts.',
|
|
36883
|
+
type: 'string',
|
|
36884
|
+
},
|
|
36885
|
+
},
|
|
36719
36886
|
required: ['customer_key'],
|
|
36720
36887
|
type: 'object',
|
|
36721
36888
|
},
|
|
@@ -36752,7 +36919,7 @@ export default {
|
|
|
36752
36919
|
'x-fern-sdk-method-name': 'connect_accounts',
|
|
36753
36920
|
'x-fern-sdk-return-value': 'magic_link',
|
|
36754
36921
|
'x-response-key': 'magic_link',
|
|
36755
|
-
'x-title': 'Connect Accounts',
|
|
36922
|
+
'x-title': 'Generate a Connect Accounts Building Block Magic Link',
|
|
36756
36923
|
'x-undocumented': 'Experimental partner building blocks.',
|
|
36757
36924
|
},
|
|
36758
36925
|
},
|
|
@@ -36768,10 +36935,14 @@ export default {
|
|
|
36768
36935
|
{
|
|
36769
36936
|
properties: {
|
|
36770
36937
|
building_block_type: {
|
|
36938
|
+
description: '`connect_accounts` building block type.',
|
|
36771
36939
|
enum: ['connect_accounts'],
|
|
36772
36940
|
type: 'string',
|
|
36773
36941
|
},
|
|
36774
|
-
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
|
+
},
|
|
36775
36946
|
},
|
|
36776
36947
|
required: ['building_block_type', 'customer_key'],
|
|
36777
36948
|
type: 'object',
|
|
@@ -36779,10 +36950,14 @@ export default {
|
|
|
36779
36950
|
{
|
|
36780
36951
|
properties: {
|
|
36781
36952
|
building_block_type: {
|
|
36953
|
+
description: '`manage_devices` building block type.',
|
|
36782
36954
|
enum: ['manage_devices'],
|
|
36783
36955
|
type: 'string',
|
|
36784
36956
|
},
|
|
36785
|
-
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
|
+
},
|
|
36786
36961
|
},
|
|
36787
36962
|
required: ['building_block_type', 'customer_key'],
|
|
36788
36963
|
type: 'object',
|
|
@@ -36790,12 +36965,16 @@ export default {
|
|
|
36790
36965
|
{
|
|
36791
36966
|
properties: {
|
|
36792
36967
|
building_block_type: {
|
|
36968
|
+
description: '`organize_spaces` building block type.',
|
|
36793
36969
|
enum: ['organize_spaces'],
|
|
36794
36970
|
type: 'string',
|
|
36795
36971
|
},
|
|
36796
|
-
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
|
+
},
|
|
36797
36976
|
partner_resources: {
|
|
36798
|
-
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.',
|
|
36799
36978
|
items: {
|
|
36800
36979
|
properties: {
|
|
36801
36980
|
custom_metadata: {
|
|
@@ -36852,7 +37031,7 @@ export default {
|
|
|
36852
37031
|
'x-fern-sdk-method-name': 'generate_magic_link',
|
|
36853
37032
|
'x-fern-sdk-return-value': 'magic_link',
|
|
36854
37033
|
'x-response-key': 'magic_link',
|
|
36855
|
-
'x-title': 'Generate a
|
|
37034
|
+
'x-title': 'Generate a Building Block Magic Link',
|
|
36856
37035
|
'x-undocumented': 'Experimental partner building blocks.',
|
|
36857
37036
|
},
|
|
36858
37037
|
},
|
|
@@ -36864,7 +37043,12 @@ export default {
|
|
|
36864
37043
|
content: {
|
|
36865
37044
|
'application/json': {
|
|
36866
37045
|
schema: {
|
|
36867
|
-
properties: {
|
|
37046
|
+
properties: {
|
|
37047
|
+
customer_key: {
|
|
37048
|
+
description: 'Customer key for which you want to manage devices.',
|
|
37049
|
+
type: 'string',
|
|
37050
|
+
},
|
|
37051
|
+
},
|
|
36868
37052
|
required: ['customer_key'],
|
|
36869
37053
|
type: 'object',
|
|
36870
37054
|
},
|
|
@@ -36901,7 +37085,7 @@ export default {
|
|
|
36901
37085
|
'x-fern-sdk-method-name': 'manage_devices',
|
|
36902
37086
|
'x-fern-sdk-return-value': 'magic_link',
|
|
36903
37087
|
'x-response-key': 'magic_link',
|
|
36904
|
-
'x-title': 'Manage Devices',
|
|
37088
|
+
'x-title': 'Generate a Manage Devices Building Block Magic Link',
|
|
36905
37089
|
'x-undocumented': 'Experimental partner building blocks.',
|
|
36906
37090
|
},
|
|
36907
37091
|
},
|
|
@@ -36914,8 +37098,12 @@ export default {
|
|
|
36914
37098
|
'application/json': {
|
|
36915
37099
|
schema: {
|
|
36916
37100
|
properties: {
|
|
36917
|
-
customer_key: {
|
|
37101
|
+
customer_key: {
|
|
37102
|
+
description: 'Customer key for which you want to organize spaces.',
|
|
37103
|
+
type: 'string',
|
|
37104
|
+
},
|
|
36918
37105
|
partner_resources: {
|
|
37106
|
+
description: 'Optional list of partner resources that you want to include in the new building block magic link.',
|
|
36919
37107
|
items: {
|
|
36920
37108
|
properties: {
|
|
36921
37109
|
custom_metadata: {
|
|
@@ -36970,13 +37158,13 @@ export default {
|
|
|
36970
37158
|
'x-fern-sdk-method-name': 'organize_spaces',
|
|
36971
37159
|
'x-fern-sdk-return-value': 'magic_link',
|
|
36972
37160
|
'x-response-key': 'magic_link',
|
|
36973
|
-
'x-title': 'Organize Spaces',
|
|
37161
|
+
'x-title': 'Generate an Organize Spaces Building Block Magic Link',
|
|
36974
37162
|
'x-undocumented': 'Experimental partner building blocks.',
|
|
36975
37163
|
},
|
|
36976
37164
|
},
|
|
36977
37165
|
'/unstable_partner/resources/push': {
|
|
36978
37166
|
post: {
|
|
36979
|
-
description: '
|
|
37167
|
+
description: 'Sends Seam some of your resources.',
|
|
36980
37168
|
operationId: 'unstablePartnerResourcesPushPost',
|
|
36981
37169
|
requestBody: {
|
|
36982
37170
|
content: {
|
|
@@ -36990,7 +37178,10 @@ export default {
|
|
|
36990
37178
|
additionalProperties: { type: 'string' },
|
|
36991
37179
|
type: 'object',
|
|
36992
37180
|
},
|
|
36993
|
-
customer_key: {
|
|
37181
|
+
customer_key: {
|
|
37182
|
+
description: 'Customer key associated with the resource that you want to push to Seam.',
|
|
37183
|
+
type: 'string',
|
|
37184
|
+
},
|
|
36994
37185
|
description: { type: 'string' },
|
|
36995
37186
|
email_address: { type: 'string' },
|
|
36996
37187
|
ends_at: { type: 'string' },
|
|
@@ -36999,8 +37190,14 @@ export default {
|
|
|
36999
37190
|
type: 'array',
|
|
37000
37191
|
},
|
|
37001
37192
|
name: { type: 'string' },
|
|
37002
|
-
partner_resource_key: {
|
|
37003
|
-
|
|
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
|
+
},
|
|
37004
37201
|
phone_number: { type: 'string' },
|
|
37005
37202
|
starts_at: { type: 'string' },
|
|
37006
37203
|
user_identity_key: { type: 'string' },
|
|
@@ -37017,7 +37214,10 @@ export default {
|
|
|
37017
37214
|
additionalProperties: { type: 'string' },
|
|
37018
37215
|
type: 'object',
|
|
37019
37216
|
},
|
|
37020
|
-
customer_key: {
|
|
37217
|
+
customer_key: {
|
|
37218
|
+
description: 'Customer key associated with the resource that you want to push to Seam.',
|
|
37219
|
+
type: 'string',
|
|
37220
|
+
},
|
|
37021
37221
|
description: { type: 'string' },
|
|
37022
37222
|
email_address: { type: 'string' },
|
|
37023
37223
|
ends_at: { type: 'string' },
|
|
@@ -37026,8 +37226,14 @@ export default {
|
|
|
37026
37226
|
type: 'array',
|
|
37027
37227
|
},
|
|
37028
37228
|
name: { type: 'string' },
|
|
37029
|
-
partner_resource_key: {
|
|
37030
|
-
|
|
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
|
+
},
|
|
37031
37237
|
phone_number: { type: 'string' },
|
|
37032
37238
|
starts_at: { type: 'string' },
|
|
37033
37239
|
user_identity_key: { type: 'string' },
|
|
@@ -37067,13 +37273,13 @@ export default {
|
|
|
37067
37273
|
'x-fern-sdk-group-name': ['unstable_partner', 'resources'],
|
|
37068
37274
|
'x-fern-sdk-method-name': 'push',
|
|
37069
37275
|
'x-response-key': null,
|
|
37070
|
-
'x-title': 'Push
|
|
37276
|
+
'x-title': 'Push Partner Resources at Seam',
|
|
37071
37277
|
'x-undocumented': 'Experimental partner resources.',
|
|
37072
37278
|
},
|
|
37073
37279
|
},
|
|
37074
37280
|
'/user_identities/add_acs_user': {
|
|
37075
37281
|
post: {
|
|
37076
|
-
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).',
|
|
37077
37283
|
operationId: 'userIdentitiesAddAcsUserPost',
|
|
37078
37284
|
requestBody: {
|
|
37079
37285
|
content: {
|
|
@@ -37081,12 +37287,12 @@ export default {
|
|
|
37081
37287
|
schema: {
|
|
37082
37288
|
properties: {
|
|
37083
37289
|
acs_user_id: {
|
|
37084
|
-
description: 'ID of the
|
|
37290
|
+
description: 'ID of the access system user that you want to add to the user identity.',
|
|
37085
37291
|
format: 'uuid',
|
|
37086
37292
|
type: 'string',
|
|
37087
37293
|
},
|
|
37088
37294
|
user_identity_id: {
|
|
37089
|
-
description: 'ID of the
|
|
37295
|
+
description: 'ID of the user identity to which you want to add an access system user.',
|
|
37090
37296
|
format: 'uuid',
|
|
37091
37297
|
type: 'string',
|
|
37092
37298
|
},
|
|
@@ -37126,7 +37332,7 @@ export default {
|
|
|
37126
37332
|
'x-title': 'Add an ACS User to a User Identity',
|
|
37127
37333
|
},
|
|
37128
37334
|
put: {
|
|
37129
|
-
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).',
|
|
37130
37336
|
operationId: 'userIdentitiesAddAcsUserPut',
|
|
37131
37337
|
requestBody: {
|
|
37132
37338
|
content: {
|
|
@@ -37134,12 +37340,12 @@ export default {
|
|
|
37134
37340
|
schema: {
|
|
37135
37341
|
properties: {
|
|
37136
37342
|
acs_user_id: {
|
|
37137
|
-
description: 'ID of the
|
|
37343
|
+
description: 'ID of the access system user that you want to add to the user identity.',
|
|
37138
37344
|
format: 'uuid',
|
|
37139
37345
|
type: 'string',
|
|
37140
37346
|
},
|
|
37141
37347
|
user_identity_id: {
|
|
37142
|
-
description: 'ID of the
|
|
37348
|
+
description: 'ID of the user identity to which you want to add an access system user.',
|
|
37143
37349
|
format: 'uuid',
|
|
37144
37350
|
type: 'string',
|
|
37145
37351
|
},
|
|
@@ -37188,29 +37394,29 @@ export default {
|
|
|
37188
37394
|
schema: {
|
|
37189
37395
|
properties: {
|
|
37190
37396
|
acs_system_ids: {
|
|
37191
|
-
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.",
|
|
37192
37398
|
items: { format: 'uuid', type: 'string' },
|
|
37193
37399
|
type: 'array',
|
|
37194
37400
|
},
|
|
37195
37401
|
email_address: {
|
|
37196
|
-
description: 'Unique email address for the user identity.',
|
|
37402
|
+
description: 'Unique email address for the new user identity.',
|
|
37197
37403
|
format: 'email',
|
|
37198
37404
|
nullable: true,
|
|
37199
37405
|
type: 'string',
|
|
37200
37406
|
},
|
|
37201
37407
|
full_name: {
|
|
37202
|
-
description: 'Full name of the user associated with the user identity.',
|
|
37408
|
+
description: 'Full name of the user associated with the new user identity.',
|
|
37203
37409
|
minLength: 1,
|
|
37204
37410
|
nullable: true,
|
|
37205
37411
|
type: 'string',
|
|
37206
37412
|
},
|
|
37207
37413
|
phone_number: {
|
|
37208
|
-
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).',
|
|
37209
37415
|
nullable: true,
|
|
37210
37416
|
type: 'string',
|
|
37211
37417
|
},
|
|
37212
37418
|
user_identity_key: {
|
|
37213
|
-
description: 'Unique key for the user identity.',
|
|
37419
|
+
description: 'Unique key for the new user identity.',
|
|
37214
37420
|
minLength: 1,
|
|
37215
37421
|
nullable: true,
|
|
37216
37422
|
type: 'string',
|
|
@@ -37266,7 +37472,7 @@ export default {
|
|
|
37266
37472
|
schema: {
|
|
37267
37473
|
properties: {
|
|
37268
37474
|
user_identity_id: {
|
|
37269
|
-
description: 'ID of the
|
|
37475
|
+
description: 'ID of the user identity that you want to delete.',
|
|
37270
37476
|
format: 'uuid',
|
|
37271
37477
|
type: 'string',
|
|
37272
37478
|
},
|
|
@@ -37316,7 +37522,7 @@ export default {
|
|
|
37316
37522
|
schema: {
|
|
37317
37523
|
properties: {
|
|
37318
37524
|
enrollment_automation_id: {
|
|
37319
|
-
description: 'ID of the
|
|
37525
|
+
description: 'ID of the enrollment automation that you want to delete.',
|
|
37320
37526
|
format: 'uuid',
|
|
37321
37527
|
type: 'string',
|
|
37322
37528
|
},
|
|
@@ -37366,7 +37572,7 @@ export default {
|
|
|
37366
37572
|
schema: {
|
|
37367
37573
|
properties: {
|
|
37368
37574
|
enrollment_automation_id: {
|
|
37369
|
-
description: 'ID of the
|
|
37575
|
+
description: 'ID of the enrollment automation that you want to get.',
|
|
37370
37576
|
format: 'uuid',
|
|
37371
37577
|
type: 'string',
|
|
37372
37578
|
},
|
|
@@ -37423,7 +37629,7 @@ export default {
|
|
|
37423
37629
|
schema: {
|
|
37424
37630
|
properties: {
|
|
37425
37631
|
acs_credential_pool_id: {
|
|
37426
|
-
description: 'ID of the
|
|
37632
|
+
description: 'ID of the credential pool from which to obtain credentials for the user identity.',
|
|
37427
37633
|
format: 'uuid',
|
|
37428
37634
|
type: 'string',
|
|
37429
37635
|
},
|
|
@@ -37432,17 +37638,17 @@ export default {
|
|
|
37432
37638
|
type: 'boolean',
|
|
37433
37639
|
},
|
|
37434
37640
|
credential_manager_acs_system_id: {
|
|
37435
|
-
description: 'ID of the desired
|
|
37641
|
+
description: 'ID of the desired access system that serves as the credential manager for the enrollment automation.',
|
|
37436
37642
|
format: 'uuid',
|
|
37437
37643
|
type: 'string',
|
|
37438
37644
|
},
|
|
37439
37645
|
credential_manager_acs_user_id: {
|
|
37440
|
-
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`.',
|
|
37441
37647
|
format: 'uuid',
|
|
37442
37648
|
type: 'string',
|
|
37443
37649
|
},
|
|
37444
37650
|
user_identity_id: {
|
|
37445
|
-
description: 'ID of the
|
|
37651
|
+
description: 'ID of the user identity for which you want to launch an enrollment automation.',
|
|
37446
37652
|
format: 'uuid',
|
|
37447
37653
|
type: 'string',
|
|
37448
37654
|
},
|
|
@@ -37526,7 +37732,7 @@ export default {
|
|
|
37526
37732
|
schema: {
|
|
37527
37733
|
properties: {
|
|
37528
37734
|
user_identity_id: {
|
|
37529
|
-
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.',
|
|
37530
37736
|
format: 'uuid',
|
|
37531
37737
|
type: 'string',
|
|
37532
37738
|
},
|
|
@@ -37587,7 +37793,7 @@ export default {
|
|
|
37587
37793
|
properties: {
|
|
37588
37794
|
max_use_count: {
|
|
37589
37795
|
default: 1,
|
|
37590
|
-
description: '
|
|
37796
|
+
description: 'Maximum number of times the instant key can be used. Default: 1.',
|
|
37591
37797
|
format: 'float',
|
|
37592
37798
|
type: 'number',
|
|
37593
37799
|
},
|
|
@@ -37648,7 +37854,7 @@ export default {
|
|
|
37648
37854
|
{
|
|
37649
37855
|
properties: {
|
|
37650
37856
|
user_identity_id: {
|
|
37651
|
-
description: 'ID of the
|
|
37857
|
+
description: 'ID of the user identity that you want to get.',
|
|
37652
37858
|
format: 'uuid',
|
|
37653
37859
|
type: 'string',
|
|
37654
37860
|
},
|
|
@@ -37711,12 +37917,12 @@ export default {
|
|
|
37711
37917
|
schema: {
|
|
37712
37918
|
properties: {
|
|
37713
37919
|
device_id: {
|
|
37714
|
-
description: 'ID of the
|
|
37920
|
+
description: 'ID of the managed device to which you want to grant access to the user identity.',
|
|
37715
37921
|
format: 'uuid',
|
|
37716
37922
|
type: 'string',
|
|
37717
37923
|
},
|
|
37718
37924
|
user_identity_id: {
|
|
37719
|
-
description: 'ID of the
|
|
37925
|
+
description: 'ID of the user identity that you want to grant access to a device.',
|
|
37720
37926
|
format: 'uuid',
|
|
37721
37927
|
type: 'string',
|
|
37722
37928
|
},
|
|
@@ -37764,12 +37970,12 @@ export default {
|
|
|
37764
37970
|
schema: {
|
|
37765
37971
|
properties: {
|
|
37766
37972
|
device_id: {
|
|
37767
|
-
description: 'ID of the
|
|
37973
|
+
description: 'ID of the managed device to which you want to grant access to the user identity.',
|
|
37768
37974
|
format: 'uuid',
|
|
37769
37975
|
type: 'string',
|
|
37770
37976
|
},
|
|
37771
37977
|
user_identity_id: {
|
|
37772
|
-
description: 'ID of the
|
|
37978
|
+
description: 'ID of the user identity that you want to grant access to a device.',
|
|
37773
37979
|
format: 'uuid',
|
|
37774
37980
|
type: 'string',
|
|
37775
37981
|
},
|
|
@@ -37818,6 +38024,7 @@ export default {
|
|
|
37818
38024
|
schema: {
|
|
37819
38025
|
properties: {
|
|
37820
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.',
|
|
37821
38028
|
format: 'uuid',
|
|
37822
38029
|
type: 'string',
|
|
37823
38030
|
},
|
|
@@ -37895,7 +38102,7 @@ export default {
|
|
|
37895
38102
|
deprecated: true,
|
|
37896
38103
|
items: { $ref: '#/components/schemas/device' },
|
|
37897
38104
|
type: 'array',
|
|
37898
|
-
'x-deprecated': '
|
|
38105
|
+
'x-deprecated': 'Use devices.',
|
|
37899
38106
|
},
|
|
37900
38107
|
devices: {
|
|
37901
38108
|
items: { $ref: '#/components/schemas/device' },
|
|
@@ -37929,7 +38136,7 @@ export default {
|
|
|
37929
38136
|
},
|
|
37930
38137
|
'/user_identities/list_acs_systems': {
|
|
37931
38138
|
post: {
|
|
37932
|
-
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).',
|
|
37933
38140
|
operationId: 'userIdentitiesListAcsSystemsPost',
|
|
37934
38141
|
requestBody: {
|
|
37935
38142
|
content: {
|
|
@@ -37937,7 +38144,7 @@ export default {
|
|
|
37937
38144
|
schema: {
|
|
37938
38145
|
properties: {
|
|
37939
38146
|
user_identity_id: {
|
|
37940
|
-
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.',
|
|
37941
38148
|
format: 'uuid',
|
|
37942
38149
|
type: 'string',
|
|
37943
38150
|
},
|
|
@@ -37987,7 +38194,7 @@ export default {
|
|
|
37987
38194
|
},
|
|
37988
38195
|
'/user_identities/list_acs_users': {
|
|
37989
38196
|
post: {
|
|
37990
|
-
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).',
|
|
37991
38198
|
operationId: 'userIdentitiesListAcsUsersPost',
|
|
37992
38199
|
requestBody: {
|
|
37993
38200
|
content: {
|
|
@@ -37995,7 +38202,7 @@ export default {
|
|
|
37995
38202
|
schema: {
|
|
37996
38203
|
properties: {
|
|
37997
38204
|
user_identity_id: {
|
|
37998
|
-
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.',
|
|
37999
38206
|
format: 'uuid',
|
|
38000
38207
|
type: 'string',
|
|
38001
38208
|
},
|
|
@@ -38044,7 +38251,7 @@ export default {
|
|
|
38044
38251
|
},
|
|
38045
38252
|
'/user_identities/remove_acs_user': {
|
|
38046
38253
|
post: {
|
|
38047
|
-
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).',
|
|
38048
38255
|
operationId: 'userIdentitiesRemoveAcsUserPost',
|
|
38049
38256
|
requestBody: {
|
|
38050
38257
|
content: {
|
|
@@ -38052,12 +38259,12 @@ export default {
|
|
|
38052
38259
|
schema: {
|
|
38053
38260
|
properties: {
|
|
38054
38261
|
acs_user_id: {
|
|
38055
|
-
description: 'ID of the
|
|
38262
|
+
description: 'ID of the access system user that you want to remove from the user identity..',
|
|
38056
38263
|
format: 'uuid',
|
|
38057
38264
|
type: 'string',
|
|
38058
38265
|
},
|
|
38059
38266
|
user_identity_id: {
|
|
38060
|
-
description: 'ID of the
|
|
38267
|
+
description: 'ID of the user identity from which you want to remove an access system user.',
|
|
38061
38268
|
format: 'uuid',
|
|
38062
38269
|
type: 'string',
|
|
38063
38270
|
},
|
|
@@ -38107,12 +38314,12 @@ export default {
|
|
|
38107
38314
|
schema: {
|
|
38108
38315
|
properties: {
|
|
38109
38316
|
device_id: {
|
|
38110
|
-
description: 'ID of the
|
|
38317
|
+
description: 'ID of the managed device to which you want to revoke access from the user identity.',
|
|
38111
38318
|
format: 'uuid',
|
|
38112
38319
|
type: 'string',
|
|
38113
38320
|
},
|
|
38114
38321
|
user_identity_id: {
|
|
38115
|
-
description: 'ID of the
|
|
38322
|
+
description: 'ID of the user identity from which you want to revoke access to a device.',
|
|
38116
38323
|
format: 'uuid',
|
|
38117
38324
|
type: 'string',
|
|
38118
38325
|
},
|
|
@@ -38154,6 +38361,7 @@ export default {
|
|
|
38154
38361
|
},
|
|
38155
38362
|
'/user_identities/update': {
|
|
38156
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).',
|
|
38157
38365
|
operationId: 'userIdentitiesUpdatePatch',
|
|
38158
38366
|
requestBody: {
|
|
38159
38367
|
content: {
|
|
@@ -38166,14 +38374,19 @@ export default {
|
|
|
38166
38374
|
nullable: true,
|
|
38167
38375
|
type: 'string',
|
|
38168
38376
|
},
|
|
38169
|
-
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
|
+
},
|
|
38170
38383
|
phone_number: {
|
|
38171
|
-
description: 'Unique phone number for the user identity
|
|
38384
|
+
description: 'Unique phone number for the user identity.',
|
|
38172
38385
|
nullable: true,
|
|
38173
38386
|
type: 'string',
|
|
38174
38387
|
},
|
|
38175
38388
|
user_identity_id: {
|
|
38176
|
-
description: 'ID of the user identity.',
|
|
38389
|
+
description: 'ID of the user identity that you want to update.',
|
|
38177
38390
|
format: 'uuid',
|
|
38178
38391
|
type: 'string',
|
|
38179
38392
|
},
|
|
@@ -38218,6 +38431,7 @@ export default {
|
|
|
38218
38431
|
'x-title': 'Update a User Identity',
|
|
38219
38432
|
},
|
|
38220
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).',
|
|
38221
38435
|
operationId: 'userIdentitiesUpdatePost',
|
|
38222
38436
|
requestBody: {
|
|
38223
38437
|
content: {
|
|
@@ -38230,14 +38444,19 @@ export default {
|
|
|
38230
38444
|
nullable: true,
|
|
38231
38445
|
type: 'string',
|
|
38232
38446
|
},
|
|
38233
|
-
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
|
+
},
|
|
38234
38453
|
phone_number: {
|
|
38235
|
-
description: 'Unique phone number for the user identity
|
|
38454
|
+
description: 'Unique phone number for the user identity.',
|
|
38236
38455
|
nullable: true,
|
|
38237
38456
|
type: 'string',
|
|
38238
38457
|
},
|
|
38239
38458
|
user_identity_id: {
|
|
38240
|
-
description: 'ID of the user identity.',
|
|
38459
|
+
description: 'ID of the user identity that you want to update.',
|
|
38241
38460
|
format: 'uuid',
|
|
38242
38461
|
type: 'string',
|
|
38243
38462
|
},
|
|
@@ -38285,6 +38504,7 @@ export default {
|
|
|
38285
38504
|
},
|
|
38286
38505
|
'/webhooks/create': {
|
|
38287
38506
|
post: {
|
|
38507
|
+
description: 'Creates a new [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
38288
38508
|
operationId: 'webhooksCreatePost',
|
|
38289
38509
|
requestBody: {
|
|
38290
38510
|
content: {
|
|
@@ -38293,10 +38513,15 @@ export default {
|
|
|
38293
38513
|
properties: {
|
|
38294
38514
|
event_types: {
|
|
38295
38515
|
default: ['*'],
|
|
38516
|
+
description: 'Types of events that you want the new webhook to receive.',
|
|
38296
38517
|
items: { type: 'string' },
|
|
38297
38518
|
type: 'array',
|
|
38298
38519
|
},
|
|
38299
|
-
url: {
|
|
38520
|
+
url: {
|
|
38521
|
+
description: 'URL for the new webhook.',
|
|
38522
|
+
format: 'uri',
|
|
38523
|
+
type: 'string',
|
|
38524
|
+
},
|
|
38300
38525
|
},
|
|
38301
38526
|
required: ['url'],
|
|
38302
38527
|
type: 'object',
|
|
@@ -38334,16 +38559,23 @@ export default {
|
|
|
38334
38559
|
'x-fern-sdk-method-name': 'create',
|
|
38335
38560
|
'x-fern-sdk-return-value': 'webhook',
|
|
38336
38561
|
'x-response-key': 'webhook',
|
|
38562
|
+
'x-title': 'Create a Webhook',
|
|
38337
38563
|
},
|
|
38338
38564
|
},
|
|
38339
38565
|
'/webhooks/delete': {
|
|
38340
38566
|
post: {
|
|
38567
|
+
description: 'Deletes a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
38341
38568
|
operationId: 'webhooksDeletePost',
|
|
38342
38569
|
requestBody: {
|
|
38343
38570
|
content: {
|
|
38344
38571
|
'application/json': {
|
|
38345
38572
|
schema: {
|
|
38346
|
-
properties: {
|
|
38573
|
+
properties: {
|
|
38574
|
+
webhook_id: {
|
|
38575
|
+
description: 'ID of the webhook that you want to delete.',
|
|
38576
|
+
type: 'string',
|
|
38577
|
+
},
|
|
38578
|
+
},
|
|
38347
38579
|
required: ['webhook_id'],
|
|
38348
38580
|
type: 'object',
|
|
38349
38581
|
},
|
|
@@ -38376,16 +38608,23 @@ export default {
|
|
|
38376
38608
|
'x-fern-sdk-group-name': ['webhooks'],
|
|
38377
38609
|
'x-fern-sdk-method-name': 'delete',
|
|
38378
38610
|
'x-response-key': null,
|
|
38611
|
+
'x-title': 'Delete a Webhook',
|
|
38379
38612
|
},
|
|
38380
38613
|
},
|
|
38381
38614
|
'/webhooks/get': {
|
|
38382
38615
|
post: {
|
|
38616
|
+
description: 'Gets a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
38383
38617
|
operationId: 'webhooksGetPost',
|
|
38384
38618
|
requestBody: {
|
|
38385
38619
|
content: {
|
|
38386
38620
|
'application/json': {
|
|
38387
38621
|
schema: {
|
|
38388
|
-
properties: {
|
|
38622
|
+
properties: {
|
|
38623
|
+
webhook_id: {
|
|
38624
|
+
description: 'ID of the webhook that you want to get.',
|
|
38625
|
+
type: 'string',
|
|
38626
|
+
},
|
|
38627
|
+
},
|
|
38389
38628
|
required: ['webhook_id'],
|
|
38390
38629
|
type: 'object',
|
|
38391
38630
|
},
|
|
@@ -38422,10 +38661,12 @@ export default {
|
|
|
38422
38661
|
'x-fern-sdk-method-name': 'get',
|
|
38423
38662
|
'x-fern-sdk-return-value': 'webhook',
|
|
38424
38663
|
'x-response-key': 'webhook',
|
|
38664
|
+
'x-title': 'Get a Webhook',
|
|
38425
38665
|
},
|
|
38426
38666
|
},
|
|
38427
38667
|
'/webhooks/list': {
|
|
38428
38668
|
get: {
|
|
38669
|
+
description: 'Returns a list of all [webhooks](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
38429
38670
|
operationId: 'webhooksListGet',
|
|
38430
38671
|
responses: {
|
|
38431
38672
|
200: {
|
|
@@ -38458,8 +38699,10 @@ export default {
|
|
|
38458
38699
|
tags: ['/webhooks'],
|
|
38459
38700
|
'x-fern-ignore': true,
|
|
38460
38701
|
'x-response-key': 'webhooks',
|
|
38702
|
+
'x-title': 'List Webhooks',
|
|
38461
38703
|
},
|
|
38462
38704
|
post: {
|
|
38705
|
+
description: 'Returns a list of all [webhooks](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
38463
38706
|
operationId: 'webhooksListPost',
|
|
38464
38707
|
responses: {
|
|
38465
38708
|
200: {
|
|
@@ -38494,18 +38737,27 @@ export default {
|
|
|
38494
38737
|
'x-fern-sdk-method-name': 'list',
|
|
38495
38738
|
'x-fern-sdk-return-value': 'webhooks',
|
|
38496
38739
|
'x-response-key': 'webhooks',
|
|
38740
|
+
'x-title': 'List Webhooks',
|
|
38497
38741
|
},
|
|
38498
38742
|
},
|
|
38499
38743
|
'/webhooks/update': {
|
|
38500
38744
|
post: {
|
|
38745
|
+
description: 'Updates a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
38501
38746
|
operationId: 'webhooksUpdatePost',
|
|
38502
38747
|
requestBody: {
|
|
38503
38748
|
content: {
|
|
38504
38749
|
'application/json': {
|
|
38505
38750
|
schema: {
|
|
38506
38751
|
properties: {
|
|
38507
|
-
event_types: {
|
|
38508
|
-
|
|
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
|
+
},
|
|
38509
38761
|
},
|
|
38510
38762
|
required: ['webhook_id', 'event_types'],
|
|
38511
38763
|
type: 'object',
|
|
@@ -38539,16 +38791,25 @@ export default {
|
|
|
38539
38791
|
'x-fern-sdk-group-name': ['webhooks'],
|
|
38540
38792
|
'x-fern-sdk-method-name': 'update',
|
|
38541
38793
|
'x-response-key': null,
|
|
38794
|
+
'x-title': 'Update a Webhook',
|
|
38542
38795
|
},
|
|
38543
38796
|
put: {
|
|
38797
|
+
description: 'Updates a specified [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
|
|
38544
38798
|
operationId: 'webhooksUpdatePut',
|
|
38545
38799
|
requestBody: {
|
|
38546
38800
|
content: {
|
|
38547
38801
|
'application/json': {
|
|
38548
38802
|
schema: {
|
|
38549
38803
|
properties: {
|
|
38550
|
-
event_types: {
|
|
38551
|
-
|
|
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
|
+
},
|
|
38552
38813
|
},
|
|
38553
38814
|
required: ['webhook_id', 'event_types'],
|
|
38554
38815
|
type: 'object',
|
|
@@ -38581,41 +38842,65 @@ export default {
|
|
|
38581
38842
|
tags: ['/webhooks'],
|
|
38582
38843
|
'x-fern-ignore': true,
|
|
38583
38844
|
'x-response-key': null,
|
|
38845
|
+
'x-title': 'Update a Webhook',
|
|
38584
38846
|
},
|
|
38585
38847
|
},
|
|
38586
38848
|
'/workspaces/create': {
|
|
38587
38849
|
post: {
|
|
38850
|
+
description: 'Creates a new [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
|
|
38588
38851
|
operationId: 'workspacesCreatePost',
|
|
38589
38852
|
requestBody: {
|
|
38590
38853
|
content: {
|
|
38591
38854
|
'application/json': {
|
|
38592
38855
|
schema: {
|
|
38593
38856
|
properties: {
|
|
38594
|
-
company_name: {
|
|
38857
|
+
company_name: {
|
|
38858
|
+
description: 'Company name for the new workspace.',
|
|
38859
|
+
type: 'string',
|
|
38860
|
+
},
|
|
38595
38861
|
connect_partner_name: {
|
|
38596
38862
|
deprecated: true,
|
|
38863
|
+
description: 'Connect partner name for the new workspace.',
|
|
38597
38864
|
nullable: true,
|
|
38598
38865
|
type: 'string',
|
|
38599
38866
|
'x-deprecated': 'use company_name',
|
|
38600
38867
|
},
|
|
38601
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).',
|
|
38602
38870
|
properties: {
|
|
38603
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).',
|
|
38604
38873
|
enum: ['circle', 'square'],
|
|
38605
38874
|
nullable: true,
|
|
38606
38875
|
type: 'string',
|
|
38607
38876
|
},
|
|
38608
|
-
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
|
+
},
|
|
38609
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).',
|
|
38610
38889
|
nullable: true,
|
|
38611
38890
|
type: 'string',
|
|
38612
38891
|
},
|
|
38613
|
-
success_message: { nullable: true, type: 'string' },
|
|
38614
38892
|
},
|
|
38615
38893
|
type: 'object',
|
|
38616
38894
|
},
|
|
38617
|
-
is_sandbox: {
|
|
38618
|
-
|
|
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
|
+
},
|
|
38619
38904
|
webview_logo_shape: {
|
|
38620
38905
|
deprecated: true,
|
|
38621
38906
|
enum: ['circle', 'square'],
|
|
@@ -38674,10 +38959,12 @@ export default {
|
|
|
38674
38959
|
'x-fern-sdk-method-name': 'create',
|
|
38675
38960
|
'x-fern-sdk-return-value': 'workspace',
|
|
38676
38961
|
'x-response-key': 'workspace',
|
|
38962
|
+
'x-title': 'Create a Workspace',
|
|
38677
38963
|
},
|
|
38678
38964
|
},
|
|
38679
38965
|
'/workspaces/get': {
|
|
38680
38966
|
get: {
|
|
38967
|
+
description: 'Returns the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
|
|
38681
38968
|
operationId: 'workspacesGetGet',
|
|
38682
38969
|
responses: {
|
|
38683
38970
|
200: {
|
|
@@ -38702,14 +38989,17 @@ export default {
|
|
|
38702
38989
|
{ api_key: [] },
|
|
38703
38990
|
{ console_session_with_workspace: [] },
|
|
38704
38991
|
{ client_session: [] },
|
|
38992
|
+
{ client_session_with_customer: [] },
|
|
38705
38993
|
{ pat_with_workspace: [] },
|
|
38706
38994
|
],
|
|
38707
38995
|
summary: '/workspaces/get',
|
|
38708
38996
|
tags: ['/workspaces'],
|
|
38709
38997
|
'x-fern-ignore': true,
|
|
38710
38998
|
'x-response-key': 'workspace',
|
|
38999
|
+
'x-title': 'Get a Workspace',
|
|
38711
39000
|
},
|
|
38712
39001
|
post: {
|
|
39002
|
+
description: 'Returns the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
|
|
38713
39003
|
operationId: 'workspacesGetPost',
|
|
38714
39004
|
responses: {
|
|
38715
39005
|
200: {
|
|
@@ -38734,6 +39024,7 @@ export default {
|
|
|
38734
39024
|
{ api_key: [] },
|
|
38735
39025
|
{ console_session_with_workspace: [] },
|
|
38736
39026
|
{ client_session: [] },
|
|
39027
|
+
{ client_session_with_customer: [] },
|
|
38737
39028
|
{ pat_with_workspace: [] },
|
|
38738
39029
|
],
|
|
38739
39030
|
summary: '/workspaces/get',
|
|
@@ -38742,10 +39033,12 @@ export default {
|
|
|
38742
39033
|
'x-fern-sdk-method-name': 'get',
|
|
38743
39034
|
'x-fern-sdk-return-value': 'workspace',
|
|
38744
39035
|
'x-response-key': 'workspace',
|
|
39036
|
+
'x-title': 'Get a Workspace',
|
|
38745
39037
|
},
|
|
38746
39038
|
},
|
|
38747
39039
|
'/workspaces/list': {
|
|
38748
39040
|
get: {
|
|
39041
|
+
description: 'Returns a list of [workspaces](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
|
|
38749
39042
|
operationId: 'workspacesListGet',
|
|
38750
39043
|
responses: {
|
|
38751
39044
|
200: {
|
|
@@ -38781,8 +39074,10 @@ export default {
|
|
|
38781
39074
|
tags: ['/workspaces'],
|
|
38782
39075
|
'x-fern-ignore': true,
|
|
38783
39076
|
'x-response-key': 'workspaces',
|
|
39077
|
+
'x-title': 'List Workspaces',
|
|
38784
39078
|
},
|
|
38785
39079
|
post: {
|
|
39080
|
+
description: 'Returns a list of [workspaces](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
|
|
38786
39081
|
operationId: 'workspacesListPost',
|
|
38787
39082
|
responses: {
|
|
38788
39083
|
200: {
|
|
@@ -38820,11 +39115,12 @@ export default {
|
|
|
38820
39115
|
'x-fern-sdk-method-name': 'list',
|
|
38821
39116
|
'x-fern-sdk-return-value': 'workspaces',
|
|
38822
39117
|
'x-response-key': 'workspaces',
|
|
39118
|
+
'x-title': 'List Workspaces',
|
|
38823
39119
|
},
|
|
38824
39120
|
},
|
|
38825
39121
|
'/workspaces/reset_sandbox': {
|
|
38826
39122
|
post: {
|
|
38827
|
-
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.',
|
|
38828
39124
|
operationId: 'workspacesResetSandboxPost',
|
|
38829
39125
|
responses: {
|
|
38830
39126
|
200: {
|
|
@@ -38859,35 +39155,57 @@ export default {
|
|
|
38859
39155
|
'x-fern-sdk-method-name': 'reset_sandbox',
|
|
38860
39156
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
38861
39157
|
'x-response-key': 'action_attempt',
|
|
39158
|
+
'x-title': 'Reset a Sandbox Workspace',
|
|
38862
39159
|
},
|
|
38863
39160
|
},
|
|
38864
39161
|
'/workspaces/update': {
|
|
38865
39162
|
patch: {
|
|
39163
|
+
description: 'Updates the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
|
|
38866
39164
|
operationId: 'workspacesUpdatePatch',
|
|
38867
39165
|
requestBody: {
|
|
38868
39166
|
content: {
|
|
38869
39167
|
'application/json': {
|
|
38870
39168
|
schema: {
|
|
38871
39169
|
properties: {
|
|
38872
|
-
connect_partner_name: {
|
|
39170
|
+
connect_partner_name: {
|
|
39171
|
+
description: 'Connect partner name for the workspace.',
|
|
39172
|
+
type: 'string',
|
|
39173
|
+
},
|
|
38873
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).',
|
|
38874
39176
|
properties: {
|
|
38875
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).',
|
|
38876
39179
|
enum: ['circle', 'square'],
|
|
38877
39180
|
nullable: true,
|
|
38878
39181
|
type: 'string',
|
|
38879
39182
|
},
|
|
38880
|
-
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
|
+
},
|
|
38881
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).',
|
|
38882
39195
|
nullable: true,
|
|
38883
39196
|
type: 'string',
|
|
38884
39197
|
},
|
|
38885
|
-
success_message: { nullable: true, type: 'string' },
|
|
38886
39198
|
},
|
|
38887
39199
|
type: 'object',
|
|
38888
39200
|
},
|
|
38889
|
-
is_suspended: {
|
|
38890
|
-
|
|
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
|
+
},
|
|
38891
39209
|
},
|
|
38892
39210
|
type: 'object',
|
|
38893
39211
|
},
|
|
@@ -38908,33 +39226,55 @@ export default {
|
|
|
38908
39226
|
tags: ['/workspaces'],
|
|
38909
39227
|
'x-fern-ignore': true,
|
|
38910
39228
|
'x-response-key': null,
|
|
39229
|
+
'x-title': 'Udpate a Workspace',
|
|
38911
39230
|
},
|
|
38912
39231
|
post: {
|
|
39232
|
+
description: 'Updates the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the authentication value.',
|
|
38913
39233
|
operationId: 'workspacesUpdatePost',
|
|
38914
39234
|
requestBody: {
|
|
38915
39235
|
content: {
|
|
38916
39236
|
'application/json': {
|
|
38917
39237
|
schema: {
|
|
38918
39238
|
properties: {
|
|
38919
|
-
connect_partner_name: {
|
|
39239
|
+
connect_partner_name: {
|
|
39240
|
+
description: 'Connect partner name for the workspace.',
|
|
39241
|
+
type: 'string',
|
|
39242
|
+
},
|
|
38920
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).',
|
|
38921
39245
|
properties: {
|
|
38922
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).',
|
|
38923
39248
|
enum: ['circle', 'square'],
|
|
38924
39249
|
nullable: true,
|
|
38925
39250
|
type: 'string',
|
|
38926
39251
|
},
|
|
38927
|
-
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
|
+
},
|
|
38928
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).',
|
|
38929
39264
|
nullable: true,
|
|
38930
39265
|
type: 'string',
|
|
38931
39266
|
},
|
|
38932
|
-
success_message: { nullable: true, type: 'string' },
|
|
38933
39267
|
},
|
|
38934
39268
|
type: 'object',
|
|
38935
39269
|
},
|
|
38936
|
-
is_suspended: {
|
|
38937
|
-
|
|
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
|
+
},
|
|
38938
39278
|
},
|
|
38939
39279
|
type: 'object',
|
|
38940
39280
|
},
|
|
@@ -38956,6 +39296,7 @@ export default {
|
|
|
38956
39296
|
'x-fern-sdk-group-name': ['workspaces'],
|
|
38957
39297
|
'x-fern-sdk-method-name': 'update',
|
|
38958
39298
|
'x-response-key': null,
|
|
39299
|
+
'x-title': 'Udpate a Workspace',
|
|
38959
39300
|
},
|
|
38960
39301
|
},
|
|
38961
39302
|
},
|