@seamapi/types 1.406.4 → 1.406.6
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 +110 -58
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +120 -72
- package/lib/seam/connect/models/client-sessions/client-session.d.ts +3 -0
- package/lib/seam/connect/models/client-sessions/client-session.js +4 -3
- package/lib/seam/connect/models/client-sessions/client-session.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +89 -59
- package/lib/seam/connect/openapi.js +100 -49
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +28 -13
- package/package.json +1 -1
- package/src/lib/seam/connect/models/client-sessions/client-session.ts +4 -3
- package/src/lib/seam/connect/openapi.ts +111 -49
- package/src/lib/seam/connect/route-types.ts +28 -13
|
@@ -6417,6 +6417,7 @@ export default {
|
|
|
6417
6417
|
type: 'array',
|
|
6418
6418
|
},
|
|
6419
6419
|
created_at: { format: 'date-time', type: 'string' },
|
|
6420
|
+
customer_id: { format: 'uuid', type: 'string' },
|
|
6420
6421
|
device_count: { format: 'float', type: 'number' },
|
|
6421
6422
|
expires_at: { format: 'date-time', type: 'string' },
|
|
6422
6423
|
token: { type: 'string' },
|
|
@@ -18686,18 +18687,18 @@ export default {
|
|
|
18686
18687
|
name: 'client-session-token',
|
|
18687
18688
|
type: 'apiKey',
|
|
18688
18689
|
},
|
|
18689
|
-
|
|
18690
|
-
bearerFormat: '
|
|
18690
|
+
client_session_with_customer: {
|
|
18691
|
+
bearerFormat: 'Customer Client Session Token',
|
|
18691
18692
|
scheme: 'bearer',
|
|
18692
18693
|
type: 'http',
|
|
18693
18694
|
},
|
|
18694
|
-
|
|
18695
|
+
console_session_with_workspace: {
|
|
18695
18696
|
bearerFormat: 'Console Session Token',
|
|
18696
18697
|
scheme: 'bearer',
|
|
18697
18698
|
type: 'http',
|
|
18698
18699
|
},
|
|
18699
|
-
|
|
18700
|
-
bearerFormat: '
|
|
18700
|
+
console_session_without_workspace: {
|
|
18701
|
+
bearerFormat: 'Console Session Token',
|
|
18701
18702
|
scheme: 'bearer',
|
|
18702
18703
|
type: 'http',
|
|
18703
18704
|
},
|
|
@@ -18737,7 +18738,7 @@ export default {
|
|
|
18737
18738
|
schema: {
|
|
18738
18739
|
properties: {
|
|
18739
18740
|
allow_external_modification: {
|
|
18740
|
-
description: 'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
18741
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18741
18742
|
type: 'boolean',
|
|
18742
18743
|
},
|
|
18743
18744
|
attempt_for_offline_device: {
|
|
@@ -18765,7 +18766,7 @@ export default {
|
|
|
18765
18766
|
type: 'string',
|
|
18766
18767
|
},
|
|
18767
18768
|
is_external_modification_allowed: {
|
|
18768
|
-
description: 'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
18769
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18769
18770
|
type: 'boolean',
|
|
18770
18771
|
},
|
|
18771
18772
|
is_offline_access_code: {
|
|
@@ -18805,7 +18806,7 @@ export default {
|
|
|
18805
18806
|
'x-undocumented': 'Only used internally.',
|
|
18806
18807
|
},
|
|
18807
18808
|
use_backup_access_code_pool: {
|
|
18808
|
-
description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api
|
|
18809
|
+
description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
|
|
18809
18810
|
type: 'boolean',
|
|
18810
18811
|
},
|
|
18811
18812
|
use_offline_access_code: { type: 'boolean' },
|
|
@@ -18864,7 +18865,7 @@ export default {
|
|
|
18864
18865
|
schema: {
|
|
18865
18866
|
properties: {
|
|
18866
18867
|
allow_external_modification: {
|
|
18867
|
-
description: 'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
18868
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18868
18869
|
type: 'boolean',
|
|
18869
18870
|
},
|
|
18870
18871
|
attempt_for_offline_device: {
|
|
@@ -18894,7 +18895,7 @@ export default {
|
|
|
18894
18895
|
type: 'string',
|
|
18895
18896
|
},
|
|
18896
18897
|
is_external_modification_allowed: {
|
|
18897
|
-
description: 'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
18898
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18898
18899
|
type: 'boolean',
|
|
18899
18900
|
},
|
|
18900
18901
|
is_offline_access_code: {
|
|
@@ -18929,7 +18930,7 @@ export default {
|
|
|
18929
18930
|
type: 'string',
|
|
18930
18931
|
},
|
|
18931
18932
|
use_backup_access_code_pool: {
|
|
18932
|
-
description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api
|
|
18933
|
+
description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
|
|
18933
18934
|
type: 'boolean',
|
|
18934
18935
|
},
|
|
18935
18936
|
use_offline_access_code: { type: 'boolean' },
|
|
@@ -18985,7 +18986,7 @@ export default {
|
|
|
18985
18986
|
schema: {
|
|
18986
18987
|
properties: {
|
|
18987
18988
|
allow_external_modification: {
|
|
18988
|
-
description: 'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
18989
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18989
18990
|
type: 'boolean',
|
|
18990
18991
|
},
|
|
18991
18992
|
attempt_for_offline_device: {
|
|
@@ -19015,7 +19016,7 @@ export default {
|
|
|
19015
19016
|
type: 'string',
|
|
19016
19017
|
},
|
|
19017
19018
|
is_external_modification_allowed: {
|
|
19018
|
-
description: 'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
19019
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
19019
19020
|
type: 'boolean',
|
|
19020
19021
|
},
|
|
19021
19022
|
is_offline_access_code: {
|
|
@@ -19050,7 +19051,7 @@ export default {
|
|
|
19050
19051
|
type: 'string',
|
|
19051
19052
|
},
|
|
19052
19053
|
use_backup_access_code_pool: {
|
|
19053
|
-
description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api
|
|
19054
|
+
description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
|
|
19054
19055
|
type: 'boolean',
|
|
19055
19056
|
},
|
|
19056
19057
|
use_offline_access_code: { type: 'boolean' },
|
|
@@ -20022,7 +20023,7 @@ export default {
|
|
|
20022
20023
|
type: 'string',
|
|
20023
20024
|
},
|
|
20024
20025
|
allow_external_modification: {
|
|
20025
|
-
description: 'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
20026
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
20026
20027
|
type: 'boolean',
|
|
20027
20028
|
},
|
|
20028
20029
|
attempt_for_offline_device: {
|
|
@@ -20046,7 +20047,7 @@ export default {
|
|
|
20046
20047
|
type: 'string',
|
|
20047
20048
|
},
|
|
20048
20049
|
is_external_modification_allowed: {
|
|
20049
|
-
description: 'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
20050
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
20050
20051
|
type: 'boolean',
|
|
20051
20052
|
},
|
|
20052
20053
|
is_managed: {
|
|
@@ -20095,7 +20096,7 @@ export default {
|
|
|
20095
20096
|
type: 'string',
|
|
20096
20097
|
},
|
|
20097
20098
|
use_backup_access_code_pool: {
|
|
20098
|
-
description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api
|
|
20099
|
+
description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
|
|
20099
20100
|
type: 'boolean',
|
|
20100
20101
|
},
|
|
20101
20102
|
use_offline_access_code: { type: 'boolean' },
|
|
@@ -20154,7 +20155,7 @@ export default {
|
|
|
20154
20155
|
type: 'string',
|
|
20155
20156
|
},
|
|
20156
20157
|
allow_external_modification: {
|
|
20157
|
-
description: 'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
20158
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
20158
20159
|
type: 'boolean',
|
|
20159
20160
|
},
|
|
20160
20161
|
attempt_for_offline_device: {
|
|
@@ -20178,7 +20179,7 @@ export default {
|
|
|
20178
20179
|
type: 'string',
|
|
20179
20180
|
},
|
|
20180
20181
|
is_external_modification_allowed: {
|
|
20181
|
-
description: 'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
20182
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
20182
20183
|
type: 'boolean',
|
|
20183
20184
|
},
|
|
20184
20185
|
is_managed: {
|
|
@@ -20227,7 +20228,7 @@ export default {
|
|
|
20227
20228
|
type: 'string',
|
|
20228
20229
|
},
|
|
20229
20230
|
use_backup_access_code_pool: {
|
|
20230
|
-
description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api
|
|
20231
|
+
description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
|
|
20231
20232
|
type: 'boolean',
|
|
20232
20233
|
},
|
|
20233
20234
|
use_offline_access_code: { type: 'boolean' },
|
|
@@ -20287,7 +20288,7 @@ export default {
|
|
|
20287
20288
|
type: 'string',
|
|
20288
20289
|
},
|
|
20289
20290
|
allow_external_modification: {
|
|
20290
|
-
description: 'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
20291
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
20291
20292
|
type: 'boolean',
|
|
20292
20293
|
},
|
|
20293
20294
|
attempt_for_offline_device: {
|
|
@@ -20311,7 +20312,7 @@ export default {
|
|
|
20311
20312
|
type: 'string',
|
|
20312
20313
|
},
|
|
20313
20314
|
is_external_modification_allowed: {
|
|
20314
|
-
description: 'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
20315
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
20315
20316
|
type: 'boolean',
|
|
20316
20317
|
},
|
|
20317
20318
|
is_managed: {
|
|
@@ -20360,7 +20361,7 @@ export default {
|
|
|
20360
20361
|
type: 'string',
|
|
20361
20362
|
},
|
|
20362
20363
|
use_backup_access_code_pool: {
|
|
20363
|
-
description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api
|
|
20364
|
+
description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
|
|
20364
20365
|
type: 'boolean',
|
|
20365
20366
|
},
|
|
20366
20367
|
use_offline_access_code: { type: 'boolean' },
|
|
@@ -25383,7 +25384,7 @@ export default {
|
|
|
25383
25384
|
},
|
|
25384
25385
|
security: [
|
|
25385
25386
|
{ client_session: [] },
|
|
25386
|
-
{
|
|
25387
|
+
{ client_session_with_customer: [] },
|
|
25387
25388
|
{ pat_with_workspace: [] },
|
|
25388
25389
|
{ console_session_with_workspace: [] },
|
|
25389
25390
|
{ api_key: [] },
|
|
@@ -25491,7 +25492,7 @@ export default {
|
|
|
25491
25492
|
},
|
|
25492
25493
|
security: [
|
|
25493
25494
|
{ client_session: [] },
|
|
25494
|
-
{
|
|
25495
|
+
{ client_session_with_customer: [] },
|
|
25495
25496
|
{ pat_with_workspace: [] },
|
|
25496
25497
|
{ console_session_with_workspace: [] },
|
|
25497
25498
|
{ api_key: [] },
|
|
@@ -25521,7 +25522,7 @@ export default {
|
|
|
25521
25522
|
description: 'Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.',
|
|
25522
25523
|
type: 'object',
|
|
25523
25524
|
},
|
|
25524
|
-
|
|
25525
|
+
customer_ids: { items: { type: 'string' }, type: 'array' },
|
|
25525
25526
|
limit: {
|
|
25526
25527
|
default: 500,
|
|
25527
25528
|
description: 'Maximum number of records to return per page.',
|
|
@@ -25562,7 +25563,7 @@ export default {
|
|
|
25562
25563
|
},
|
|
25563
25564
|
security: [
|
|
25564
25565
|
{ client_session: [] },
|
|
25565
|
-
{
|
|
25566
|
+
{ client_session_with_customer: [] },
|
|
25566
25567
|
{ pat_with_workspace: [] },
|
|
25567
25568
|
{ console_session_with_workspace: [] },
|
|
25568
25569
|
{ api_key: [] },
|
|
@@ -25622,7 +25623,7 @@ export default {
|
|
|
25622
25623
|
{ api_key: [] },
|
|
25623
25624
|
{ pat_with_workspace: [] },
|
|
25624
25625
|
{ console_session_with_workspace: [] },
|
|
25625
|
-
{
|
|
25626
|
+
{ client_session_with_customer: [] },
|
|
25626
25627
|
],
|
|
25627
25628
|
summary: '/connected_accounts/delete',
|
|
25628
25629
|
tags: ['/connected_accounts'],
|
|
@@ -25773,7 +25774,7 @@ export default {
|
|
|
25773
25774
|
{ api_key: [] },
|
|
25774
25775
|
{ pat_with_workspace: [] },
|
|
25775
25776
|
{ console_session_with_workspace: [] },
|
|
25776
|
-
{
|
|
25777
|
+
{ client_session_with_customer: [] },
|
|
25777
25778
|
],
|
|
25778
25779
|
summary: '/connected_accounts/list',
|
|
25779
25780
|
tags: ['/connected_accounts'],
|
|
@@ -26001,7 +26002,7 @@ export default {
|
|
|
26001
26002
|
},
|
|
26002
26003
|
security: [
|
|
26003
26004
|
{ client_session: [] },
|
|
26004
|
-
{
|
|
26005
|
+
{ client_session_with_customer: [] },
|
|
26005
26006
|
{ pat_with_workspace: [] },
|
|
26006
26007
|
{ console_session_with_workspace: [] },
|
|
26007
26008
|
{ api_key: [] },
|
|
@@ -26320,7 +26321,7 @@ export default {
|
|
|
26320
26321
|
401: { description: 'Unauthorized' },
|
|
26321
26322
|
},
|
|
26322
26323
|
security: [
|
|
26323
|
-
{
|
|
26324
|
+
{ client_session_with_customer: [] },
|
|
26324
26325
|
{ client_session: [] },
|
|
26325
26326
|
{ pat_with_workspace: [] },
|
|
26326
26327
|
{ console_session_with_workspace: [] },
|
|
@@ -27565,7 +27566,7 @@ export default {
|
|
|
27565
27566
|
{ api_key: [] },
|
|
27566
27567
|
{ pat_with_workspace: [] },
|
|
27567
27568
|
{ console_session_with_workspace: [] },
|
|
27568
|
-
{
|
|
27569
|
+
{ client_session_with_customer: [] },
|
|
27569
27570
|
],
|
|
27570
27571
|
summary: '/events/list',
|
|
27571
27572
|
tags: ['/events'],
|
|
@@ -27578,14 +27579,22 @@ export default {
|
|
|
27578
27579
|
},
|
|
27579
27580
|
'/locks/get': {
|
|
27580
27581
|
post: {
|
|
27582
|
+
description: 'Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks). **Use `/devices/get` instead.**',
|
|
27581
27583
|
operationId: 'locksGetPost',
|
|
27582
27584
|
requestBody: {
|
|
27583
27585
|
content: {
|
|
27584
27586
|
'application/json': {
|
|
27585
27587
|
schema: {
|
|
27586
27588
|
properties: {
|
|
27587
|
-
device_id: {
|
|
27588
|
-
|
|
27589
|
+
device_id: {
|
|
27590
|
+
description: 'ID of the lock that you want to get.',
|
|
27591
|
+
format: 'uuid',
|
|
27592
|
+
type: 'string',
|
|
27593
|
+
},
|
|
27594
|
+
name: {
|
|
27595
|
+
description: 'Name of the lock that you want to get.',
|
|
27596
|
+
type: 'string',
|
|
27597
|
+
},
|
|
27589
27598
|
},
|
|
27590
27599
|
type: 'object',
|
|
27591
27600
|
},
|
|
@@ -27625,10 +27634,12 @@ export default {
|
|
|
27625
27634
|
'x-fern-sdk-method-name': 'get',
|
|
27626
27635
|
'x-fern-sdk-return-value': 'device',
|
|
27627
27636
|
'x-response-key': 'device',
|
|
27637
|
+
'x-title': 'Get a Lock',
|
|
27628
27638
|
},
|
|
27629
27639
|
},
|
|
27630
27640
|
'/locks/list': {
|
|
27631
27641
|
post: {
|
|
27642
|
+
description: 'Returns a list of all [locks](https://docs.seam.co/latest/capability-guides/smart-locks).',
|
|
27632
27643
|
operationId: 'locksListPost',
|
|
27633
27644
|
requestBody: {
|
|
27634
27645
|
content: {
|
|
@@ -27672,7 +27683,7 @@ export default {
|
|
|
27672
27683
|
type: 'array',
|
|
27673
27684
|
},
|
|
27674
27685
|
device_type: {
|
|
27675
|
-
description: 'Device type
|
|
27686
|
+
description: 'Device type of the locks that you want to list.',
|
|
27676
27687
|
enum: [
|
|
27677
27688
|
'akuvox_lock',
|
|
27678
27689
|
'august_lock',
|
|
@@ -27705,7 +27716,7 @@ export default {
|
|
|
27705
27716
|
type: 'string',
|
|
27706
27717
|
},
|
|
27707
27718
|
device_types: {
|
|
27708
|
-
description: '
|
|
27719
|
+
description: 'Device types of the locks that you want to list.',
|
|
27709
27720
|
items: {
|
|
27710
27721
|
description: 'Device type for smartlocks.\n ',
|
|
27711
27722
|
enum: [
|
|
@@ -27788,7 +27799,7 @@ export default {
|
|
|
27788
27799
|
type: 'number',
|
|
27789
27800
|
},
|
|
27790
27801
|
manufacturer: {
|
|
27791
|
-
description: 'Manufacturer
|
|
27802
|
+
description: 'Manufacturer of the locks that you want to list.',
|
|
27792
27803
|
enum: [
|
|
27793
27804
|
'akuvox',
|
|
27794
27805
|
'august',
|
|
@@ -27881,18 +27892,28 @@ export default {
|
|
|
27881
27892
|
'x-fern-sdk-method-name': 'list',
|
|
27882
27893
|
'x-fern-sdk-return-value': 'devices',
|
|
27883
27894
|
'x-response-key': 'devices',
|
|
27895
|
+
'x-title': 'List Locks',
|
|
27884
27896
|
},
|
|
27885
27897
|
},
|
|
27886
27898
|
'/locks/lock_door': {
|
|
27887
27899
|
post: {
|
|
27900
|
+
description: 'Locks a [lock](https://docs.seam.co/latest/capability-guides/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock).',
|
|
27888
27901
|
operationId: 'locksLockDoorPost',
|
|
27889
27902
|
requestBody: {
|
|
27890
27903
|
content: {
|
|
27891
27904
|
'application/json': {
|
|
27892
27905
|
schema: {
|
|
27893
27906
|
properties: {
|
|
27894
|
-
device_id: {
|
|
27895
|
-
|
|
27907
|
+
device_id: {
|
|
27908
|
+
description: 'ID of the lock that you want to lock.',
|
|
27909
|
+
format: 'uuid',
|
|
27910
|
+
type: 'string',
|
|
27911
|
+
},
|
|
27912
|
+
sync: {
|
|
27913
|
+
default: false,
|
|
27914
|
+
type: 'boolean',
|
|
27915
|
+
'x-undocumented': 'Only used internally.',
|
|
27916
|
+
},
|
|
27896
27917
|
},
|
|
27897
27918
|
required: ['device_id'],
|
|
27898
27919
|
type: 'object',
|
|
@@ -27934,18 +27955,27 @@ export default {
|
|
|
27934
27955
|
'x-fern-sdk-method-name': 'lock_door',
|
|
27935
27956
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
27936
27957
|
'x-response-key': 'action_attempt',
|
|
27958
|
+
'x-title': 'Lock a Lock',
|
|
27937
27959
|
},
|
|
27938
27960
|
},
|
|
27939
27961
|
'/locks/simulate/keypad_code_entry': {
|
|
27940
27962
|
post: {
|
|
27963
|
+
description: 'Simulates the entry of a code on a keypad. You can only perform this action for [August](https://docs.seam.co/latest/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
|
|
27941
27964
|
operationId: 'locksSimulateKeypadCodeEntryPost',
|
|
27942
27965
|
requestBody: {
|
|
27943
27966
|
content: {
|
|
27944
27967
|
'application/json': {
|
|
27945
27968
|
schema: {
|
|
27946
27969
|
properties: {
|
|
27947
|
-
code: {
|
|
27948
|
-
|
|
27970
|
+
code: {
|
|
27971
|
+
description: 'Code that you want to simulate entering on a keypad.',
|
|
27972
|
+
type: 'string',
|
|
27973
|
+
},
|
|
27974
|
+
device_id: {
|
|
27975
|
+
description: 'ID of the device for which you want to simulate a keypad code entry.',
|
|
27976
|
+
format: 'uuid',
|
|
27977
|
+
type: 'string',
|
|
27978
|
+
},
|
|
27949
27979
|
},
|
|
27950
27980
|
required: ['device_id', 'code'],
|
|
27951
27981
|
type: 'object',
|
|
@@ -27991,12 +28021,19 @@ export default {
|
|
|
27991
28021
|
},
|
|
27992
28022
|
'/locks/simulate/manual_lock_via_keypad': {
|
|
27993
28023
|
post: {
|
|
28024
|
+
description: 'Simulates a manual lock action using a keypad. You can only perform this action for [August](https://docs.seam.co/latest/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
|
|
27994
28025
|
operationId: 'locksSimulateManualLockViaKeypadPost',
|
|
27995
28026
|
requestBody: {
|
|
27996
28027
|
content: {
|
|
27997
28028
|
'application/json': {
|
|
27998
28029
|
schema: {
|
|
27999
|
-
properties: {
|
|
28030
|
+
properties: {
|
|
28031
|
+
device_id: {
|
|
28032
|
+
description: 'ID of the device for which you want to simulate a manual lock action using a keypad.',
|
|
28033
|
+
format: 'uuid',
|
|
28034
|
+
type: 'string',
|
|
28035
|
+
},
|
|
28036
|
+
},
|
|
28000
28037
|
required: ['device_id'],
|
|
28001
28038
|
type: 'object',
|
|
28002
28039
|
},
|
|
@@ -28041,14 +28078,23 @@ export default {
|
|
|
28041
28078
|
},
|
|
28042
28079
|
'/locks/unlock_door': {
|
|
28043
28080
|
post: {
|
|
28081
|
+
description: 'Unlocks a [lock](https://docs.seam.co/latest/capability-guides/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock).',
|
|
28044
28082
|
operationId: 'locksUnlockDoorPost',
|
|
28045
28083
|
requestBody: {
|
|
28046
28084
|
content: {
|
|
28047
28085
|
'application/json': {
|
|
28048
28086
|
schema: {
|
|
28049
28087
|
properties: {
|
|
28050
|
-
device_id: {
|
|
28051
|
-
|
|
28088
|
+
device_id: {
|
|
28089
|
+
description: 'ID of the lock that you want to unlock.',
|
|
28090
|
+
format: 'uuid',
|
|
28091
|
+
type: 'string',
|
|
28092
|
+
},
|
|
28093
|
+
sync: {
|
|
28094
|
+
default: false,
|
|
28095
|
+
type: 'boolean',
|
|
28096
|
+
'x-undocumented': 'Only used internally.',
|
|
28097
|
+
},
|
|
28052
28098
|
},
|
|
28053
28099
|
required: ['device_id'],
|
|
28054
28100
|
type: 'object',
|
|
@@ -28090,6 +28136,7 @@ export default {
|
|
|
28090
28136
|
'x-fern-sdk-method-name': 'unlock_door',
|
|
28091
28137
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
28092
28138
|
'x-response-key': 'action_attempt',
|
|
28139
|
+
'x-title': 'Unlock a Lock',
|
|
28093
28140
|
},
|
|
28094
28141
|
},
|
|
28095
28142
|
'/networks/get': {
|
|
@@ -28132,10 +28179,12 @@ export default {
|
|
|
28132
28179
|
],
|
|
28133
28180
|
summary: '/networks/get',
|
|
28134
28181
|
tags: ['/networks'],
|
|
28182
|
+
'x-deprecated': 'Will be removed.',
|
|
28135
28183
|
'x-fern-sdk-group-name': ['networks'],
|
|
28136
28184
|
'x-fern-sdk-method-name': 'get',
|
|
28137
28185
|
'x-fern-sdk-return-value': 'network',
|
|
28138
28186
|
'x-response-key': 'network',
|
|
28187
|
+
'x-undocumented': 'Deprecated.',
|
|
28139
28188
|
},
|
|
28140
28189
|
},
|
|
28141
28190
|
'/networks/list': {
|
|
@@ -28175,10 +28224,12 @@ export default {
|
|
|
28175
28224
|
],
|
|
28176
28225
|
summary: '/networks/list',
|
|
28177
28226
|
tags: ['/networks'],
|
|
28227
|
+
'x-deprecated': 'Will be removed.',
|
|
28178
28228
|
'x-fern-sdk-group-name': ['networks'],
|
|
28179
28229
|
'x-fern-sdk-method-name': 'list',
|
|
28180
28230
|
'x-fern-sdk-return-value': 'networks',
|
|
28181
28231
|
'x-response-key': 'networks',
|
|
28232
|
+
'x-undocumented': 'Deprecated.',
|
|
28182
28233
|
},
|
|
28183
28234
|
},
|
|
28184
28235
|
'/noise_sensors/list': {
|
|
@@ -30349,7 +30400,7 @@ export default {
|
|
|
30349
30400
|
400: { description: 'Bad Request' },
|
|
30350
30401
|
401: { description: 'Unauthorized' },
|
|
30351
30402
|
},
|
|
30352
|
-
security: [{
|
|
30403
|
+
security: [{ client_session_with_customer: [] }],
|
|
30353
30404
|
summary: '/seam/partner/v1/resources/list',
|
|
30354
30405
|
tags: [],
|
|
30355
30406
|
'x-fern-sdk-group-name': ['seam', 'partner', 'v1', 'resources'],
|
|
@@ -33034,7 +33085,7 @@ export default {
|
|
|
33034
33085
|
{ pat_with_workspace: [] },
|
|
33035
33086
|
{ console_session_with_workspace: [] },
|
|
33036
33087
|
{ api_key: [] },
|
|
33037
|
-
{
|
|
33088
|
+
{ client_session_with_customer: [] },
|
|
33038
33089
|
],
|
|
33039
33090
|
summary: '/unstable_access_grants/create',
|
|
33040
33091
|
tags: [],
|
|
@@ -33087,7 +33138,7 @@ export default {
|
|
|
33087
33138
|
{ pat_with_workspace: [] },
|
|
33088
33139
|
{ console_session_with_workspace: [] },
|
|
33089
33140
|
{ api_key: [] },
|
|
33090
|
-
{
|
|
33141
|
+
{ client_session_with_customer: [] },
|
|
33091
33142
|
],
|
|
33092
33143
|
summary: '/unstable_access_grants/delete',
|
|
33093
33144
|
tags: [],
|
|
@@ -33226,7 +33277,7 @@ export default {
|
|
|
33226
33277
|
{ pat_with_workspace: [] },
|
|
33227
33278
|
{ console_session_with_workspace: [] },
|
|
33228
33279
|
{ api_key: [] },
|
|
33229
|
-
{
|
|
33280
|
+
{ client_session_with_customer: [] },
|
|
33230
33281
|
],
|
|
33231
33282
|
summary: '/unstable_access_grants/get',
|
|
33232
33283
|
tags: [],
|
|
@@ -33383,7 +33434,7 @@ export default {
|
|
|
33383
33434
|
{ pat_with_workspace: [] },
|
|
33384
33435
|
{ console_session_with_workspace: [] },
|
|
33385
33436
|
{ api_key: [] },
|
|
33386
|
-
{
|
|
33437
|
+
{ client_session_with_customer: [] },
|
|
33387
33438
|
],
|
|
33388
33439
|
summary: '/unstable_access_grants/list',
|
|
33389
33440
|
tags: [],
|