@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
|
@@ -7142,6 +7142,7 @@ export default {
|
|
|
7142
7142
|
type: 'array',
|
|
7143
7143
|
},
|
|
7144
7144
|
created_at: { format: 'date-time', type: 'string' },
|
|
7145
|
+
customer_id: { format: 'uuid', type: 'string' },
|
|
7145
7146
|
device_count: { format: 'float', type: 'number' },
|
|
7146
7147
|
expires_at: { format: 'date-time', type: 'string' },
|
|
7147
7148
|
token: { type: 'string' },
|
|
@@ -20540,18 +20541,18 @@ export default {
|
|
|
20540
20541
|
name: 'client-session-token',
|
|
20541
20542
|
type: 'apiKey',
|
|
20542
20543
|
},
|
|
20543
|
-
|
|
20544
|
-
bearerFormat: '
|
|
20544
|
+
client_session_with_customer: {
|
|
20545
|
+
bearerFormat: 'Customer Client Session Token',
|
|
20545
20546
|
scheme: 'bearer',
|
|
20546
20547
|
type: 'http',
|
|
20547
20548
|
},
|
|
20548
|
-
|
|
20549
|
+
console_session_with_workspace: {
|
|
20549
20550
|
bearerFormat: 'Console Session Token',
|
|
20550
20551
|
scheme: 'bearer',
|
|
20551
20552
|
type: 'http',
|
|
20552
20553
|
},
|
|
20553
|
-
|
|
20554
|
-
bearerFormat: '
|
|
20554
|
+
console_session_without_workspace: {
|
|
20555
|
+
bearerFormat: 'Console Session Token',
|
|
20555
20556
|
scheme: 'bearer',
|
|
20556
20557
|
type: 'http',
|
|
20557
20558
|
},
|
|
@@ -20593,7 +20594,7 @@ export default {
|
|
|
20593
20594
|
properties: {
|
|
20594
20595
|
allow_external_modification: {
|
|
20595
20596
|
description:
|
|
20596
|
-
'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
20597
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
20597
20598
|
type: 'boolean',
|
|
20598
20599
|
},
|
|
20599
20600
|
attempt_for_offline_device: {
|
|
@@ -20625,7 +20626,7 @@ export default {
|
|
|
20625
20626
|
},
|
|
20626
20627
|
is_external_modification_allowed: {
|
|
20627
20628
|
description:
|
|
20628
|
-
'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
20629
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
20629
20630
|
type: 'boolean',
|
|
20630
20631
|
},
|
|
20631
20632
|
is_offline_access_code: {
|
|
@@ -20673,7 +20674,7 @@ export default {
|
|
|
20673
20674
|
},
|
|
20674
20675
|
use_backup_access_code_pool: {
|
|
20675
20676
|
description:
|
|
20676
|
-
'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
|
|
20677
|
+
'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).',
|
|
20677
20678
|
type: 'boolean',
|
|
20678
20679
|
},
|
|
20679
20680
|
use_offline_access_code: { type: 'boolean' },
|
|
@@ -20734,7 +20735,7 @@ export default {
|
|
|
20734
20735
|
properties: {
|
|
20735
20736
|
allow_external_modification: {
|
|
20736
20737
|
description:
|
|
20737
|
-
'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
20738
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
20738
20739
|
type: 'boolean',
|
|
20739
20740
|
},
|
|
20740
20741
|
attempt_for_offline_device: {
|
|
@@ -20768,7 +20769,7 @@ export default {
|
|
|
20768
20769
|
},
|
|
20769
20770
|
is_external_modification_allowed: {
|
|
20770
20771
|
description:
|
|
20771
|
-
'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
20772
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
20772
20773
|
type: 'boolean',
|
|
20773
20774
|
},
|
|
20774
20775
|
is_offline_access_code: {
|
|
@@ -20811,7 +20812,7 @@ export default {
|
|
|
20811
20812
|
},
|
|
20812
20813
|
use_backup_access_code_pool: {
|
|
20813
20814
|
description:
|
|
20814
|
-
'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
|
|
20815
|
+
'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).',
|
|
20815
20816
|
type: 'boolean',
|
|
20816
20817
|
},
|
|
20817
20818
|
use_offline_access_code: { type: 'boolean' },
|
|
@@ -20869,7 +20870,7 @@ export default {
|
|
|
20869
20870
|
properties: {
|
|
20870
20871
|
allow_external_modification: {
|
|
20871
20872
|
description:
|
|
20872
|
-
'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
20873
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
20873
20874
|
type: 'boolean',
|
|
20874
20875
|
},
|
|
20875
20876
|
attempt_for_offline_device: {
|
|
@@ -20903,7 +20904,7 @@ export default {
|
|
|
20903
20904
|
},
|
|
20904
20905
|
is_external_modification_allowed: {
|
|
20905
20906
|
description:
|
|
20906
|
-
'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
20907
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
20907
20908
|
type: 'boolean',
|
|
20908
20909
|
},
|
|
20909
20910
|
is_offline_access_code: {
|
|
@@ -20946,7 +20947,7 @@ export default {
|
|
|
20946
20947
|
},
|
|
20947
20948
|
use_backup_access_code_pool: {
|
|
20948
20949
|
description:
|
|
20949
|
-
'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
|
|
20950
|
+
'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).',
|
|
20950
20951
|
type: 'boolean',
|
|
20951
20952
|
},
|
|
20952
20953
|
use_offline_access_code: { type: 'boolean' },
|
|
@@ -21974,7 +21975,7 @@ export default {
|
|
|
21974
21975
|
},
|
|
21975
21976
|
allow_external_modification: {
|
|
21976
21977
|
description:
|
|
21977
|
-
'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
21978
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
21978
21979
|
type: 'boolean',
|
|
21979
21980
|
},
|
|
21980
21981
|
attempt_for_offline_device: {
|
|
@@ -22001,7 +22002,7 @@ export default {
|
|
|
22001
22002
|
},
|
|
22002
22003
|
is_external_modification_allowed: {
|
|
22003
22004
|
description:
|
|
22004
|
-
'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
22005
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
22005
22006
|
type: 'boolean',
|
|
22006
22007
|
},
|
|
22007
22008
|
is_managed: {
|
|
@@ -22060,7 +22061,7 @@ export default {
|
|
|
22060
22061
|
},
|
|
22061
22062
|
use_backup_access_code_pool: {
|
|
22062
22063
|
description:
|
|
22063
|
-
'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
|
|
22064
|
+
'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).',
|
|
22064
22065
|
type: 'boolean',
|
|
22065
22066
|
},
|
|
22066
22067
|
use_offline_access_code: { type: 'boolean' },
|
|
@@ -22122,7 +22123,7 @@ export default {
|
|
|
22122
22123
|
},
|
|
22123
22124
|
allow_external_modification: {
|
|
22124
22125
|
description:
|
|
22125
|
-
'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
22126
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
22126
22127
|
type: 'boolean',
|
|
22127
22128
|
},
|
|
22128
22129
|
attempt_for_offline_device: {
|
|
@@ -22149,7 +22150,7 @@ export default {
|
|
|
22149
22150
|
},
|
|
22150
22151
|
is_external_modification_allowed: {
|
|
22151
22152
|
description:
|
|
22152
|
-
'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
22153
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
22153
22154
|
type: 'boolean',
|
|
22154
22155
|
},
|
|
22155
22156
|
is_managed: {
|
|
@@ -22208,7 +22209,7 @@ export default {
|
|
|
22208
22209
|
},
|
|
22209
22210
|
use_backup_access_code_pool: {
|
|
22210
22211
|
description:
|
|
22211
|
-
'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
|
|
22212
|
+
'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).',
|
|
22212
22213
|
type: 'boolean',
|
|
22213
22214
|
},
|
|
22214
22215
|
use_offline_access_code: { type: 'boolean' },
|
|
@@ -22271,7 +22272,7 @@ export default {
|
|
|
22271
22272
|
},
|
|
22272
22273
|
allow_external_modification: {
|
|
22273
22274
|
description:
|
|
22274
|
-
'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
22275
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
22275
22276
|
type: 'boolean',
|
|
22276
22277
|
},
|
|
22277
22278
|
attempt_for_offline_device: {
|
|
@@ -22298,7 +22299,7 @@ export default {
|
|
|
22298
22299
|
},
|
|
22299
22300
|
is_external_modification_allowed: {
|
|
22300
22301
|
description:
|
|
22301
|
-
'Indicates whether [external modification](https://docs.seam.co/latest/
|
|
22302
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
|
|
22302
22303
|
type: 'boolean',
|
|
22303
22304
|
},
|
|
22304
22305
|
is_managed: {
|
|
@@ -22357,7 +22358,7 @@ export default {
|
|
|
22357
22358
|
},
|
|
22358
22359
|
use_backup_access_code_pool: {
|
|
22359
22360
|
description:
|
|
22360
|
-
'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
|
|
22361
|
+
'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).',
|
|
22361
22362
|
type: 'boolean',
|
|
22362
22363
|
},
|
|
22363
22364
|
use_offline_access_code: { type: 'boolean' },
|
|
@@ -27681,7 +27682,7 @@ export default {
|
|
|
27681
27682
|
},
|
|
27682
27683
|
security: [
|
|
27683
27684
|
{ client_session: [] },
|
|
27684
|
-
{
|
|
27685
|
+
{ client_session_with_customer: [] },
|
|
27685
27686
|
{ pat_with_workspace: [] },
|
|
27686
27687
|
{ console_session_with_workspace: [] },
|
|
27687
27688
|
{ api_key: [] },
|
|
@@ -27793,7 +27794,7 @@ export default {
|
|
|
27793
27794
|
},
|
|
27794
27795
|
security: [
|
|
27795
27796
|
{ client_session: [] },
|
|
27796
|
-
{
|
|
27797
|
+
{ client_session_with_customer: [] },
|
|
27797
27798
|
{ pat_with_workspace: [] },
|
|
27798
27799
|
{ console_session_with_workspace: [] },
|
|
27799
27800
|
{ api_key: [] },
|
|
@@ -27825,7 +27826,7 @@ export default {
|
|
|
27825
27826
|
'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.',
|
|
27826
27827
|
type: 'object',
|
|
27827
27828
|
},
|
|
27828
|
-
|
|
27829
|
+
customer_ids: { items: { type: 'string' }, type: 'array' },
|
|
27829
27830
|
limit: {
|
|
27830
27831
|
default: 500,
|
|
27831
27832
|
description:
|
|
@@ -27868,7 +27869,7 @@ export default {
|
|
|
27868
27869
|
},
|
|
27869
27870
|
security: [
|
|
27870
27871
|
{ client_session: [] },
|
|
27871
|
-
{
|
|
27872
|
+
{ client_session_with_customer: [] },
|
|
27872
27873
|
{ pat_with_workspace: [] },
|
|
27873
27874
|
{ console_session_with_workspace: [] },
|
|
27874
27875
|
{ api_key: [] },
|
|
@@ -27930,7 +27931,7 @@ export default {
|
|
|
27930
27931
|
{ api_key: [] },
|
|
27931
27932
|
{ pat_with_workspace: [] },
|
|
27932
27933
|
{ console_session_with_workspace: [] },
|
|
27933
|
-
{
|
|
27934
|
+
{ client_session_with_customer: [] },
|
|
27934
27935
|
],
|
|
27935
27936
|
summary: '/connected_accounts/delete',
|
|
27936
27937
|
tags: ['/connected_accounts'],
|
|
@@ -28089,7 +28090,7 @@ export default {
|
|
|
28089
28090
|
{ api_key: [] },
|
|
28090
28091
|
{ pat_with_workspace: [] },
|
|
28091
28092
|
{ console_session_with_workspace: [] },
|
|
28092
|
-
{
|
|
28093
|
+
{ client_session_with_customer: [] },
|
|
28093
28094
|
],
|
|
28094
28095
|
summary: '/connected_accounts/list',
|
|
28095
28096
|
tags: ['/connected_accounts'],
|
|
@@ -28327,7 +28328,7 @@ export default {
|
|
|
28327
28328
|
},
|
|
28328
28329
|
security: [
|
|
28329
28330
|
{ client_session: [] },
|
|
28330
|
-
{
|
|
28331
|
+
{ client_session_with_customer: [] },
|
|
28331
28332
|
{ pat_with_workspace: [] },
|
|
28332
28333
|
{ console_session_with_workspace: [] },
|
|
28333
28334
|
{ api_key: [] },
|
|
@@ -28664,7 +28665,7 @@ export default {
|
|
|
28664
28665
|
401: { description: 'Unauthorized' },
|
|
28665
28666
|
},
|
|
28666
28667
|
security: [
|
|
28667
|
-
{
|
|
28668
|
+
{ client_session_with_customer: [] },
|
|
28668
28669
|
{ client_session: [] },
|
|
28669
28670
|
{ pat_with_workspace: [] },
|
|
28670
28671
|
{ console_session_with_workspace: [] },
|
|
@@ -29966,7 +29967,7 @@ export default {
|
|
|
29966
29967
|
{ api_key: [] },
|
|
29967
29968
|
{ pat_with_workspace: [] },
|
|
29968
29969
|
{ console_session_with_workspace: [] },
|
|
29969
|
-
{
|
|
29970
|
+
{ client_session_with_customer: [] },
|
|
29970
29971
|
],
|
|
29971
29972
|
summary: '/events/list',
|
|
29972
29973
|
tags: ['/events'],
|
|
@@ -29979,14 +29980,23 @@ export default {
|
|
|
29979
29980
|
},
|
|
29980
29981
|
'/locks/get': {
|
|
29981
29982
|
post: {
|
|
29983
|
+
description:
|
|
29984
|
+
'Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks). **Use `/devices/get` instead.**',
|
|
29982
29985
|
operationId: 'locksGetPost',
|
|
29983
29986
|
requestBody: {
|
|
29984
29987
|
content: {
|
|
29985
29988
|
'application/json': {
|
|
29986
29989
|
schema: {
|
|
29987
29990
|
properties: {
|
|
29988
|
-
device_id: {
|
|
29989
|
-
|
|
29991
|
+
device_id: {
|
|
29992
|
+
description: 'ID of the lock that you want to get.',
|
|
29993
|
+
format: 'uuid',
|
|
29994
|
+
type: 'string',
|
|
29995
|
+
},
|
|
29996
|
+
name: {
|
|
29997
|
+
description: 'Name of the lock that you want to get.',
|
|
29998
|
+
type: 'string',
|
|
29999
|
+
},
|
|
29990
30000
|
},
|
|
29991
30001
|
type: 'object',
|
|
29992
30002
|
},
|
|
@@ -30026,10 +30036,13 @@ export default {
|
|
|
30026
30036
|
'x-fern-sdk-method-name': 'get',
|
|
30027
30037
|
'x-fern-sdk-return-value': 'device',
|
|
30028
30038
|
'x-response-key': 'device',
|
|
30039
|
+
'x-title': 'Get a Lock',
|
|
30029
30040
|
},
|
|
30030
30041
|
},
|
|
30031
30042
|
'/locks/list': {
|
|
30032
30043
|
post: {
|
|
30044
|
+
description:
|
|
30045
|
+
'Returns a list of all [locks](https://docs.seam.co/latest/capability-guides/smart-locks).',
|
|
30033
30046
|
operationId: 'locksListPost',
|
|
30034
30047
|
requestBody: {
|
|
30035
30048
|
content: {
|
|
@@ -30079,7 +30092,8 @@ export default {
|
|
|
30079
30092
|
type: 'array',
|
|
30080
30093
|
},
|
|
30081
30094
|
device_type: {
|
|
30082
|
-
description:
|
|
30095
|
+
description:
|
|
30096
|
+
'Device type of the locks that you want to list.',
|
|
30083
30097
|
enum: [
|
|
30084
30098
|
'akuvox_lock',
|
|
30085
30099
|
'august_lock',
|
|
@@ -30113,7 +30127,7 @@ export default {
|
|
|
30113
30127
|
},
|
|
30114
30128
|
device_types: {
|
|
30115
30129
|
description:
|
|
30116
|
-
'
|
|
30130
|
+
'Device types of the locks that you want to list.',
|
|
30117
30131
|
items: {
|
|
30118
30132
|
description: 'Device type for smartlocks.\n ',
|
|
30119
30133
|
enum: [
|
|
@@ -30197,7 +30211,8 @@ export default {
|
|
|
30197
30211
|
type: 'number',
|
|
30198
30212
|
},
|
|
30199
30213
|
manufacturer: {
|
|
30200
|
-
description:
|
|
30214
|
+
description:
|
|
30215
|
+
'Manufacturer of the locks that you want to list.',
|
|
30201
30216
|
enum: [
|
|
30202
30217
|
'akuvox',
|
|
30203
30218
|
'august',
|
|
@@ -30293,18 +30308,29 @@ export default {
|
|
|
30293
30308
|
'x-fern-sdk-method-name': 'list',
|
|
30294
30309
|
'x-fern-sdk-return-value': 'devices',
|
|
30295
30310
|
'x-response-key': 'devices',
|
|
30311
|
+
'x-title': 'List Locks',
|
|
30296
30312
|
},
|
|
30297
30313
|
},
|
|
30298
30314
|
'/locks/lock_door': {
|
|
30299
30315
|
post: {
|
|
30316
|
+
description:
|
|
30317
|
+
'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).',
|
|
30300
30318
|
operationId: 'locksLockDoorPost',
|
|
30301
30319
|
requestBody: {
|
|
30302
30320
|
content: {
|
|
30303
30321
|
'application/json': {
|
|
30304
30322
|
schema: {
|
|
30305
30323
|
properties: {
|
|
30306
|
-
device_id: {
|
|
30307
|
-
|
|
30324
|
+
device_id: {
|
|
30325
|
+
description: 'ID of the lock that you want to lock.',
|
|
30326
|
+
format: 'uuid',
|
|
30327
|
+
type: 'string',
|
|
30328
|
+
},
|
|
30329
|
+
sync: {
|
|
30330
|
+
default: false,
|
|
30331
|
+
type: 'boolean',
|
|
30332
|
+
'x-undocumented': 'Only used internally.',
|
|
30333
|
+
},
|
|
30308
30334
|
},
|
|
30309
30335
|
required: ['device_id'],
|
|
30310
30336
|
type: 'object',
|
|
@@ -30346,18 +30372,30 @@ export default {
|
|
|
30346
30372
|
'x-fern-sdk-method-name': 'lock_door',
|
|
30347
30373
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
30348
30374
|
'x-response-key': 'action_attempt',
|
|
30375
|
+
'x-title': 'Lock a Lock',
|
|
30349
30376
|
},
|
|
30350
30377
|
},
|
|
30351
30378
|
'/locks/simulate/keypad_code_entry': {
|
|
30352
30379
|
post: {
|
|
30380
|
+
description:
|
|
30381
|
+
'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).',
|
|
30353
30382
|
operationId: 'locksSimulateKeypadCodeEntryPost',
|
|
30354
30383
|
requestBody: {
|
|
30355
30384
|
content: {
|
|
30356
30385
|
'application/json': {
|
|
30357
30386
|
schema: {
|
|
30358
30387
|
properties: {
|
|
30359
|
-
code: {
|
|
30360
|
-
|
|
30388
|
+
code: {
|
|
30389
|
+
description:
|
|
30390
|
+
'Code that you want to simulate entering on a keypad.',
|
|
30391
|
+
type: 'string',
|
|
30392
|
+
},
|
|
30393
|
+
device_id: {
|
|
30394
|
+
description:
|
|
30395
|
+
'ID of the device for which you want to simulate a keypad code entry.',
|
|
30396
|
+
format: 'uuid',
|
|
30397
|
+
type: 'string',
|
|
30398
|
+
},
|
|
30361
30399
|
},
|
|
30362
30400
|
required: ['device_id', 'code'],
|
|
30363
30401
|
type: 'object',
|
|
@@ -30403,12 +30441,21 @@ export default {
|
|
|
30403
30441
|
},
|
|
30404
30442
|
'/locks/simulate/manual_lock_via_keypad': {
|
|
30405
30443
|
post: {
|
|
30444
|
+
description:
|
|
30445
|
+
'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).',
|
|
30406
30446
|
operationId: 'locksSimulateManualLockViaKeypadPost',
|
|
30407
30447
|
requestBody: {
|
|
30408
30448
|
content: {
|
|
30409
30449
|
'application/json': {
|
|
30410
30450
|
schema: {
|
|
30411
|
-
properties: {
|
|
30451
|
+
properties: {
|
|
30452
|
+
device_id: {
|
|
30453
|
+
description:
|
|
30454
|
+
'ID of the device for which you want to simulate a manual lock action using a keypad.',
|
|
30455
|
+
format: 'uuid',
|
|
30456
|
+
type: 'string',
|
|
30457
|
+
},
|
|
30458
|
+
},
|
|
30412
30459
|
required: ['device_id'],
|
|
30413
30460
|
type: 'object',
|
|
30414
30461
|
},
|
|
@@ -30453,14 +30500,24 @@ export default {
|
|
|
30453
30500
|
},
|
|
30454
30501
|
'/locks/unlock_door': {
|
|
30455
30502
|
post: {
|
|
30503
|
+
description:
|
|
30504
|
+
'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).',
|
|
30456
30505
|
operationId: 'locksUnlockDoorPost',
|
|
30457
30506
|
requestBody: {
|
|
30458
30507
|
content: {
|
|
30459
30508
|
'application/json': {
|
|
30460
30509
|
schema: {
|
|
30461
30510
|
properties: {
|
|
30462
|
-
device_id: {
|
|
30463
|
-
|
|
30511
|
+
device_id: {
|
|
30512
|
+
description: 'ID of the lock that you want to unlock.',
|
|
30513
|
+
format: 'uuid',
|
|
30514
|
+
type: 'string',
|
|
30515
|
+
},
|
|
30516
|
+
sync: {
|
|
30517
|
+
default: false,
|
|
30518
|
+
type: 'boolean',
|
|
30519
|
+
'x-undocumented': 'Only used internally.',
|
|
30520
|
+
},
|
|
30464
30521
|
},
|
|
30465
30522
|
required: ['device_id'],
|
|
30466
30523
|
type: 'object',
|
|
@@ -30502,6 +30559,7 @@ export default {
|
|
|
30502
30559
|
'x-fern-sdk-method-name': 'unlock_door',
|
|
30503
30560
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
30504
30561
|
'x-response-key': 'action_attempt',
|
|
30562
|
+
'x-title': 'Unlock a Lock',
|
|
30505
30563
|
},
|
|
30506
30564
|
},
|
|
30507
30565
|
'/networks/get': {
|
|
@@ -30544,10 +30602,12 @@ export default {
|
|
|
30544
30602
|
],
|
|
30545
30603
|
summary: '/networks/get',
|
|
30546
30604
|
tags: ['/networks'],
|
|
30605
|
+
'x-deprecated': 'Will be removed.',
|
|
30547
30606
|
'x-fern-sdk-group-name': ['networks'],
|
|
30548
30607
|
'x-fern-sdk-method-name': 'get',
|
|
30549
30608
|
'x-fern-sdk-return-value': 'network',
|
|
30550
30609
|
'x-response-key': 'network',
|
|
30610
|
+
'x-undocumented': 'Deprecated.',
|
|
30551
30611
|
},
|
|
30552
30612
|
},
|
|
30553
30613
|
'/networks/list': {
|
|
@@ -30587,10 +30647,12 @@ export default {
|
|
|
30587
30647
|
],
|
|
30588
30648
|
summary: '/networks/list',
|
|
30589
30649
|
tags: ['/networks'],
|
|
30650
|
+
'x-deprecated': 'Will be removed.',
|
|
30590
30651
|
'x-fern-sdk-group-name': ['networks'],
|
|
30591
30652
|
'x-fern-sdk-method-name': 'list',
|
|
30592
30653
|
'x-fern-sdk-return-value': 'networks',
|
|
30593
30654
|
'x-response-key': 'networks',
|
|
30655
|
+
'x-undocumented': 'Deprecated.',
|
|
30594
30656
|
},
|
|
30595
30657
|
},
|
|
30596
30658
|
'/noise_sensors/list': {
|
|
@@ -32856,7 +32918,7 @@ export default {
|
|
|
32856
32918
|
400: { description: 'Bad Request' },
|
|
32857
32919
|
401: { description: 'Unauthorized' },
|
|
32858
32920
|
},
|
|
32859
|
-
security: [{
|
|
32921
|
+
security: [{ client_session_with_customer: [] }],
|
|
32860
32922
|
summary: '/seam/partner/v1/resources/list',
|
|
32861
32923
|
tags: [],
|
|
32862
32924
|
'x-fern-sdk-group-name': ['seam', 'partner', 'v1', 'resources'],
|
|
@@ -35749,7 +35811,7 @@ export default {
|
|
|
35749
35811
|
{ pat_with_workspace: [] },
|
|
35750
35812
|
{ console_session_with_workspace: [] },
|
|
35751
35813
|
{ api_key: [] },
|
|
35752
|
-
{
|
|
35814
|
+
{ client_session_with_customer: [] },
|
|
35753
35815
|
],
|
|
35754
35816
|
summary: '/unstable_access_grants/create',
|
|
35755
35817
|
tags: [],
|
|
@@ -35802,7 +35864,7 @@ export default {
|
|
|
35802
35864
|
{ pat_with_workspace: [] },
|
|
35803
35865
|
{ console_session_with_workspace: [] },
|
|
35804
35866
|
{ api_key: [] },
|
|
35805
|
-
{
|
|
35867
|
+
{ client_session_with_customer: [] },
|
|
35806
35868
|
],
|
|
35807
35869
|
summary: '/unstable_access_grants/delete',
|
|
35808
35870
|
tags: [],
|
|
@@ -35951,7 +36013,7 @@ export default {
|
|
|
35951
36013
|
{ pat_with_workspace: [] },
|
|
35952
36014
|
{ console_session_with_workspace: [] },
|
|
35953
36015
|
{ api_key: [] },
|
|
35954
|
-
{
|
|
36016
|
+
{ client_session_with_customer: [] },
|
|
35955
36017
|
],
|
|
35956
36018
|
summary: '/unstable_access_grants/get',
|
|
35957
36019
|
tags: [],
|
|
@@ -36122,7 +36184,7 @@ export default {
|
|
|
36122
36184
|
{ pat_with_workspace: [] },
|
|
36123
36185
|
{ console_session_with_workspace: [] },
|
|
36124
36186
|
{ api_key: [] },
|
|
36125
|
-
{
|
|
36187
|
+
{ client_session_with_customer: [] },
|
|
36126
36188
|
],
|
|
36127
36189
|
summary: '/unstable_access_grants/list',
|
|
36128
36190
|
tags: [],
|