@seamapi/types 1.992.0 → 1.994.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -37022,6 +37022,7 @@ const openapi: OpenAPISpec = {
|
|
|
37022
37022
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
37023
37023
|
'x-fern-sdk-method-name': 'get',
|
|
37024
37024
|
'x-fern-sdk-return-value': 'access_code',
|
|
37025
|
+
'x-has-required-parameters': true,
|
|
37025
37026
|
'x-response-key': 'access_code',
|
|
37026
37027
|
'x-title': 'Get an Access Code',
|
|
37027
37028
|
},
|
|
@@ -37090,6 +37091,7 @@ const openapi: OpenAPISpec = {
|
|
|
37090
37091
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
37091
37092
|
'x-fern-sdk-method-name': 'get',
|
|
37092
37093
|
'x-fern-sdk-return-value': 'access_code',
|
|
37094
|
+
'x-has-required-parameters': true,
|
|
37093
37095
|
'x-response-key': 'access_code',
|
|
37094
37096
|
'x-title': 'Get an Access Code',
|
|
37095
37097
|
},
|
|
@@ -37729,6 +37731,7 @@ const openapi: OpenAPISpec = {
|
|
|
37729
37731
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
37730
37732
|
'x-fern-sdk-method-name': 'list',
|
|
37731
37733
|
'x-fern-sdk-return-value': 'access_codes',
|
|
37734
|
+
'x-has-required-parameters': true,
|
|
37732
37735
|
'x-response-key': 'access_codes',
|
|
37733
37736
|
'x-title': 'List Access Codes',
|
|
37734
37737
|
},
|
|
@@ -37842,6 +37845,7 @@ const openapi: OpenAPISpec = {
|
|
|
37842
37845
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
37843
37846
|
'x-fern-sdk-method-name': 'list',
|
|
37844
37847
|
'x-fern-sdk-return-value': 'access_codes',
|
|
37848
|
+
'x-has-required-parameters': true,
|
|
37845
37849
|
'x-response-key': 'access_codes',
|
|
37846
37850
|
'x-title': 'List Access Codes',
|
|
37847
37851
|
},
|
|
@@ -38398,6 +38402,7 @@ const openapi: OpenAPISpec = {
|
|
|
38398
38402
|
'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
|
|
38399
38403
|
'x-fern-sdk-method-name': 'get',
|
|
38400
38404
|
'x-fern-sdk-return-value': 'access_code',
|
|
38405
|
+
'x-has-required-parameters': true,
|
|
38401
38406
|
'x-response-key': 'access_code',
|
|
38402
38407
|
'x-title': 'Get an Unmanaged Access Code',
|
|
38403
38408
|
},
|
|
@@ -38468,6 +38473,7 @@ const openapi: OpenAPISpec = {
|
|
|
38468
38473
|
'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
|
|
38469
38474
|
'x-fern-sdk-method-name': 'get',
|
|
38470
38475
|
'x-fern-sdk-return-value': 'access_code',
|
|
38476
|
+
'x-has-required-parameters': true,
|
|
38471
38477
|
'x-response-key': 'access_code',
|
|
38472
38478
|
'x-title': 'Get an Unmanaged Access Code',
|
|
38473
38479
|
},
|
|
@@ -38856,38 +38862,11 @@ const openapi: OpenAPISpec = {
|
|
|
38856
38862
|
'Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.',
|
|
38857
38863
|
type: 'boolean',
|
|
38858
38864
|
},
|
|
38859
|
-
is_offline_access_code: {
|
|
38860
|
-
description:
|
|
38861
|
-
'Indicates whether the access code is an [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes).',
|
|
38862
|
-
type: 'boolean',
|
|
38863
|
-
},
|
|
38864
|
-
is_one_time_use: {
|
|
38865
|
-
description:
|
|
38866
|
-
'Indicates whether the [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
|
|
38867
|
-
type: 'boolean',
|
|
38868
|
-
},
|
|
38869
|
-
max_time_rounding: {
|
|
38870
|
-
description:
|
|
38871
|
-
'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
|
|
38872
|
-
enum: ['1hour', '1day', '1h', '1d'],
|
|
38873
|
-
type: 'string',
|
|
38874
|
-
},
|
|
38875
38865
|
name: {
|
|
38876
38866
|
description:
|
|
38877
38867
|
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
38878
38868
|
type: 'string',
|
|
38879
38869
|
},
|
|
38880
|
-
prefer_native_scheduling: {
|
|
38881
|
-
description:
|
|
38882
|
-
'Indicates whether [native scheduling](https://docs.seam.co/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.',
|
|
38883
|
-
type: 'boolean',
|
|
38884
|
-
},
|
|
38885
|
-
preferred_code_length: {
|
|
38886
|
-
description:
|
|
38887
|
-
'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
|
|
38888
|
-
format: 'float',
|
|
38889
|
-
type: 'number',
|
|
38890
|
-
},
|
|
38891
38870
|
starts_at: {
|
|
38892
38871
|
description:
|
|
38893
38872
|
'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
@@ -38904,16 +38883,6 @@ const openapi: OpenAPISpec = {
|
|
|
38904
38883
|
enum: ['ongoing', 'time_bound'],
|
|
38905
38884
|
type: 'string',
|
|
38906
38885
|
},
|
|
38907
|
-
use_backup_access_code_pool: {
|
|
38908
|
-
description:
|
|
38909
|
-
'Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/api/access_codes/pull_backup_access_code).',
|
|
38910
|
-
type: 'boolean',
|
|
38911
|
-
},
|
|
38912
|
-
use_offline_access_code: {
|
|
38913
|
-
deprecated: true,
|
|
38914
|
-
type: 'boolean',
|
|
38915
|
-
'x-deprecated': 'Use `is_offline_access_code` instead.',
|
|
38916
|
-
},
|
|
38917
38886
|
},
|
|
38918
38887
|
required: ['access_code_id'],
|
|
38919
38888
|
type: 'object',
|
|
@@ -39009,38 +38978,11 @@ const openapi: OpenAPISpec = {
|
|
|
39009
38978
|
'Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.',
|
|
39010
38979
|
type: 'boolean',
|
|
39011
38980
|
},
|
|
39012
|
-
is_offline_access_code: {
|
|
39013
|
-
description:
|
|
39014
|
-
'Indicates whether the access code is an [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes).',
|
|
39015
|
-
type: 'boolean',
|
|
39016
|
-
},
|
|
39017
|
-
is_one_time_use: {
|
|
39018
|
-
description:
|
|
39019
|
-
'Indicates whether the [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
|
|
39020
|
-
type: 'boolean',
|
|
39021
|
-
},
|
|
39022
|
-
max_time_rounding: {
|
|
39023
|
-
description:
|
|
39024
|
-
'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
|
|
39025
|
-
enum: ['1hour', '1day', '1h', '1d'],
|
|
39026
|
-
type: 'string',
|
|
39027
|
-
},
|
|
39028
38981
|
name: {
|
|
39029
38982
|
description:
|
|
39030
38983
|
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
39031
38984
|
type: 'string',
|
|
39032
38985
|
},
|
|
39033
|
-
prefer_native_scheduling: {
|
|
39034
|
-
description:
|
|
39035
|
-
'Indicates whether [native scheduling](https://docs.seam.co/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.',
|
|
39036
|
-
type: 'boolean',
|
|
39037
|
-
},
|
|
39038
|
-
preferred_code_length: {
|
|
39039
|
-
description:
|
|
39040
|
-
'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
|
|
39041
|
-
format: 'float',
|
|
39042
|
-
type: 'number',
|
|
39043
|
-
},
|
|
39044
38986
|
starts_at: {
|
|
39045
38987
|
description:
|
|
39046
38988
|
'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
@@ -39057,16 +38999,6 @@ const openapi: OpenAPISpec = {
|
|
|
39057
38999
|
enum: ['ongoing', 'time_bound'],
|
|
39058
39000
|
type: 'string',
|
|
39059
39001
|
},
|
|
39060
|
-
use_backup_access_code_pool: {
|
|
39061
|
-
description:
|
|
39062
|
-
'Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/api/access_codes/pull_backup_access_code).',
|
|
39063
|
-
type: 'boolean',
|
|
39064
|
-
},
|
|
39065
|
-
use_offline_access_code: {
|
|
39066
|
-
deprecated: true,
|
|
39067
|
-
type: 'boolean',
|
|
39068
|
-
'x-deprecated': 'Use `is_offline_access_code` instead.',
|
|
39069
|
-
},
|
|
39070
39002
|
},
|
|
39071
39003
|
required: ['access_code_id'],
|
|
39072
39004
|
type: 'object',
|
|
@@ -39162,38 +39094,11 @@ const openapi: OpenAPISpec = {
|
|
|
39162
39094
|
'Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.',
|
|
39163
39095
|
type: 'boolean',
|
|
39164
39096
|
},
|
|
39165
|
-
is_offline_access_code: {
|
|
39166
|
-
description:
|
|
39167
|
-
'Indicates whether the access code is an [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes).',
|
|
39168
|
-
type: 'boolean',
|
|
39169
|
-
},
|
|
39170
|
-
is_one_time_use: {
|
|
39171
|
-
description:
|
|
39172
|
-
'Indicates whether the [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
|
|
39173
|
-
type: 'boolean',
|
|
39174
|
-
},
|
|
39175
|
-
max_time_rounding: {
|
|
39176
|
-
description:
|
|
39177
|
-
'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
|
|
39178
|
-
enum: ['1hour', '1day', '1h', '1d'],
|
|
39179
|
-
type: 'string',
|
|
39180
|
-
},
|
|
39181
39097
|
name: {
|
|
39182
39098
|
description:
|
|
39183
39099
|
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
39184
39100
|
type: 'string',
|
|
39185
39101
|
},
|
|
39186
|
-
prefer_native_scheduling: {
|
|
39187
|
-
description:
|
|
39188
|
-
'Indicates whether [native scheduling](https://docs.seam.co/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.',
|
|
39189
|
-
type: 'boolean',
|
|
39190
|
-
},
|
|
39191
|
-
preferred_code_length: {
|
|
39192
|
-
description:
|
|
39193
|
-
'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
|
|
39194
|
-
format: 'float',
|
|
39195
|
-
type: 'number',
|
|
39196
|
-
},
|
|
39197
39102
|
starts_at: {
|
|
39198
39103
|
description:
|
|
39199
39104
|
'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
@@ -39210,16 +39115,6 @@ const openapi: OpenAPISpec = {
|
|
|
39210
39115
|
enum: ['ongoing', 'time_bound'],
|
|
39211
39116
|
type: 'string',
|
|
39212
39117
|
},
|
|
39213
|
-
use_backup_access_code_pool: {
|
|
39214
|
-
description:
|
|
39215
|
-
'Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/api/access_codes/pull_backup_access_code).',
|
|
39216
|
-
type: 'boolean',
|
|
39217
|
-
},
|
|
39218
|
-
use_offline_access_code: {
|
|
39219
|
-
deprecated: true,
|
|
39220
|
-
type: 'boolean',
|
|
39221
|
-
'x-deprecated': 'Use `is_offline_access_code` instead.',
|
|
39222
|
-
},
|
|
39223
39118
|
},
|
|
39224
39119
|
required: ['access_code_id'],
|
|
39225
39120
|
type: 'object',
|
|
@@ -39984,6 +39879,7 @@ const openapi: OpenAPISpec = {
|
|
|
39984
39879
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
39985
39880
|
'x-fern-sdk-method-name': 'get_related',
|
|
39986
39881
|
'x-fern-sdk-return-value': 'batch',
|
|
39882
|
+
'x-has-required-parameters': true,
|
|
39987
39883
|
'x-response-key': 'batch',
|
|
39988
39884
|
'x-title': 'Get related Access Grant resources',
|
|
39989
39885
|
},
|
|
@@ -40128,6 +40024,7 @@ const openapi: OpenAPISpec = {
|
|
|
40128
40024
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
40129
40025
|
'x-fern-sdk-method-name': 'get_related',
|
|
40130
40026
|
'x-fern-sdk-return-value': 'batch',
|
|
40027
|
+
'x-has-required-parameters': true,
|
|
40131
40028
|
'x-response-key': 'batch',
|
|
40132
40029
|
'x-title': 'Get related Access Grant resources',
|
|
40133
40030
|
},
|
|
@@ -41028,6 +40925,7 @@ const openapi: OpenAPISpec = {
|
|
|
41028
40925
|
tags: [],
|
|
41029
40926
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
41030
40927
|
'x-fern-sdk-method-name': 'update',
|
|
40928
|
+
'x-has-required-parameters': true,
|
|
41031
40929
|
'x-response-key': null,
|
|
41032
40930
|
'x-title': 'Update an Access Grant',
|
|
41033
40931
|
},
|
|
@@ -41101,6 +40999,7 @@ const openapi: OpenAPISpec = {
|
|
|
41101
40999
|
tags: [],
|
|
41102
41000
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
41103
41001
|
'x-fern-sdk-method-name': 'update',
|
|
41002
|
+
'x-has-required-parameters': true,
|
|
41104
41003
|
'x-response-key': null,
|
|
41105
41004
|
'x-title': 'Update an Access Grant',
|
|
41106
41005
|
},
|
|
@@ -41861,6 +41760,7 @@ const openapi: OpenAPISpec = {
|
|
|
41861
41760
|
'x-fern-sdk-group-name': ['access_methods'],
|
|
41862
41761
|
'x-fern-sdk-method-name': 'list',
|
|
41863
41762
|
'x-fern-sdk-return-value': 'access_methods',
|
|
41763
|
+
'x-has-required-parameters': true,
|
|
41864
41764
|
'x-response-key': 'access_methods',
|
|
41865
41765
|
'x-title': 'List Access Methods',
|
|
41866
41766
|
},
|
|
@@ -41965,6 +41865,7 @@ const openapi: OpenAPISpec = {
|
|
|
41965
41865
|
'x-fern-sdk-group-name': ['access_methods'],
|
|
41966
41866
|
'x-fern-sdk-method-name': 'list',
|
|
41967
41867
|
'x-fern-sdk-return-value': 'access_methods',
|
|
41868
|
+
'x-has-required-parameters': true,
|
|
41968
41869
|
'x-response-key': 'access_methods',
|
|
41969
41870
|
'x-title': 'List Access Methods',
|
|
41970
41871
|
},
|
|
@@ -47353,6 +47254,7 @@ const openapi: OpenAPISpec = {
|
|
|
47353
47254
|
tags: ['/acs'],
|
|
47354
47255
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
47355
47256
|
'x-fern-sdk-method-name': 'delete',
|
|
47257
|
+
'x-has-required-parameters': true,
|
|
47356
47258
|
'x-response-key': null,
|
|
47357
47259
|
'x-title': 'Delete an ACS User',
|
|
47358
47260
|
},
|
|
@@ -47414,6 +47316,7 @@ const openapi: OpenAPISpec = {
|
|
|
47414
47316
|
tags: ['/acs'],
|
|
47415
47317
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
47416
47318
|
'x-fern-sdk-method-name': 'delete',
|
|
47319
|
+
'x-has-required-parameters': true,
|
|
47417
47320
|
'x-response-key': null,
|
|
47418
47321
|
'x-title': 'Delete an ACS User',
|
|
47419
47322
|
},
|
|
@@ -47485,6 +47388,7 @@ const openapi: OpenAPISpec = {
|
|
|
47485
47388
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
47486
47389
|
'x-fern-sdk-method-name': 'get',
|
|
47487
47390
|
'x-fern-sdk-return-value': 'acs_user',
|
|
47391
|
+
'x-has-required-parameters': true,
|
|
47488
47392
|
'x-response-key': 'acs_user',
|
|
47489
47393
|
'x-title': 'Get an ACS User',
|
|
47490
47394
|
},
|
|
@@ -47551,6 +47455,7 @@ const openapi: OpenAPISpec = {
|
|
|
47551
47455
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
47552
47456
|
'x-fern-sdk-method-name': 'get',
|
|
47553
47457
|
'x-fern-sdk-return-value': 'acs_user',
|
|
47458
|
+
'x-has-required-parameters': true,
|
|
47554
47459
|
'x-response-key': 'acs_user',
|
|
47555
47460
|
'x-title': 'Get an ACS User',
|
|
47556
47461
|
},
|
|
@@ -47852,6 +47757,7 @@ const openapi: OpenAPISpec = {
|
|
|
47852
47757
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
47853
47758
|
'x-fern-sdk-method-name': 'list_accessible_entrances',
|
|
47854
47759
|
'x-fern-sdk-return-value': 'acs_entrances',
|
|
47760
|
+
'x-has-required-parameters': true,
|
|
47855
47761
|
'x-response-key': 'acs_entrances',
|
|
47856
47762
|
'x-title': 'List ACS User-Accessible Entrances',
|
|
47857
47763
|
},
|
|
@@ -47922,6 +47828,7 @@ const openapi: OpenAPISpec = {
|
|
|
47922
47828
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
47923
47829
|
'x-fern-sdk-method-name': 'list_accessible_entrances',
|
|
47924
47830
|
'x-fern-sdk-return-value': 'acs_entrances',
|
|
47831
|
+
'x-has-required-parameters': true,
|
|
47925
47832
|
'x-response-key': 'acs_entrances',
|
|
47926
47833
|
'x-title': 'List ACS User-Accessible Entrances',
|
|
47927
47834
|
},
|
|
@@ -48116,6 +48023,7 @@ const openapi: OpenAPISpec = {
|
|
|
48116
48023
|
tags: ['/acs'],
|
|
48117
48024
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
48118
48025
|
'x-fern-sdk-method-name': 'revoke_access_to_all_entrances',
|
|
48026
|
+
'x-has-required-parameters': true,
|
|
48119
48027
|
'x-response-key': null,
|
|
48120
48028
|
'x-title': 'Revoke ACS User Access to All Entrances',
|
|
48121
48029
|
},
|
|
@@ -48179,6 +48087,7 @@ const openapi: OpenAPISpec = {
|
|
|
48179
48087
|
tags: ['/acs'],
|
|
48180
48088
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
48181
48089
|
'x-fern-sdk-method-name': 'suspend',
|
|
48090
|
+
'x-has-required-parameters': true,
|
|
48182
48091
|
'x-response-key': null,
|
|
48183
48092
|
'x-title': 'Suspend an ACS User',
|
|
48184
48093
|
},
|
|
@@ -48545,6 +48454,7 @@ const openapi: OpenAPISpec = {
|
|
|
48545
48454
|
tags: ['/acs'],
|
|
48546
48455
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
48547
48456
|
'x-fern-sdk-method-name': 'unsuspend',
|
|
48457
|
+
'x-has-required-parameters': true,
|
|
48548
48458
|
'x-response-key': null,
|
|
48549
48459
|
'x-title': 'Unsuspend an ACS User',
|
|
48550
48460
|
},
|
|
@@ -48658,6 +48568,7 @@ const openapi: OpenAPISpec = {
|
|
|
48658
48568
|
tags: ['/acs'],
|
|
48659
48569
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
48660
48570
|
'x-fern-sdk-method-name': 'update',
|
|
48571
|
+
'x-has-required-parameters': true,
|
|
48661
48572
|
'x-response-key': null,
|
|
48662
48573
|
'x-title': 'Update an ACS User',
|
|
48663
48574
|
},
|
|
@@ -48769,6 +48680,7 @@ const openapi: OpenAPISpec = {
|
|
|
48769
48680
|
tags: ['/acs'],
|
|
48770
48681
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
48771
48682
|
'x-fern-sdk-method-name': 'update',
|
|
48683
|
+
'x-has-required-parameters': true,
|
|
48772
48684
|
'x-response-key': null,
|
|
48773
48685
|
'x-title': 'Update an ACS User',
|
|
48774
48686
|
},
|
|
@@ -49946,6 +49858,7 @@ const openapi: OpenAPISpec = {
|
|
|
49946
49858
|
tags: ['/client_sessions'],
|
|
49947
49859
|
'x-fern-sdk-group-name': ['client_sessions'],
|
|
49948
49860
|
'x-fern-sdk-method-name': 'grant_access',
|
|
49861
|
+
'x-has-required-parameters': true,
|
|
49949
49862
|
'x-response-key': null,
|
|
49950
49863
|
'x-title': 'Grant Access to a Client Session',
|
|
49951
49864
|
},
|
|
@@ -50031,6 +49944,7 @@ const openapi: OpenAPISpec = {
|
|
|
50031
49944
|
tags: ['/client_sessions'],
|
|
50032
49945
|
'x-fern-sdk-group-name': ['client_sessions'],
|
|
50033
49946
|
'x-fern-sdk-method-name': 'grant_access',
|
|
49947
|
+
'x-has-required-parameters': true,
|
|
50034
49948
|
'x-response-key': null,
|
|
50035
49949
|
'x-title': 'Grant Access to a Client Session',
|
|
50036
49950
|
},
|
|
@@ -54575,6 +54489,7 @@ const openapi: OpenAPISpec = {
|
|
|
54575
54489
|
'x-fern-sdk-group-name': ['devices'],
|
|
54576
54490
|
'x-fern-sdk-method-name': 'get',
|
|
54577
54491
|
'x-fern-sdk-return-value': 'device',
|
|
54492
|
+
'x-has-required-parameters': true,
|
|
54578
54493
|
'x-response-key': 'device',
|
|
54579
54494
|
'x-title': 'Get a Device',
|
|
54580
54495
|
},
|
|
@@ -54635,6 +54550,7 @@ const openapi: OpenAPISpec = {
|
|
|
54635
54550
|
'x-fern-sdk-group-name': ['devices'],
|
|
54636
54551
|
'x-fern-sdk-method-name': 'get',
|
|
54637
54552
|
'x-fern-sdk-return-value': 'device',
|
|
54553
|
+
'x-has-required-parameters': true,
|
|
54638
54554
|
'x-response-key': 'device',
|
|
54639
54555
|
'x-title': 'Get a Device',
|
|
54640
54556
|
},
|
|
@@ -57399,6 +57315,7 @@ const openapi: OpenAPISpec = {
|
|
|
57399
57315
|
'x-fern-sdk-group-name': ['devices', 'unmanaged'],
|
|
57400
57316
|
'x-fern-sdk-method-name': 'get',
|
|
57401
57317
|
'x-fern-sdk-return-value': 'device',
|
|
57318
|
+
'x-has-required-parameters': true,
|
|
57402
57319
|
'x-response-key': 'device',
|
|
57403
57320
|
'x-title': 'Get an Unmanaged Device',
|
|
57404
57321
|
},
|
|
@@ -57459,6 +57376,7 @@ const openapi: OpenAPISpec = {
|
|
|
57459
57376
|
'x-fern-sdk-group-name': ['devices', 'unmanaged'],
|
|
57460
57377
|
'x-fern-sdk-method-name': 'get',
|
|
57461
57378
|
'x-fern-sdk-return-value': 'device',
|
|
57379
|
+
'x-has-required-parameters': true,
|
|
57462
57380
|
'x-response-key': 'device',
|
|
57463
57381
|
'x-title': 'Get an Unmanaged Device',
|
|
57464
57382
|
},
|
|
@@ -57746,27 +57664,6 @@ const openapi: OpenAPISpec = {
|
|
|
57746
57664
|
type: 'string',
|
|
57747
57665
|
},
|
|
57748
57666
|
},
|
|
57749
|
-
{
|
|
57750
|
-
in: 'query',
|
|
57751
|
-
name: 'user_identifier_key',
|
|
57752
|
-
schema: {
|
|
57753
|
-
description:
|
|
57754
|
-
'Your own internal user ID for the user for which you want to list devices.',
|
|
57755
|
-
type: 'string',
|
|
57756
|
-
},
|
|
57757
|
-
},
|
|
57758
|
-
{
|
|
57759
|
-
in: 'query',
|
|
57760
|
-
name: 'custom_metadata_has',
|
|
57761
|
-
schema: {
|
|
57762
|
-
additionalProperties: {
|
|
57763
|
-
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
57764
|
-
},
|
|
57765
|
-
description:
|
|
57766
|
-
'Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.',
|
|
57767
|
-
type: 'object',
|
|
57768
|
-
},
|
|
57769
|
-
},
|
|
57770
57667
|
{
|
|
57771
57668
|
in: 'query',
|
|
57772
57669
|
name: 'page_cursor',
|
|
@@ -57843,27 +57740,6 @@ const openapi: OpenAPISpec = {
|
|
|
57843
57740
|
'x-undocumented': 'Only used internally.',
|
|
57844
57741
|
},
|
|
57845
57742
|
},
|
|
57846
|
-
{
|
|
57847
|
-
in: 'query',
|
|
57848
|
-
name: 'unstable_location_id',
|
|
57849
|
-
schema: {
|
|
57850
|
-
deprecated: true,
|
|
57851
|
-
format: 'uuid',
|
|
57852
|
-
nullable: true,
|
|
57853
|
-
type: 'string',
|
|
57854
|
-
'x-deprecated': 'Use `space_id`.',
|
|
57855
|
-
},
|
|
57856
|
-
},
|
|
57857
|
-
{
|
|
57858
|
-
in: 'query',
|
|
57859
|
-
name: 'space_id',
|
|
57860
|
-
schema: {
|
|
57861
|
-
description:
|
|
57862
|
-
'ID of the space for which you want to list devices.',
|
|
57863
|
-
format: 'uuid',
|
|
57864
|
-
type: 'string',
|
|
57865
|
-
},
|
|
57866
|
-
},
|
|
57867
57743
|
{
|
|
57868
57744
|
in: 'query',
|
|
57869
57745
|
name: 'search',
|
|
@@ -57958,14 +57834,6 @@ const openapi: OpenAPISpec = {
|
|
|
57958
57834
|
format: 'date-time',
|
|
57959
57835
|
type: 'string',
|
|
57960
57836
|
},
|
|
57961
|
-
custom_metadata_has: {
|
|
57962
|
-
additionalProperties: {
|
|
57963
|
-
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
57964
|
-
},
|
|
57965
|
-
description:
|
|
57966
|
-
'Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.',
|
|
57967
|
-
type: 'object',
|
|
57968
|
-
},
|
|
57969
57837
|
customer_key: {
|
|
57970
57838
|
description:
|
|
57971
57839
|
'Customer key for which you want to list devices.',
|
|
@@ -58267,24 +58135,6 @@ const openapi: OpenAPISpec = {
|
|
|
58267
58135
|
minLength: 1,
|
|
58268
58136
|
type: 'string',
|
|
58269
58137
|
},
|
|
58270
|
-
space_id: {
|
|
58271
|
-
description:
|
|
58272
|
-
'ID of the space for which you want to list devices.',
|
|
58273
|
-
format: 'uuid',
|
|
58274
|
-
type: 'string',
|
|
58275
|
-
},
|
|
58276
|
-
unstable_location_id: {
|
|
58277
|
-
deprecated: true,
|
|
58278
|
-
format: 'uuid',
|
|
58279
|
-
nullable: true,
|
|
58280
|
-
type: 'string',
|
|
58281
|
-
'x-deprecated': 'Use `space_id`.',
|
|
58282
|
-
},
|
|
58283
|
-
user_identifier_key: {
|
|
58284
|
-
description:
|
|
58285
|
-
'Your own internal user ID for the user for which you want to list devices.',
|
|
58286
|
-
type: 'string',
|
|
58287
|
-
},
|
|
58288
58138
|
},
|
|
58289
58139
|
type: 'object',
|
|
58290
58140
|
},
|
|
@@ -58718,6 +58568,7 @@ const openapi: OpenAPISpec = {
|
|
|
58718
58568
|
'x-fern-sdk-group-name': ['events'],
|
|
58719
58569
|
'x-fern-sdk-method-name': 'get',
|
|
58720
58570
|
'x-fern-sdk-return-value': 'event',
|
|
58571
|
+
'x-has-required-parameters': true,
|
|
58721
58572
|
'x-response-key': 'event',
|
|
58722
58573
|
'x-title': 'Get an Event',
|
|
58723
58574
|
},
|
|
@@ -58786,6 +58637,7 @@ const openapi: OpenAPISpec = {
|
|
|
58786
58637
|
'x-fern-sdk-group-name': ['events'],
|
|
58787
58638
|
'x-fern-sdk-method-name': 'get',
|
|
58788
58639
|
'x-fern-sdk-return-value': 'event',
|
|
58640
|
+
'x-has-required-parameters': true,
|
|
58789
58641
|
'x-response-key': 'event',
|
|
58790
58642
|
'x-title': 'Get an Event',
|
|
58791
58643
|
},
|
|
@@ -59338,6 +59190,7 @@ const openapi: OpenAPISpec = {
|
|
|
59338
59190
|
'x-fern-sdk-group-name': ['events'],
|
|
59339
59191
|
'x-fern-sdk-method-name': 'list',
|
|
59340
59192
|
'x-fern-sdk-return-value': 'events',
|
|
59193
|
+
'x-has-required-parameters': true,
|
|
59341
59194
|
'x-response-key': 'events',
|
|
59342
59195
|
'x-title': 'List Events',
|
|
59343
59196
|
},
|
|
@@ -59788,6 +59641,7 @@ const openapi: OpenAPISpec = {
|
|
|
59788
59641
|
'x-fern-sdk-group-name': ['events'],
|
|
59789
59642
|
'x-fern-sdk-method-name': 'list',
|
|
59790
59643
|
'x-fern-sdk-return-value': 'events',
|
|
59644
|
+
'x-has-required-parameters': true,
|
|
59791
59645
|
'x-response-key': 'events',
|
|
59792
59646
|
'x-title': 'List Events',
|
|
59793
59647
|
},
|
|
@@ -59943,6 +59797,7 @@ const openapi: OpenAPISpec = {
|
|
|
59943
59797
|
'x-fern-sdk-group-name': ['instant_keys'],
|
|
59944
59798
|
'x-fern-sdk-method-name': 'get',
|
|
59945
59799
|
'x-fern-sdk-return-value': 'instant_key',
|
|
59800
|
+
'x-has-required-parameters': true,
|
|
59946
59801
|
'x-response-key': 'instant_key',
|
|
59947
59802
|
'x-title': 'Get an Instant Key',
|
|
59948
59803
|
},
|
|
@@ -60001,6 +59856,7 @@ const openapi: OpenAPISpec = {
|
|
|
60001
59856
|
'x-fern-sdk-group-name': ['instant_keys'],
|
|
60002
59857
|
'x-fern-sdk-method-name': 'get',
|
|
60003
59858
|
'x-fern-sdk-return-value': 'instant_key',
|
|
59859
|
+
'x-has-required-parameters': true,
|
|
60004
59860
|
'x-response-key': 'instant_key',
|
|
60005
59861
|
'x-title': 'Get an Instant Key',
|
|
60006
59862
|
},
|
|
@@ -60245,6 +60101,7 @@ const openapi: OpenAPISpec = {
|
|
|
60245
60101
|
'x-fern-sdk-group-name': ['locks'],
|
|
60246
60102
|
'x-fern-sdk-method-name': 'get',
|
|
60247
60103
|
'x-fern-sdk-return-value': 'device',
|
|
60104
|
+
'x-has-required-parameters': true,
|
|
60248
60105
|
'x-response-key': 'device',
|
|
60249
60106
|
'x-title': 'Get a Lock',
|
|
60250
60107
|
},
|
|
@@ -60305,6 +60162,7 @@ const openapi: OpenAPISpec = {
|
|
|
60305
60162
|
'x-fern-sdk-group-name': ['locks'],
|
|
60306
60163
|
'x-fern-sdk-method-name': 'get',
|
|
60307
60164
|
'x-fern-sdk-return-value': 'device',
|
|
60165
|
+
'x-has-required-parameters': true,
|
|
60308
60166
|
'x-response-key': 'device',
|
|
60309
60167
|
'x-title': 'Get a Lock',
|
|
60310
60168
|
},
|
|
@@ -60333,16 +60191,6 @@ const openapi: OpenAPISpec = {
|
|
|
60333
60191
|
type: 'string',
|
|
60334
60192
|
},
|
|
60335
60193
|
},
|
|
60336
|
-
{
|
|
60337
|
-
in: 'query',
|
|
60338
|
-
name: 'connected_account_ids',
|
|
60339
|
-
schema: {
|
|
60340
|
-
description:
|
|
60341
|
-
'Array of IDs of the connected accounts for which you want to list devices.',
|
|
60342
|
-
items: { format: 'uuid', type: 'string' },
|
|
60343
|
-
type: 'array',
|
|
60344
|
-
},
|
|
60345
|
-
},
|
|
60346
60194
|
{
|
|
60347
60195
|
in: 'query',
|
|
60348
60196
|
name: 'connect_webview_id',
|
|
@@ -60479,165 +60327,6 @@ const openapi: OpenAPISpec = {
|
|
|
60479
60327
|
type: 'string',
|
|
60480
60328
|
},
|
|
60481
60329
|
},
|
|
60482
|
-
{
|
|
60483
|
-
in: 'query',
|
|
60484
|
-
name: 'device_ids',
|
|
60485
|
-
schema: {
|
|
60486
|
-
description:
|
|
60487
|
-
'Array of device IDs for which you want to list devices.',
|
|
60488
|
-
items: { format: 'uuid', type: 'string' },
|
|
60489
|
-
type: 'array',
|
|
60490
|
-
},
|
|
60491
|
-
},
|
|
60492
|
-
{
|
|
60493
|
-
in: 'query',
|
|
60494
|
-
name: 'limit',
|
|
60495
|
-
schema: {
|
|
60496
|
-
default: 500,
|
|
60497
|
-
description:
|
|
60498
|
-
'Numerical limit on the number of devices to return.',
|
|
60499
|
-
format: 'float',
|
|
60500
|
-
type: 'number',
|
|
60501
|
-
},
|
|
60502
|
-
},
|
|
60503
|
-
{
|
|
60504
|
-
in: 'query',
|
|
60505
|
-
name: 'created_before',
|
|
60506
|
-
schema: {
|
|
60507
|
-
description:
|
|
60508
|
-
'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
60509
|
-
format: 'date-time',
|
|
60510
|
-
type: 'string',
|
|
60511
|
-
},
|
|
60512
|
-
},
|
|
60513
|
-
{
|
|
60514
|
-
in: 'query',
|
|
60515
|
-
name: 'user_identifier_key',
|
|
60516
|
-
schema: {
|
|
60517
|
-
description:
|
|
60518
|
-
'Your own internal user ID for the user for which you want to list devices.',
|
|
60519
|
-
type: 'string',
|
|
60520
|
-
},
|
|
60521
|
-
},
|
|
60522
|
-
{
|
|
60523
|
-
in: 'query',
|
|
60524
|
-
name: 'custom_metadata_has',
|
|
60525
|
-
schema: {
|
|
60526
|
-
additionalProperties: {
|
|
60527
|
-
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
60528
|
-
},
|
|
60529
|
-
description:
|
|
60530
|
-
'Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.',
|
|
60531
|
-
type: 'object',
|
|
60532
|
-
},
|
|
60533
|
-
},
|
|
60534
|
-
{
|
|
60535
|
-
in: 'query',
|
|
60536
|
-
name: 'page_cursor',
|
|
60537
|
-
schema: {
|
|
60538
|
-
description:
|
|
60539
|
-
"Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
60540
|
-
nullable: true,
|
|
60541
|
-
type: 'string',
|
|
60542
|
-
},
|
|
60543
|
-
},
|
|
60544
|
-
{
|
|
60545
|
-
in: 'query',
|
|
60546
|
-
name: 'include_if',
|
|
60547
|
-
schema: {
|
|
60548
|
-
items: {
|
|
60549
|
-
enum: [
|
|
60550
|
-
'can_remotely_unlock',
|
|
60551
|
-
'can_remotely_lock',
|
|
60552
|
-
'can_program_offline_access_codes',
|
|
60553
|
-
'can_program_online_access_codes',
|
|
60554
|
-
'can_hvac_heat',
|
|
60555
|
-
'can_hvac_cool',
|
|
60556
|
-
'can_hvac_heat_cool',
|
|
60557
|
-
'can_turn_off_hvac',
|
|
60558
|
-
'can_simulate_removal',
|
|
60559
|
-
'can_simulate_connection',
|
|
60560
|
-
'can_simulate_disconnection',
|
|
60561
|
-
'can_unlock_with_code',
|
|
60562
|
-
'can_run_thermostat_programs',
|
|
60563
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
60564
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
60565
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
60566
|
-
'can_simulate_hub_connection',
|
|
60567
|
-
'can_simulate_hub_disconnection',
|
|
60568
|
-
'can_simulate_paid_subscription',
|
|
60569
|
-
'can_configure_auto_lock',
|
|
60570
|
-
],
|
|
60571
|
-
type: 'string',
|
|
60572
|
-
},
|
|
60573
|
-
type: 'array',
|
|
60574
|
-
'x-undocumented': 'Only used internally.',
|
|
60575
|
-
},
|
|
60576
|
-
},
|
|
60577
|
-
{
|
|
60578
|
-
in: 'query',
|
|
60579
|
-
name: 'exclude_if',
|
|
60580
|
-
schema: {
|
|
60581
|
-
items: {
|
|
60582
|
-
enum: [
|
|
60583
|
-
'can_remotely_unlock',
|
|
60584
|
-
'can_remotely_lock',
|
|
60585
|
-
'can_program_offline_access_codes',
|
|
60586
|
-
'can_program_online_access_codes',
|
|
60587
|
-
'can_hvac_heat',
|
|
60588
|
-
'can_hvac_cool',
|
|
60589
|
-
'can_hvac_heat_cool',
|
|
60590
|
-
'can_turn_off_hvac',
|
|
60591
|
-
'can_simulate_removal',
|
|
60592
|
-
'can_simulate_connection',
|
|
60593
|
-
'can_simulate_disconnection',
|
|
60594
|
-
'can_unlock_with_code',
|
|
60595
|
-
'can_run_thermostat_programs',
|
|
60596
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
60597
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
60598
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
60599
|
-
'can_simulate_hub_connection',
|
|
60600
|
-
'can_simulate_hub_disconnection',
|
|
60601
|
-
'can_simulate_paid_subscription',
|
|
60602
|
-
'can_configure_auto_lock',
|
|
60603
|
-
],
|
|
60604
|
-
type: 'string',
|
|
60605
|
-
},
|
|
60606
|
-
type: 'array',
|
|
60607
|
-
'x-undocumented': 'Only used internally.',
|
|
60608
|
-
},
|
|
60609
|
-
},
|
|
60610
|
-
{
|
|
60611
|
-
in: 'query',
|
|
60612
|
-
name: 'unstable_location_id',
|
|
60613
|
-
schema: {
|
|
60614
|
-
deprecated: true,
|
|
60615
|
-
format: 'uuid',
|
|
60616
|
-
nullable: true,
|
|
60617
|
-
type: 'string',
|
|
60618
|
-
'x-deprecated': 'Use `space_id`.',
|
|
60619
|
-
},
|
|
60620
|
-
},
|
|
60621
|
-
{
|
|
60622
|
-
in: 'query',
|
|
60623
|
-
name: 'space_id',
|
|
60624
|
-
schema: {
|
|
60625
|
-
description:
|
|
60626
|
-
'ID of the space for which you want to list devices.',
|
|
60627
|
-
format: 'uuid',
|
|
60628
|
-
type: 'string',
|
|
60629
|
-
},
|
|
60630
|
-
},
|
|
60631
|
-
{
|
|
60632
|
-
in: 'query',
|
|
60633
|
-
name: 'search',
|
|
60634
|
-
schema: {
|
|
60635
|
-
description:
|
|
60636
|
-
'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.',
|
|
60637
|
-
minLength: 1,
|
|
60638
|
-
type: 'string',
|
|
60639
|
-
},
|
|
60640
|
-
},
|
|
60641
60330
|
],
|
|
60642
60331
|
responses: {
|
|
60643
60332
|
200: {
|
|
@@ -60701,37 +60390,11 @@ const openapi: OpenAPISpec = {
|
|
|
60701
60390
|
format: 'uuid',
|
|
60702
60391
|
type: 'string',
|
|
60703
60392
|
},
|
|
60704
|
-
connected_account_ids: {
|
|
60705
|
-
description:
|
|
60706
|
-
'Array of IDs of the connected accounts for which you want to list devices.',
|
|
60707
|
-
items: { format: 'uuid', type: 'string' },
|
|
60708
|
-
type: 'array',
|
|
60709
|
-
},
|
|
60710
|
-
created_before: {
|
|
60711
|
-
description:
|
|
60712
|
-
'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
60713
|
-
format: 'date-time',
|
|
60714
|
-
type: 'string',
|
|
60715
|
-
},
|
|
60716
|
-
custom_metadata_has: {
|
|
60717
|
-
additionalProperties: {
|
|
60718
|
-
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
60719
|
-
},
|
|
60720
|
-
description:
|
|
60721
|
-
'Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.',
|
|
60722
|
-
type: 'object',
|
|
60723
|
-
},
|
|
60724
60393
|
customer_key: {
|
|
60725
60394
|
description:
|
|
60726
60395
|
'Customer key for which you want to list devices.',
|
|
60727
60396
|
type: 'string',
|
|
60728
60397
|
},
|
|
60729
|
-
device_ids: {
|
|
60730
|
-
description:
|
|
60731
|
-
'Array of device IDs for which you want to list devices.',
|
|
60732
|
-
items: { format: 'uuid', type: 'string' },
|
|
60733
|
-
type: 'array',
|
|
60734
|
-
},
|
|
60735
60398
|
device_type: {
|
|
60736
60399
|
description:
|
|
60737
60400
|
'Device type of the locks that you want to list.',
|
|
@@ -60810,71 +60473,6 @@ const openapi: OpenAPISpec = {
|
|
|
60810
60473
|
},
|
|
60811
60474
|
type: 'array',
|
|
60812
60475
|
},
|
|
60813
|
-
exclude_if: {
|
|
60814
|
-
items: {
|
|
60815
|
-
enum: [
|
|
60816
|
-
'can_remotely_unlock',
|
|
60817
|
-
'can_remotely_lock',
|
|
60818
|
-
'can_program_offline_access_codes',
|
|
60819
|
-
'can_program_online_access_codes',
|
|
60820
|
-
'can_hvac_heat',
|
|
60821
|
-
'can_hvac_cool',
|
|
60822
|
-
'can_hvac_heat_cool',
|
|
60823
|
-
'can_turn_off_hvac',
|
|
60824
|
-
'can_simulate_removal',
|
|
60825
|
-
'can_simulate_connection',
|
|
60826
|
-
'can_simulate_disconnection',
|
|
60827
|
-
'can_unlock_with_code',
|
|
60828
|
-
'can_run_thermostat_programs',
|
|
60829
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
60830
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
60831
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
60832
|
-
'can_simulate_hub_connection',
|
|
60833
|
-
'can_simulate_hub_disconnection',
|
|
60834
|
-
'can_simulate_paid_subscription',
|
|
60835
|
-
'can_configure_auto_lock',
|
|
60836
|
-
],
|
|
60837
|
-
type: 'string',
|
|
60838
|
-
},
|
|
60839
|
-
type: 'array',
|
|
60840
|
-
'x-undocumented': 'Only used internally.',
|
|
60841
|
-
},
|
|
60842
|
-
include_if: {
|
|
60843
|
-
items: {
|
|
60844
|
-
enum: [
|
|
60845
|
-
'can_remotely_unlock',
|
|
60846
|
-
'can_remotely_lock',
|
|
60847
|
-
'can_program_offline_access_codes',
|
|
60848
|
-
'can_program_online_access_codes',
|
|
60849
|
-
'can_hvac_heat',
|
|
60850
|
-
'can_hvac_cool',
|
|
60851
|
-
'can_hvac_heat_cool',
|
|
60852
|
-
'can_turn_off_hvac',
|
|
60853
|
-
'can_simulate_removal',
|
|
60854
|
-
'can_simulate_connection',
|
|
60855
|
-
'can_simulate_disconnection',
|
|
60856
|
-
'can_unlock_with_code',
|
|
60857
|
-
'can_run_thermostat_programs',
|
|
60858
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
60859
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
60860
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
60861
|
-
'can_simulate_hub_connection',
|
|
60862
|
-
'can_simulate_hub_disconnection',
|
|
60863
|
-
'can_simulate_paid_subscription',
|
|
60864
|
-
'can_configure_auto_lock',
|
|
60865
|
-
],
|
|
60866
|
-
type: 'string',
|
|
60867
|
-
},
|
|
60868
|
-
type: 'array',
|
|
60869
|
-
'x-undocumented': 'Only used internally.',
|
|
60870
|
-
},
|
|
60871
|
-
limit: {
|
|
60872
|
-
default: 500,
|
|
60873
|
-
description:
|
|
60874
|
-
'Numerical limit on the number of devices to return.',
|
|
60875
|
-
format: 'float',
|
|
60876
|
-
type: 'number',
|
|
60877
|
-
},
|
|
60878
60476
|
manufacturer: {
|
|
60879
60477
|
description:
|
|
60880
60478
|
'Manufacturer of the locks that you want to list.',
|
|
@@ -60914,36 +60512,6 @@ const openapi: OpenAPISpec = {
|
|
|
60914
60512
|
],
|
|
60915
60513
|
type: 'string',
|
|
60916
60514
|
},
|
|
60917
|
-
page_cursor: {
|
|
60918
|
-
description:
|
|
60919
|
-
"Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
60920
|
-
nullable: true,
|
|
60921
|
-
type: 'string',
|
|
60922
|
-
},
|
|
60923
|
-
search: {
|
|
60924
|
-
description:
|
|
60925
|
-
'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.',
|
|
60926
|
-
minLength: 1,
|
|
60927
|
-
type: 'string',
|
|
60928
|
-
},
|
|
60929
|
-
space_id: {
|
|
60930
|
-
description:
|
|
60931
|
-
'ID of the space for which you want to list devices.',
|
|
60932
|
-
format: 'uuid',
|
|
60933
|
-
type: 'string',
|
|
60934
|
-
},
|
|
60935
|
-
unstable_location_id: {
|
|
60936
|
-
deprecated: true,
|
|
60937
|
-
format: 'uuid',
|
|
60938
|
-
nullable: true,
|
|
60939
|
-
type: 'string',
|
|
60940
|
-
'x-deprecated': 'Use `space_id`.',
|
|
60941
|
-
},
|
|
60942
|
-
user_identifier_key: {
|
|
60943
|
-
description:
|
|
60944
|
-
'Your own internal user ID for the user for which you want to list devices.',
|
|
60945
|
-
type: 'string',
|
|
60946
|
-
},
|
|
60947
60515
|
},
|
|
60948
60516
|
type: 'object',
|
|
60949
60517
|
},
|
|
@@ -61269,16 +60837,6 @@ const openapi: OpenAPISpec = {
|
|
|
61269
60837
|
type: 'string',
|
|
61270
60838
|
},
|
|
61271
60839
|
},
|
|
61272
|
-
{
|
|
61273
|
-
in: 'query',
|
|
61274
|
-
name: 'connected_account_ids',
|
|
61275
|
-
schema: {
|
|
61276
|
-
description:
|
|
61277
|
-
'Array of IDs of the connected accounts for which you want to list devices.',
|
|
61278
|
-
items: { format: 'uuid', type: 'string' },
|
|
61279
|
-
type: 'array',
|
|
61280
|
-
},
|
|
61281
|
-
},
|
|
61282
60840
|
{
|
|
61283
60841
|
in: 'query',
|
|
61284
60842
|
name: 'connect_webview_id',
|
|
@@ -61323,165 +60881,6 @@ const openapi: OpenAPISpec = {
|
|
|
61323
60881
|
type: 'string',
|
|
61324
60882
|
},
|
|
61325
60883
|
},
|
|
61326
|
-
{
|
|
61327
|
-
in: 'query',
|
|
61328
|
-
name: 'device_ids',
|
|
61329
|
-
schema: {
|
|
61330
|
-
description:
|
|
61331
|
-
'Array of device IDs for which you want to list devices.',
|
|
61332
|
-
items: { format: 'uuid', type: 'string' },
|
|
61333
|
-
type: 'array',
|
|
61334
|
-
},
|
|
61335
|
-
},
|
|
61336
|
-
{
|
|
61337
|
-
in: 'query',
|
|
61338
|
-
name: 'limit',
|
|
61339
|
-
schema: {
|
|
61340
|
-
default: 500,
|
|
61341
|
-
description:
|
|
61342
|
-
'Numerical limit on the number of devices to return.',
|
|
61343
|
-
format: 'float',
|
|
61344
|
-
type: 'number',
|
|
61345
|
-
},
|
|
61346
|
-
},
|
|
61347
|
-
{
|
|
61348
|
-
in: 'query',
|
|
61349
|
-
name: 'created_before',
|
|
61350
|
-
schema: {
|
|
61351
|
-
description:
|
|
61352
|
-
'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
61353
|
-
format: 'date-time',
|
|
61354
|
-
type: 'string',
|
|
61355
|
-
},
|
|
61356
|
-
},
|
|
61357
|
-
{
|
|
61358
|
-
in: 'query',
|
|
61359
|
-
name: 'user_identifier_key',
|
|
61360
|
-
schema: {
|
|
61361
|
-
description:
|
|
61362
|
-
'Your own internal user ID for the user for which you want to list devices.',
|
|
61363
|
-
type: 'string',
|
|
61364
|
-
},
|
|
61365
|
-
},
|
|
61366
|
-
{
|
|
61367
|
-
in: 'query',
|
|
61368
|
-
name: 'custom_metadata_has',
|
|
61369
|
-
schema: {
|
|
61370
|
-
additionalProperties: {
|
|
61371
|
-
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
61372
|
-
},
|
|
61373
|
-
description:
|
|
61374
|
-
'Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.',
|
|
61375
|
-
type: 'object',
|
|
61376
|
-
},
|
|
61377
|
-
},
|
|
61378
|
-
{
|
|
61379
|
-
in: 'query',
|
|
61380
|
-
name: 'page_cursor',
|
|
61381
|
-
schema: {
|
|
61382
|
-
description:
|
|
61383
|
-
"Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
61384
|
-
nullable: true,
|
|
61385
|
-
type: 'string',
|
|
61386
|
-
},
|
|
61387
|
-
},
|
|
61388
|
-
{
|
|
61389
|
-
in: 'query',
|
|
61390
|
-
name: 'include_if',
|
|
61391
|
-
schema: {
|
|
61392
|
-
items: {
|
|
61393
|
-
enum: [
|
|
61394
|
-
'can_remotely_unlock',
|
|
61395
|
-
'can_remotely_lock',
|
|
61396
|
-
'can_program_offline_access_codes',
|
|
61397
|
-
'can_program_online_access_codes',
|
|
61398
|
-
'can_hvac_heat',
|
|
61399
|
-
'can_hvac_cool',
|
|
61400
|
-
'can_hvac_heat_cool',
|
|
61401
|
-
'can_turn_off_hvac',
|
|
61402
|
-
'can_simulate_removal',
|
|
61403
|
-
'can_simulate_connection',
|
|
61404
|
-
'can_simulate_disconnection',
|
|
61405
|
-
'can_unlock_with_code',
|
|
61406
|
-
'can_run_thermostat_programs',
|
|
61407
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
61408
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
61409
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
61410
|
-
'can_simulate_hub_connection',
|
|
61411
|
-
'can_simulate_hub_disconnection',
|
|
61412
|
-
'can_simulate_paid_subscription',
|
|
61413
|
-
'can_configure_auto_lock',
|
|
61414
|
-
],
|
|
61415
|
-
type: 'string',
|
|
61416
|
-
},
|
|
61417
|
-
type: 'array',
|
|
61418
|
-
'x-undocumented': 'Only used internally.',
|
|
61419
|
-
},
|
|
61420
|
-
},
|
|
61421
|
-
{
|
|
61422
|
-
in: 'query',
|
|
61423
|
-
name: 'exclude_if',
|
|
61424
|
-
schema: {
|
|
61425
|
-
items: {
|
|
61426
|
-
enum: [
|
|
61427
|
-
'can_remotely_unlock',
|
|
61428
|
-
'can_remotely_lock',
|
|
61429
|
-
'can_program_offline_access_codes',
|
|
61430
|
-
'can_program_online_access_codes',
|
|
61431
|
-
'can_hvac_heat',
|
|
61432
|
-
'can_hvac_cool',
|
|
61433
|
-
'can_hvac_heat_cool',
|
|
61434
|
-
'can_turn_off_hvac',
|
|
61435
|
-
'can_simulate_removal',
|
|
61436
|
-
'can_simulate_connection',
|
|
61437
|
-
'can_simulate_disconnection',
|
|
61438
|
-
'can_unlock_with_code',
|
|
61439
|
-
'can_run_thermostat_programs',
|
|
61440
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
61441
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
61442
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
61443
|
-
'can_simulate_hub_connection',
|
|
61444
|
-
'can_simulate_hub_disconnection',
|
|
61445
|
-
'can_simulate_paid_subscription',
|
|
61446
|
-
'can_configure_auto_lock',
|
|
61447
|
-
],
|
|
61448
|
-
type: 'string',
|
|
61449
|
-
},
|
|
61450
|
-
type: 'array',
|
|
61451
|
-
'x-undocumented': 'Only used internally.',
|
|
61452
|
-
},
|
|
61453
|
-
},
|
|
61454
|
-
{
|
|
61455
|
-
in: 'query',
|
|
61456
|
-
name: 'unstable_location_id',
|
|
61457
|
-
schema: {
|
|
61458
|
-
deprecated: true,
|
|
61459
|
-
format: 'uuid',
|
|
61460
|
-
nullable: true,
|
|
61461
|
-
type: 'string',
|
|
61462
|
-
'x-deprecated': 'Use `space_id`.',
|
|
61463
|
-
},
|
|
61464
|
-
},
|
|
61465
|
-
{
|
|
61466
|
-
in: 'query',
|
|
61467
|
-
name: 'space_id',
|
|
61468
|
-
schema: {
|
|
61469
|
-
description:
|
|
61470
|
-
'ID of the space for which you want to list devices.',
|
|
61471
|
-
format: 'uuid',
|
|
61472
|
-
type: 'string',
|
|
61473
|
-
},
|
|
61474
|
-
},
|
|
61475
|
-
{
|
|
61476
|
-
in: 'query',
|
|
61477
|
-
name: 'search',
|
|
61478
|
-
schema: {
|
|
61479
|
-
description:
|
|
61480
|
-
'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.',
|
|
61481
|
-
minLength: 1,
|
|
61482
|
-
type: 'string',
|
|
61483
|
-
},
|
|
61484
|
-
},
|
|
61485
60884
|
],
|
|
61486
60885
|
responses: {
|
|
61487
60886
|
200: {
|
|
@@ -61545,37 +60944,11 @@ const openapi: OpenAPISpec = {
|
|
|
61545
60944
|
format: 'uuid',
|
|
61546
60945
|
type: 'string',
|
|
61547
60946
|
},
|
|
61548
|
-
connected_account_ids: {
|
|
61549
|
-
description:
|
|
61550
|
-
'Array of IDs of the connected accounts for which you want to list devices.',
|
|
61551
|
-
items: { format: 'uuid', type: 'string' },
|
|
61552
|
-
type: 'array',
|
|
61553
|
-
},
|
|
61554
|
-
created_before: {
|
|
61555
|
-
description:
|
|
61556
|
-
'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
61557
|
-
format: 'date-time',
|
|
61558
|
-
type: 'string',
|
|
61559
|
-
},
|
|
61560
|
-
custom_metadata_has: {
|
|
61561
|
-
additionalProperties: {
|
|
61562
|
-
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
61563
|
-
},
|
|
61564
|
-
description:
|
|
61565
|
-
'Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.',
|
|
61566
|
-
type: 'object',
|
|
61567
|
-
},
|
|
61568
60947
|
customer_key: {
|
|
61569
60948
|
description:
|
|
61570
60949
|
'Customer key for which you want to list devices.',
|
|
61571
60950
|
type: 'string',
|
|
61572
60951
|
},
|
|
61573
|
-
device_ids: {
|
|
61574
|
-
description:
|
|
61575
|
-
'Array of device IDs for which you want to list devices.',
|
|
61576
|
-
items: { format: 'uuid', type: 'string' },
|
|
61577
|
-
type: 'array',
|
|
61578
|
-
},
|
|
61579
60952
|
device_type: {
|
|
61580
60953
|
description:
|
|
61581
60954
|
'Device type of the noise sensors that you want to list.',
|
|
@@ -61592,107 +60965,12 @@ const openapi: OpenAPISpec = {
|
|
|
61592
60965
|
},
|
|
61593
60966
|
type: 'array',
|
|
61594
60967
|
},
|
|
61595
|
-
exclude_if: {
|
|
61596
|
-
items: {
|
|
61597
|
-
enum: [
|
|
61598
|
-
'can_remotely_unlock',
|
|
61599
|
-
'can_remotely_lock',
|
|
61600
|
-
'can_program_offline_access_codes',
|
|
61601
|
-
'can_program_online_access_codes',
|
|
61602
|
-
'can_hvac_heat',
|
|
61603
|
-
'can_hvac_cool',
|
|
61604
|
-
'can_hvac_heat_cool',
|
|
61605
|
-
'can_turn_off_hvac',
|
|
61606
|
-
'can_simulate_removal',
|
|
61607
|
-
'can_simulate_connection',
|
|
61608
|
-
'can_simulate_disconnection',
|
|
61609
|
-
'can_unlock_with_code',
|
|
61610
|
-
'can_run_thermostat_programs',
|
|
61611
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
61612
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
61613
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
61614
|
-
'can_simulate_hub_connection',
|
|
61615
|
-
'can_simulate_hub_disconnection',
|
|
61616
|
-
'can_simulate_paid_subscription',
|
|
61617
|
-
'can_configure_auto_lock',
|
|
61618
|
-
],
|
|
61619
|
-
type: 'string',
|
|
61620
|
-
},
|
|
61621
|
-
type: 'array',
|
|
61622
|
-
'x-undocumented': 'Only used internally.',
|
|
61623
|
-
},
|
|
61624
|
-
include_if: {
|
|
61625
|
-
items: {
|
|
61626
|
-
enum: [
|
|
61627
|
-
'can_remotely_unlock',
|
|
61628
|
-
'can_remotely_lock',
|
|
61629
|
-
'can_program_offline_access_codes',
|
|
61630
|
-
'can_program_online_access_codes',
|
|
61631
|
-
'can_hvac_heat',
|
|
61632
|
-
'can_hvac_cool',
|
|
61633
|
-
'can_hvac_heat_cool',
|
|
61634
|
-
'can_turn_off_hvac',
|
|
61635
|
-
'can_simulate_removal',
|
|
61636
|
-
'can_simulate_connection',
|
|
61637
|
-
'can_simulate_disconnection',
|
|
61638
|
-
'can_unlock_with_code',
|
|
61639
|
-
'can_run_thermostat_programs',
|
|
61640
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
61641
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
61642
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
61643
|
-
'can_simulate_hub_connection',
|
|
61644
|
-
'can_simulate_hub_disconnection',
|
|
61645
|
-
'can_simulate_paid_subscription',
|
|
61646
|
-
'can_configure_auto_lock',
|
|
61647
|
-
],
|
|
61648
|
-
type: 'string',
|
|
61649
|
-
},
|
|
61650
|
-
type: 'array',
|
|
61651
|
-
'x-undocumented': 'Only used internally.',
|
|
61652
|
-
},
|
|
61653
|
-
limit: {
|
|
61654
|
-
default: 500,
|
|
61655
|
-
description:
|
|
61656
|
-
'Numerical limit on the number of devices to return.',
|
|
61657
|
-
format: 'float',
|
|
61658
|
-
type: 'number',
|
|
61659
|
-
},
|
|
61660
60968
|
manufacturer: {
|
|
61661
60969
|
description:
|
|
61662
60970
|
'Manufacturers of the noise sensors that you want to list.',
|
|
61663
60971
|
enum: ['minut', 'noiseaware'],
|
|
61664
60972
|
type: 'string',
|
|
61665
60973
|
},
|
|
61666
|
-
page_cursor: {
|
|
61667
|
-
description:
|
|
61668
|
-
"Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
61669
|
-
nullable: true,
|
|
61670
|
-
type: 'string',
|
|
61671
|
-
},
|
|
61672
|
-
search: {
|
|
61673
|
-
description:
|
|
61674
|
-
'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.',
|
|
61675
|
-
minLength: 1,
|
|
61676
|
-
type: 'string',
|
|
61677
|
-
},
|
|
61678
|
-
space_id: {
|
|
61679
|
-
description:
|
|
61680
|
-
'ID of the space for which you want to list devices.',
|
|
61681
|
-
format: 'uuid',
|
|
61682
|
-
type: 'string',
|
|
61683
|
-
},
|
|
61684
|
-
unstable_location_id: {
|
|
61685
|
-
deprecated: true,
|
|
61686
|
-
format: 'uuid',
|
|
61687
|
-
nullable: true,
|
|
61688
|
-
type: 'string',
|
|
61689
|
-
'x-deprecated': 'Use `space_id`.',
|
|
61690
|
-
},
|
|
61691
|
-
user_identifier_key: {
|
|
61692
|
-
description:
|
|
61693
|
-
'Your own internal user ID for the user for which you want to list devices.',
|
|
61694
|
-
type: 'string',
|
|
61695
|
-
},
|
|
61696
60974
|
},
|
|
61697
60975
|
type: 'object',
|
|
61698
60976
|
},
|
|
@@ -75166,6 +74444,7 @@ const openapi: OpenAPISpec = {
|
|
|
75166
74444
|
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'reservations'],
|
|
75167
74445
|
'x-fern-sdk-method-name': 'get',
|
|
75168
74446
|
'x-fern-sdk-return-value': 'reservation',
|
|
74447
|
+
'x-has-required-parameters': true,
|
|
75169
74448
|
'x-response-key': 'reservation',
|
|
75170
74449
|
'x-title': 'Get Reservation for Customer',
|
|
75171
74450
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
@@ -75386,6 +74665,7 @@ const openapi: OpenAPISpec = {
|
|
|
75386
74665
|
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'reservations'],
|
|
75387
74666
|
'x-fern-sdk-method-name': 'get',
|
|
75388
74667
|
'x-fern-sdk-return-value': 'reservation',
|
|
74668
|
+
'x-has-required-parameters': true,
|
|
75389
74669
|
'x-response-key': 'reservation',
|
|
75390
74670
|
'x-title': 'Get Reservation for Customer',
|
|
75391
74671
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
@@ -79761,6 +79041,7 @@ const openapi: OpenAPISpec = {
|
|
|
79761
79041
|
'x-fern-sdk-group-name': ['spaces'],
|
|
79762
79042
|
'x-fern-sdk-method-name': 'get_related',
|
|
79763
79043
|
'x-fern-sdk-return-value': 'batch',
|
|
79044
|
+
'x-has-required-parameters': true,
|
|
79764
79045
|
'x-response-key': 'batch',
|
|
79765
79046
|
'x-title': 'Get related Space resources',
|
|
79766
79047
|
},
|
|
@@ -79890,6 +79171,7 @@ const openapi: OpenAPISpec = {
|
|
|
79890
79171
|
'x-fern-sdk-group-name': ['spaces'],
|
|
79891
79172
|
'x-fern-sdk-method-name': 'get_related',
|
|
79892
79173
|
'x-fern-sdk-return-value': 'batch',
|
|
79174
|
+
'x-has-required-parameters': true,
|
|
79893
79175
|
'x-response-key': 'batch',
|
|
79894
79176
|
'x-title': 'Get related Space resources',
|
|
79895
79177
|
},
|
|
@@ -81516,6 +80798,7 @@ const openapi: OpenAPISpec = {
|
|
|
81516
80798
|
'x-fern-sdk-group-name': ['thermostats'],
|
|
81517
80799
|
'x-fern-sdk-method-name': 'get',
|
|
81518
80800
|
'x-fern-sdk-return-value': 'thermostat',
|
|
80801
|
+
'x-has-required-parameters': true,
|
|
81519
80802
|
'x-response-key': 'thermostat',
|
|
81520
80803
|
'x-title': 'Get a Thermostat',
|
|
81521
80804
|
'x-undocumented': 'Will be removed.',
|
|
@@ -81577,6 +80860,7 @@ const openapi: OpenAPISpec = {
|
|
|
81577
80860
|
'x-fern-sdk-group-name': ['thermostats'],
|
|
81578
80861
|
'x-fern-sdk-method-name': 'get',
|
|
81579
80862
|
'x-fern-sdk-return-value': 'thermostat',
|
|
80863
|
+
'x-has-required-parameters': true,
|
|
81580
80864
|
'x-response-key': 'thermostat',
|
|
81581
80865
|
'x-title': 'Get a Thermostat',
|
|
81582
80866
|
'x-undocumented': 'Will be removed.',
|
|
@@ -81772,16 +81056,6 @@ const openapi: OpenAPISpec = {
|
|
|
81772
81056
|
type: 'string',
|
|
81773
81057
|
},
|
|
81774
81058
|
},
|
|
81775
|
-
{
|
|
81776
|
-
in: 'query',
|
|
81777
|
-
name: 'connected_account_ids',
|
|
81778
|
-
schema: {
|
|
81779
|
-
description:
|
|
81780
|
-
'Array of IDs of the connected accounts for which you want to list devices.',
|
|
81781
|
-
items: { format: 'uuid', type: 'string' },
|
|
81782
|
-
type: 'array',
|
|
81783
|
-
},
|
|
81784
|
-
},
|
|
81785
81059
|
{
|
|
81786
81060
|
in: 'query',
|
|
81787
81061
|
name: 'connect_webview_id',
|
|
@@ -81847,165 +81121,6 @@ const openapi: OpenAPISpec = {
|
|
|
81847
81121
|
type: 'string',
|
|
81848
81122
|
},
|
|
81849
81123
|
},
|
|
81850
|
-
{
|
|
81851
|
-
in: 'query',
|
|
81852
|
-
name: 'device_ids',
|
|
81853
|
-
schema: {
|
|
81854
|
-
description:
|
|
81855
|
-
'Array of device IDs for which you want to list devices.',
|
|
81856
|
-
items: { format: 'uuid', type: 'string' },
|
|
81857
|
-
type: 'array',
|
|
81858
|
-
},
|
|
81859
|
-
},
|
|
81860
|
-
{
|
|
81861
|
-
in: 'query',
|
|
81862
|
-
name: 'limit',
|
|
81863
|
-
schema: {
|
|
81864
|
-
default: 500,
|
|
81865
|
-
description:
|
|
81866
|
-
'Numerical limit on the number of devices to return.',
|
|
81867
|
-
format: 'float',
|
|
81868
|
-
type: 'number',
|
|
81869
|
-
},
|
|
81870
|
-
},
|
|
81871
|
-
{
|
|
81872
|
-
in: 'query',
|
|
81873
|
-
name: 'created_before',
|
|
81874
|
-
schema: {
|
|
81875
|
-
description:
|
|
81876
|
-
'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
81877
|
-
format: 'date-time',
|
|
81878
|
-
type: 'string',
|
|
81879
|
-
},
|
|
81880
|
-
},
|
|
81881
|
-
{
|
|
81882
|
-
in: 'query',
|
|
81883
|
-
name: 'user_identifier_key',
|
|
81884
|
-
schema: {
|
|
81885
|
-
description:
|
|
81886
|
-
'Your own internal user ID for the user for which you want to list devices.',
|
|
81887
|
-
type: 'string',
|
|
81888
|
-
},
|
|
81889
|
-
},
|
|
81890
|
-
{
|
|
81891
|
-
in: 'query',
|
|
81892
|
-
name: 'custom_metadata_has',
|
|
81893
|
-
schema: {
|
|
81894
|
-
additionalProperties: {
|
|
81895
|
-
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
81896
|
-
},
|
|
81897
|
-
description:
|
|
81898
|
-
'Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.',
|
|
81899
|
-
type: 'object',
|
|
81900
|
-
},
|
|
81901
|
-
},
|
|
81902
|
-
{
|
|
81903
|
-
in: 'query',
|
|
81904
|
-
name: 'page_cursor',
|
|
81905
|
-
schema: {
|
|
81906
|
-
description:
|
|
81907
|
-
"Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
81908
|
-
nullable: true,
|
|
81909
|
-
type: 'string',
|
|
81910
|
-
},
|
|
81911
|
-
},
|
|
81912
|
-
{
|
|
81913
|
-
in: 'query',
|
|
81914
|
-
name: 'include_if',
|
|
81915
|
-
schema: {
|
|
81916
|
-
items: {
|
|
81917
|
-
enum: [
|
|
81918
|
-
'can_remotely_unlock',
|
|
81919
|
-
'can_remotely_lock',
|
|
81920
|
-
'can_program_offline_access_codes',
|
|
81921
|
-
'can_program_online_access_codes',
|
|
81922
|
-
'can_hvac_heat',
|
|
81923
|
-
'can_hvac_cool',
|
|
81924
|
-
'can_hvac_heat_cool',
|
|
81925
|
-
'can_turn_off_hvac',
|
|
81926
|
-
'can_simulate_removal',
|
|
81927
|
-
'can_simulate_connection',
|
|
81928
|
-
'can_simulate_disconnection',
|
|
81929
|
-
'can_unlock_with_code',
|
|
81930
|
-
'can_run_thermostat_programs',
|
|
81931
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
81932
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
81933
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
81934
|
-
'can_simulate_hub_connection',
|
|
81935
|
-
'can_simulate_hub_disconnection',
|
|
81936
|
-
'can_simulate_paid_subscription',
|
|
81937
|
-
'can_configure_auto_lock',
|
|
81938
|
-
],
|
|
81939
|
-
type: 'string',
|
|
81940
|
-
},
|
|
81941
|
-
type: 'array',
|
|
81942
|
-
'x-undocumented': 'Only used internally.',
|
|
81943
|
-
},
|
|
81944
|
-
},
|
|
81945
|
-
{
|
|
81946
|
-
in: 'query',
|
|
81947
|
-
name: 'exclude_if',
|
|
81948
|
-
schema: {
|
|
81949
|
-
items: {
|
|
81950
|
-
enum: [
|
|
81951
|
-
'can_remotely_unlock',
|
|
81952
|
-
'can_remotely_lock',
|
|
81953
|
-
'can_program_offline_access_codes',
|
|
81954
|
-
'can_program_online_access_codes',
|
|
81955
|
-
'can_hvac_heat',
|
|
81956
|
-
'can_hvac_cool',
|
|
81957
|
-
'can_hvac_heat_cool',
|
|
81958
|
-
'can_turn_off_hvac',
|
|
81959
|
-
'can_simulate_removal',
|
|
81960
|
-
'can_simulate_connection',
|
|
81961
|
-
'can_simulate_disconnection',
|
|
81962
|
-
'can_unlock_with_code',
|
|
81963
|
-
'can_run_thermostat_programs',
|
|
81964
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
81965
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
81966
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
81967
|
-
'can_simulate_hub_connection',
|
|
81968
|
-
'can_simulate_hub_disconnection',
|
|
81969
|
-
'can_simulate_paid_subscription',
|
|
81970
|
-
'can_configure_auto_lock',
|
|
81971
|
-
],
|
|
81972
|
-
type: 'string',
|
|
81973
|
-
},
|
|
81974
|
-
type: 'array',
|
|
81975
|
-
'x-undocumented': 'Only used internally.',
|
|
81976
|
-
},
|
|
81977
|
-
},
|
|
81978
|
-
{
|
|
81979
|
-
in: 'query',
|
|
81980
|
-
name: 'unstable_location_id',
|
|
81981
|
-
schema: {
|
|
81982
|
-
deprecated: true,
|
|
81983
|
-
format: 'uuid',
|
|
81984
|
-
nullable: true,
|
|
81985
|
-
type: 'string',
|
|
81986
|
-
'x-deprecated': 'Use `space_id`.',
|
|
81987
|
-
},
|
|
81988
|
-
},
|
|
81989
|
-
{
|
|
81990
|
-
in: 'query',
|
|
81991
|
-
name: 'space_id',
|
|
81992
|
-
schema: {
|
|
81993
|
-
description:
|
|
81994
|
-
'ID of the space for which you want to list devices.',
|
|
81995
|
-
format: 'uuid',
|
|
81996
|
-
type: 'string',
|
|
81997
|
-
},
|
|
81998
|
-
},
|
|
81999
|
-
{
|
|
82000
|
-
in: 'query',
|
|
82001
|
-
name: 'search',
|
|
82002
|
-
schema: {
|
|
82003
|
-
description:
|
|
82004
|
-
'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.',
|
|
82005
|
-
minLength: 1,
|
|
82006
|
-
type: 'string',
|
|
82007
|
-
},
|
|
82008
|
-
},
|
|
82009
81124
|
],
|
|
82010
81125
|
responses: {
|
|
82011
81126
|
200: {
|
|
@@ -82069,37 +81184,11 @@ const openapi: OpenAPISpec = {
|
|
|
82069
81184
|
format: 'uuid',
|
|
82070
81185
|
type: 'string',
|
|
82071
81186
|
},
|
|
82072
|
-
connected_account_ids: {
|
|
82073
|
-
description:
|
|
82074
|
-
'Array of IDs of the connected accounts for which you want to list devices.',
|
|
82075
|
-
items: { format: 'uuid', type: 'string' },
|
|
82076
|
-
type: 'array',
|
|
82077
|
-
},
|
|
82078
|
-
created_before: {
|
|
82079
|
-
description:
|
|
82080
|
-
'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
82081
|
-
format: 'date-time',
|
|
82082
|
-
type: 'string',
|
|
82083
|
-
},
|
|
82084
|
-
custom_metadata_has: {
|
|
82085
|
-
additionalProperties: {
|
|
82086
|
-
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
82087
|
-
},
|
|
82088
|
-
description:
|
|
82089
|
-
'Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.',
|
|
82090
|
-
type: 'object',
|
|
82091
|
-
},
|
|
82092
81187
|
customer_key: {
|
|
82093
81188
|
description:
|
|
82094
81189
|
'Customer key for which you want to list devices.',
|
|
82095
81190
|
type: 'string',
|
|
82096
81191
|
},
|
|
82097
|
-
device_ids: {
|
|
82098
|
-
description:
|
|
82099
|
-
'Array of device IDs for which you want to list devices.',
|
|
82100
|
-
items: { format: 'uuid', type: 'string' },
|
|
82101
|
-
type: 'array',
|
|
82102
|
-
},
|
|
82103
81192
|
device_type: {
|
|
82104
81193
|
description:
|
|
82105
81194
|
'Device type by which you want to filter thermostat devices.',
|
|
@@ -82130,71 +81219,6 @@ const openapi: OpenAPISpec = {
|
|
|
82130
81219
|
},
|
|
82131
81220
|
type: 'array',
|
|
82132
81221
|
},
|
|
82133
|
-
exclude_if: {
|
|
82134
|
-
items: {
|
|
82135
|
-
enum: [
|
|
82136
|
-
'can_remotely_unlock',
|
|
82137
|
-
'can_remotely_lock',
|
|
82138
|
-
'can_program_offline_access_codes',
|
|
82139
|
-
'can_program_online_access_codes',
|
|
82140
|
-
'can_hvac_heat',
|
|
82141
|
-
'can_hvac_cool',
|
|
82142
|
-
'can_hvac_heat_cool',
|
|
82143
|
-
'can_turn_off_hvac',
|
|
82144
|
-
'can_simulate_removal',
|
|
82145
|
-
'can_simulate_connection',
|
|
82146
|
-
'can_simulate_disconnection',
|
|
82147
|
-
'can_unlock_with_code',
|
|
82148
|
-
'can_run_thermostat_programs',
|
|
82149
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
82150
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
82151
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
82152
|
-
'can_simulate_hub_connection',
|
|
82153
|
-
'can_simulate_hub_disconnection',
|
|
82154
|
-
'can_simulate_paid_subscription',
|
|
82155
|
-
'can_configure_auto_lock',
|
|
82156
|
-
],
|
|
82157
|
-
type: 'string',
|
|
82158
|
-
},
|
|
82159
|
-
type: 'array',
|
|
82160
|
-
'x-undocumented': 'Only used internally.',
|
|
82161
|
-
},
|
|
82162
|
-
include_if: {
|
|
82163
|
-
items: {
|
|
82164
|
-
enum: [
|
|
82165
|
-
'can_remotely_unlock',
|
|
82166
|
-
'can_remotely_lock',
|
|
82167
|
-
'can_program_offline_access_codes',
|
|
82168
|
-
'can_program_online_access_codes',
|
|
82169
|
-
'can_hvac_heat',
|
|
82170
|
-
'can_hvac_cool',
|
|
82171
|
-
'can_hvac_heat_cool',
|
|
82172
|
-
'can_turn_off_hvac',
|
|
82173
|
-
'can_simulate_removal',
|
|
82174
|
-
'can_simulate_connection',
|
|
82175
|
-
'can_simulate_disconnection',
|
|
82176
|
-
'can_unlock_with_code',
|
|
82177
|
-
'can_run_thermostat_programs',
|
|
82178
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
82179
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
82180
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
82181
|
-
'can_simulate_hub_connection',
|
|
82182
|
-
'can_simulate_hub_disconnection',
|
|
82183
|
-
'can_simulate_paid_subscription',
|
|
82184
|
-
'can_configure_auto_lock',
|
|
82185
|
-
],
|
|
82186
|
-
type: 'string',
|
|
82187
|
-
},
|
|
82188
|
-
type: 'array',
|
|
82189
|
-
'x-undocumented': 'Only used internally.',
|
|
82190
|
-
},
|
|
82191
|
-
limit: {
|
|
82192
|
-
default: 500,
|
|
82193
|
-
description:
|
|
82194
|
-
'Numerical limit on the number of devices to return.',
|
|
82195
|
-
format: 'float',
|
|
82196
|
-
type: 'number',
|
|
82197
|
-
},
|
|
82198
81222
|
manufacturer: {
|
|
82199
81223
|
description:
|
|
82200
81224
|
'Manufacturer by which you want to filter thermostat devices.',
|
|
@@ -82208,36 +81232,6 @@ const openapi: OpenAPISpec = {
|
|
|
82208
81232
|
],
|
|
82209
81233
|
type: 'string',
|
|
82210
81234
|
},
|
|
82211
|
-
page_cursor: {
|
|
82212
|
-
description:
|
|
82213
|
-
"Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
82214
|
-
nullable: true,
|
|
82215
|
-
type: 'string',
|
|
82216
|
-
},
|
|
82217
|
-
search: {
|
|
82218
|
-
description:
|
|
82219
|
-
'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.',
|
|
82220
|
-
minLength: 1,
|
|
82221
|
-
type: 'string',
|
|
82222
|
-
},
|
|
82223
|
-
space_id: {
|
|
82224
|
-
description:
|
|
82225
|
-
'ID of the space for which you want to list devices.',
|
|
82226
|
-
format: 'uuid',
|
|
82227
|
-
type: 'string',
|
|
82228
|
-
},
|
|
82229
|
-
unstable_location_id: {
|
|
82230
|
-
deprecated: true,
|
|
82231
|
-
format: 'uuid',
|
|
82232
|
-
nullable: true,
|
|
82233
|
-
type: 'string',
|
|
82234
|
-
'x-deprecated': 'Use `space_id`.',
|
|
82235
|
-
},
|
|
82236
|
-
user_identifier_key: {
|
|
82237
|
-
description:
|
|
82238
|
-
'Your own internal user ID for the user for which you want to list devices.',
|
|
82239
|
-
type: 'string',
|
|
82240
|
-
},
|
|
82241
81235
|
},
|
|
82242
81236
|
type: 'object',
|
|
82243
81237
|
},
|