@seamapi/types 1.991.0 → 1.993.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.
|
@@ -38856,38 +38856,11 @@ const openapi: OpenAPISpec = {
|
|
|
38856
38856
|
'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
38857
|
type: 'boolean',
|
|
38858
38858
|
},
|
|
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
38859
|
name: {
|
|
38876
38860
|
description:
|
|
38877
38861
|
"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
38862
|
type: 'string',
|
|
38879
38863
|
},
|
|
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
38864
|
starts_at: {
|
|
38892
38865
|
description:
|
|
38893
38866
|
'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 +38877,6 @@ const openapi: OpenAPISpec = {
|
|
|
38904
38877
|
enum: ['ongoing', 'time_bound'],
|
|
38905
38878
|
type: 'string',
|
|
38906
38879
|
},
|
|
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
38880
|
},
|
|
38918
38881
|
required: ['access_code_id'],
|
|
38919
38882
|
type: 'object',
|
|
@@ -39009,38 +38972,11 @@ const openapi: OpenAPISpec = {
|
|
|
39009
38972
|
'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
38973
|
type: 'boolean',
|
|
39011
38974
|
},
|
|
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
38975
|
name: {
|
|
39029
38976
|
description:
|
|
39030
38977
|
"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
38978
|
type: 'string',
|
|
39032
38979
|
},
|
|
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
38980
|
starts_at: {
|
|
39045
38981
|
description:
|
|
39046
38982
|
'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 +38993,6 @@ const openapi: OpenAPISpec = {
|
|
|
39057
38993
|
enum: ['ongoing', 'time_bound'],
|
|
39058
38994
|
type: 'string',
|
|
39059
38995
|
},
|
|
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
38996
|
},
|
|
39071
38997
|
required: ['access_code_id'],
|
|
39072
38998
|
type: 'object',
|
|
@@ -39162,38 +39088,11 @@ const openapi: OpenAPISpec = {
|
|
|
39162
39088
|
'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
39089
|
type: 'boolean',
|
|
39164
39090
|
},
|
|
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
39091
|
name: {
|
|
39182
39092
|
description:
|
|
39183
39093
|
"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
39094
|
type: 'string',
|
|
39185
39095
|
},
|
|
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
39096
|
starts_at: {
|
|
39198
39097
|
description:
|
|
39199
39098
|
'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 +39109,6 @@ const openapi: OpenAPISpec = {
|
|
|
39210
39109
|
enum: ['ongoing', 'time_bound'],
|
|
39211
39110
|
type: 'string',
|
|
39212
39111
|
},
|
|
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
39112
|
},
|
|
39224
39113
|
required: ['access_code_id'],
|
|
39225
39114
|
type: 'object',
|
|
@@ -57746,27 +57635,6 @@ const openapi: OpenAPISpec = {
|
|
|
57746
57635
|
type: 'string',
|
|
57747
57636
|
},
|
|
57748
57637
|
},
|
|
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
57638
|
{
|
|
57771
57639
|
in: 'query',
|
|
57772
57640
|
name: 'page_cursor',
|
|
@@ -57843,27 +57711,6 @@ const openapi: OpenAPISpec = {
|
|
|
57843
57711
|
'x-undocumented': 'Only used internally.',
|
|
57844
57712
|
},
|
|
57845
57713
|
},
|
|
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
57714
|
{
|
|
57868
57715
|
in: 'query',
|
|
57869
57716
|
name: 'search',
|
|
@@ -57958,14 +57805,6 @@ const openapi: OpenAPISpec = {
|
|
|
57958
57805
|
format: 'date-time',
|
|
57959
57806
|
type: 'string',
|
|
57960
57807
|
},
|
|
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
57808
|
customer_key: {
|
|
57970
57809
|
description:
|
|
57971
57810
|
'Customer key for which you want to list devices.',
|
|
@@ -58267,24 +58106,6 @@ const openapi: OpenAPISpec = {
|
|
|
58267
58106
|
minLength: 1,
|
|
58268
58107
|
type: 'string',
|
|
58269
58108
|
},
|
|
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
58109
|
},
|
|
58289
58110
|
type: 'object',
|
|
58290
58111
|
},
|
|
@@ -60333,16 +60154,6 @@ const openapi: OpenAPISpec = {
|
|
|
60333
60154
|
type: 'string',
|
|
60334
60155
|
},
|
|
60335
60156
|
},
|
|
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
60157
|
{
|
|
60347
60158
|
in: 'query',
|
|
60348
60159
|
name: 'connect_webview_id',
|
|
@@ -60479,165 +60290,6 @@ const openapi: OpenAPISpec = {
|
|
|
60479
60290
|
type: 'string',
|
|
60480
60291
|
},
|
|
60481
60292
|
},
|
|
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
60293
|
],
|
|
60642
60294
|
responses: {
|
|
60643
60295
|
200: {
|
|
@@ -60701,37 +60353,11 @@ const openapi: OpenAPISpec = {
|
|
|
60701
60353
|
format: 'uuid',
|
|
60702
60354
|
type: 'string',
|
|
60703
60355
|
},
|
|
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
60356
|
customer_key: {
|
|
60725
60357
|
description:
|
|
60726
60358
|
'Customer key for which you want to list devices.',
|
|
60727
60359
|
type: 'string',
|
|
60728
60360
|
},
|
|
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
60361
|
device_type: {
|
|
60736
60362
|
description:
|
|
60737
60363
|
'Device type of the locks that you want to list.',
|
|
@@ -60810,71 +60436,6 @@ const openapi: OpenAPISpec = {
|
|
|
60810
60436
|
},
|
|
60811
60437
|
type: 'array',
|
|
60812
60438
|
},
|
|
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
60439
|
manufacturer: {
|
|
60879
60440
|
description:
|
|
60880
60441
|
'Manufacturer of the locks that you want to list.',
|
|
@@ -60914,36 +60475,6 @@ const openapi: OpenAPISpec = {
|
|
|
60914
60475
|
],
|
|
60915
60476
|
type: 'string',
|
|
60916
60477
|
},
|
|
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
60478
|
},
|
|
60948
60479
|
type: 'object',
|
|
60949
60480
|
},
|
|
@@ -61269,16 +60800,6 @@ const openapi: OpenAPISpec = {
|
|
|
61269
60800
|
type: 'string',
|
|
61270
60801
|
},
|
|
61271
60802
|
},
|
|
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
60803
|
{
|
|
61283
60804
|
in: 'query',
|
|
61284
60805
|
name: 'connect_webview_id',
|
|
@@ -61323,165 +60844,6 @@ const openapi: OpenAPISpec = {
|
|
|
61323
60844
|
type: 'string',
|
|
61324
60845
|
},
|
|
61325
60846
|
},
|
|
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
60847
|
],
|
|
61486
60848
|
responses: {
|
|
61487
60849
|
200: {
|
|
@@ -61545,37 +60907,11 @@ const openapi: OpenAPISpec = {
|
|
|
61545
60907
|
format: 'uuid',
|
|
61546
60908
|
type: 'string',
|
|
61547
60909
|
},
|
|
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
60910
|
customer_key: {
|
|
61569
60911
|
description:
|
|
61570
60912
|
'Customer key for which you want to list devices.',
|
|
61571
60913
|
type: 'string',
|
|
61572
60914
|
},
|
|
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
60915
|
device_type: {
|
|
61580
60916
|
description:
|
|
61581
60917
|
'Device type of the noise sensors that you want to list.',
|
|
@@ -61592,107 +60928,12 @@ const openapi: OpenAPISpec = {
|
|
|
61592
60928
|
},
|
|
61593
60929
|
type: 'array',
|
|
61594
60930
|
},
|
|
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
60931
|
manufacturer: {
|
|
61661
60932
|
description:
|
|
61662
60933
|
'Manufacturers of the noise sensors that you want to list.',
|
|
61663
60934
|
enum: ['minut', 'noiseaware'],
|
|
61664
60935
|
type: 'string',
|
|
61665
60936
|
},
|
|
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
60937
|
},
|
|
61697
60938
|
type: 'object',
|
|
61698
60939
|
},
|
|
@@ -67524,6 +66765,7 @@ const openapi: OpenAPISpec = {
|
|
|
67524
66765
|
'AUTOMATION_IMMINENT_CHECK_IN_QUEUE',
|
|
67525
66766
|
'ACCESS_METHOD_DEADLINE_ERRORS',
|
|
67526
66767
|
'GUARD_MATERIALIZATION_ON_UNREACHABLE_DEVICE',
|
|
66768
|
+
'TARGETED_ACCESS_GRANT_ISSUANCE',
|
|
67527
66769
|
],
|
|
67528
66770
|
type: 'string',
|
|
67529
66771
|
},
|
|
@@ -67558,6 +66800,7 @@ const openapi: OpenAPISpec = {
|
|
|
67558
66800
|
'AUTOMATION_IMMINENT_CHECK_IN_QUEUE',
|
|
67559
66801
|
'ACCESS_METHOD_DEADLINE_ERRORS',
|
|
67560
66802
|
'GUARD_MATERIALIZATION_ON_UNREACHABLE_DEVICE',
|
|
66803
|
+
'TARGETED_ACCESS_GRANT_ISSUANCE',
|
|
67561
66804
|
],
|
|
67562
66805
|
type: 'string',
|
|
67563
66806
|
},
|
|
@@ -81770,16 +81013,6 @@ const openapi: OpenAPISpec = {
|
|
|
81770
81013
|
type: 'string',
|
|
81771
81014
|
},
|
|
81772
81015
|
},
|
|
81773
|
-
{
|
|
81774
|
-
in: 'query',
|
|
81775
|
-
name: 'connected_account_ids',
|
|
81776
|
-
schema: {
|
|
81777
|
-
description:
|
|
81778
|
-
'Array of IDs of the connected accounts for which you want to list devices.',
|
|
81779
|
-
items: { format: 'uuid', type: 'string' },
|
|
81780
|
-
type: 'array',
|
|
81781
|
-
},
|
|
81782
|
-
},
|
|
81783
81016
|
{
|
|
81784
81017
|
in: 'query',
|
|
81785
81018
|
name: 'connect_webview_id',
|
|
@@ -81845,165 +81078,6 @@ const openapi: OpenAPISpec = {
|
|
|
81845
81078
|
type: 'string',
|
|
81846
81079
|
},
|
|
81847
81080
|
},
|
|
81848
|
-
{
|
|
81849
|
-
in: 'query',
|
|
81850
|
-
name: 'device_ids',
|
|
81851
|
-
schema: {
|
|
81852
|
-
description:
|
|
81853
|
-
'Array of device IDs for which you want to list devices.',
|
|
81854
|
-
items: { format: 'uuid', type: 'string' },
|
|
81855
|
-
type: 'array',
|
|
81856
|
-
},
|
|
81857
|
-
},
|
|
81858
|
-
{
|
|
81859
|
-
in: 'query',
|
|
81860
|
-
name: 'limit',
|
|
81861
|
-
schema: {
|
|
81862
|
-
default: 500,
|
|
81863
|
-
description:
|
|
81864
|
-
'Numerical limit on the number of devices to return.',
|
|
81865
|
-
format: 'float',
|
|
81866
|
-
type: 'number',
|
|
81867
|
-
},
|
|
81868
|
-
},
|
|
81869
|
-
{
|
|
81870
|
-
in: 'query',
|
|
81871
|
-
name: 'created_before',
|
|
81872
|
-
schema: {
|
|
81873
|
-
description:
|
|
81874
|
-
'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
81875
|
-
format: 'date-time',
|
|
81876
|
-
type: 'string',
|
|
81877
|
-
},
|
|
81878
|
-
},
|
|
81879
|
-
{
|
|
81880
|
-
in: 'query',
|
|
81881
|
-
name: 'user_identifier_key',
|
|
81882
|
-
schema: {
|
|
81883
|
-
description:
|
|
81884
|
-
'Your own internal user ID for the user for which you want to list devices.',
|
|
81885
|
-
type: 'string',
|
|
81886
|
-
},
|
|
81887
|
-
},
|
|
81888
|
-
{
|
|
81889
|
-
in: 'query',
|
|
81890
|
-
name: 'custom_metadata_has',
|
|
81891
|
-
schema: {
|
|
81892
|
-
additionalProperties: {
|
|
81893
|
-
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
81894
|
-
},
|
|
81895
|
-
description:
|
|
81896
|
-
'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.',
|
|
81897
|
-
type: 'object',
|
|
81898
|
-
},
|
|
81899
|
-
},
|
|
81900
|
-
{
|
|
81901
|
-
in: 'query',
|
|
81902
|
-
name: 'page_cursor',
|
|
81903
|
-
schema: {
|
|
81904
|
-
description:
|
|
81905
|
-
"Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
81906
|
-
nullable: true,
|
|
81907
|
-
type: 'string',
|
|
81908
|
-
},
|
|
81909
|
-
},
|
|
81910
|
-
{
|
|
81911
|
-
in: 'query',
|
|
81912
|
-
name: 'include_if',
|
|
81913
|
-
schema: {
|
|
81914
|
-
items: {
|
|
81915
|
-
enum: [
|
|
81916
|
-
'can_remotely_unlock',
|
|
81917
|
-
'can_remotely_lock',
|
|
81918
|
-
'can_program_offline_access_codes',
|
|
81919
|
-
'can_program_online_access_codes',
|
|
81920
|
-
'can_hvac_heat',
|
|
81921
|
-
'can_hvac_cool',
|
|
81922
|
-
'can_hvac_heat_cool',
|
|
81923
|
-
'can_turn_off_hvac',
|
|
81924
|
-
'can_simulate_removal',
|
|
81925
|
-
'can_simulate_connection',
|
|
81926
|
-
'can_simulate_disconnection',
|
|
81927
|
-
'can_unlock_with_code',
|
|
81928
|
-
'can_run_thermostat_programs',
|
|
81929
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
81930
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
81931
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
81932
|
-
'can_simulate_hub_connection',
|
|
81933
|
-
'can_simulate_hub_disconnection',
|
|
81934
|
-
'can_simulate_paid_subscription',
|
|
81935
|
-
'can_configure_auto_lock',
|
|
81936
|
-
],
|
|
81937
|
-
type: 'string',
|
|
81938
|
-
},
|
|
81939
|
-
type: 'array',
|
|
81940
|
-
'x-undocumented': 'Only used internally.',
|
|
81941
|
-
},
|
|
81942
|
-
},
|
|
81943
|
-
{
|
|
81944
|
-
in: 'query',
|
|
81945
|
-
name: 'exclude_if',
|
|
81946
|
-
schema: {
|
|
81947
|
-
items: {
|
|
81948
|
-
enum: [
|
|
81949
|
-
'can_remotely_unlock',
|
|
81950
|
-
'can_remotely_lock',
|
|
81951
|
-
'can_program_offline_access_codes',
|
|
81952
|
-
'can_program_online_access_codes',
|
|
81953
|
-
'can_hvac_heat',
|
|
81954
|
-
'can_hvac_cool',
|
|
81955
|
-
'can_hvac_heat_cool',
|
|
81956
|
-
'can_turn_off_hvac',
|
|
81957
|
-
'can_simulate_removal',
|
|
81958
|
-
'can_simulate_connection',
|
|
81959
|
-
'can_simulate_disconnection',
|
|
81960
|
-
'can_unlock_with_code',
|
|
81961
|
-
'can_run_thermostat_programs',
|
|
81962
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
81963
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
81964
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
81965
|
-
'can_simulate_hub_connection',
|
|
81966
|
-
'can_simulate_hub_disconnection',
|
|
81967
|
-
'can_simulate_paid_subscription',
|
|
81968
|
-
'can_configure_auto_lock',
|
|
81969
|
-
],
|
|
81970
|
-
type: 'string',
|
|
81971
|
-
},
|
|
81972
|
-
type: 'array',
|
|
81973
|
-
'x-undocumented': 'Only used internally.',
|
|
81974
|
-
},
|
|
81975
|
-
},
|
|
81976
|
-
{
|
|
81977
|
-
in: 'query',
|
|
81978
|
-
name: 'unstable_location_id',
|
|
81979
|
-
schema: {
|
|
81980
|
-
deprecated: true,
|
|
81981
|
-
format: 'uuid',
|
|
81982
|
-
nullable: true,
|
|
81983
|
-
type: 'string',
|
|
81984
|
-
'x-deprecated': 'Use `space_id`.',
|
|
81985
|
-
},
|
|
81986
|
-
},
|
|
81987
|
-
{
|
|
81988
|
-
in: 'query',
|
|
81989
|
-
name: 'space_id',
|
|
81990
|
-
schema: {
|
|
81991
|
-
description:
|
|
81992
|
-
'ID of the space for which you want to list devices.',
|
|
81993
|
-
format: 'uuid',
|
|
81994
|
-
type: 'string',
|
|
81995
|
-
},
|
|
81996
|
-
},
|
|
81997
|
-
{
|
|
81998
|
-
in: 'query',
|
|
81999
|
-
name: 'search',
|
|
82000
|
-
schema: {
|
|
82001
|
-
description:
|
|
82002
|
-
'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`.',
|
|
82003
|
-
minLength: 1,
|
|
82004
|
-
type: 'string',
|
|
82005
|
-
},
|
|
82006
|
-
},
|
|
82007
81081
|
],
|
|
82008
81082
|
responses: {
|
|
82009
81083
|
200: {
|
|
@@ -82067,37 +81141,11 @@ const openapi: OpenAPISpec = {
|
|
|
82067
81141
|
format: 'uuid',
|
|
82068
81142
|
type: 'string',
|
|
82069
81143
|
},
|
|
82070
|
-
connected_account_ids: {
|
|
82071
|
-
description:
|
|
82072
|
-
'Array of IDs of the connected accounts for which you want to list devices.',
|
|
82073
|
-
items: { format: 'uuid', type: 'string' },
|
|
82074
|
-
type: 'array',
|
|
82075
|
-
},
|
|
82076
|
-
created_before: {
|
|
82077
|
-
description:
|
|
82078
|
-
'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
82079
|
-
format: 'date-time',
|
|
82080
|
-
type: 'string',
|
|
82081
|
-
},
|
|
82082
|
-
custom_metadata_has: {
|
|
82083
|
-
additionalProperties: {
|
|
82084
|
-
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
82085
|
-
},
|
|
82086
|
-
description:
|
|
82087
|
-
'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.',
|
|
82088
|
-
type: 'object',
|
|
82089
|
-
},
|
|
82090
81144
|
customer_key: {
|
|
82091
81145
|
description:
|
|
82092
81146
|
'Customer key for which you want to list devices.',
|
|
82093
81147
|
type: 'string',
|
|
82094
81148
|
},
|
|
82095
|
-
device_ids: {
|
|
82096
|
-
description:
|
|
82097
|
-
'Array of device IDs for which you want to list devices.',
|
|
82098
|
-
items: { format: 'uuid', type: 'string' },
|
|
82099
|
-
type: 'array',
|
|
82100
|
-
},
|
|
82101
81149
|
device_type: {
|
|
82102
81150
|
description:
|
|
82103
81151
|
'Device type by which you want to filter thermostat devices.',
|
|
@@ -82128,71 +81176,6 @@ const openapi: OpenAPISpec = {
|
|
|
82128
81176
|
},
|
|
82129
81177
|
type: 'array',
|
|
82130
81178
|
},
|
|
82131
|
-
exclude_if: {
|
|
82132
|
-
items: {
|
|
82133
|
-
enum: [
|
|
82134
|
-
'can_remotely_unlock',
|
|
82135
|
-
'can_remotely_lock',
|
|
82136
|
-
'can_program_offline_access_codes',
|
|
82137
|
-
'can_program_online_access_codes',
|
|
82138
|
-
'can_hvac_heat',
|
|
82139
|
-
'can_hvac_cool',
|
|
82140
|
-
'can_hvac_heat_cool',
|
|
82141
|
-
'can_turn_off_hvac',
|
|
82142
|
-
'can_simulate_removal',
|
|
82143
|
-
'can_simulate_connection',
|
|
82144
|
-
'can_simulate_disconnection',
|
|
82145
|
-
'can_unlock_with_code',
|
|
82146
|
-
'can_run_thermostat_programs',
|
|
82147
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
82148
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
82149
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
82150
|
-
'can_simulate_hub_connection',
|
|
82151
|
-
'can_simulate_hub_disconnection',
|
|
82152
|
-
'can_simulate_paid_subscription',
|
|
82153
|
-
'can_configure_auto_lock',
|
|
82154
|
-
],
|
|
82155
|
-
type: 'string',
|
|
82156
|
-
},
|
|
82157
|
-
type: 'array',
|
|
82158
|
-
'x-undocumented': 'Only used internally.',
|
|
82159
|
-
},
|
|
82160
|
-
include_if: {
|
|
82161
|
-
items: {
|
|
82162
|
-
enum: [
|
|
82163
|
-
'can_remotely_unlock',
|
|
82164
|
-
'can_remotely_lock',
|
|
82165
|
-
'can_program_offline_access_codes',
|
|
82166
|
-
'can_program_online_access_codes',
|
|
82167
|
-
'can_hvac_heat',
|
|
82168
|
-
'can_hvac_cool',
|
|
82169
|
-
'can_hvac_heat_cool',
|
|
82170
|
-
'can_turn_off_hvac',
|
|
82171
|
-
'can_simulate_removal',
|
|
82172
|
-
'can_simulate_connection',
|
|
82173
|
-
'can_simulate_disconnection',
|
|
82174
|
-
'can_unlock_with_code',
|
|
82175
|
-
'can_run_thermostat_programs',
|
|
82176
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
82177
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
82178
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
82179
|
-
'can_simulate_hub_connection',
|
|
82180
|
-
'can_simulate_hub_disconnection',
|
|
82181
|
-
'can_simulate_paid_subscription',
|
|
82182
|
-
'can_configure_auto_lock',
|
|
82183
|
-
],
|
|
82184
|
-
type: 'string',
|
|
82185
|
-
},
|
|
82186
|
-
type: 'array',
|
|
82187
|
-
'x-undocumented': 'Only used internally.',
|
|
82188
|
-
},
|
|
82189
|
-
limit: {
|
|
82190
|
-
default: 500,
|
|
82191
|
-
description:
|
|
82192
|
-
'Numerical limit on the number of devices to return.',
|
|
82193
|
-
format: 'float',
|
|
82194
|
-
type: 'number',
|
|
82195
|
-
},
|
|
82196
81179
|
manufacturer: {
|
|
82197
81180
|
description:
|
|
82198
81181
|
'Manufacturer by which you want to filter thermostat devices.',
|
|
@@ -82206,36 +81189,6 @@ const openapi: OpenAPISpec = {
|
|
|
82206
81189
|
],
|
|
82207
81190
|
type: 'string',
|
|
82208
81191
|
},
|
|
82209
|
-
page_cursor: {
|
|
82210
|
-
description:
|
|
82211
|
-
"Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
82212
|
-
nullable: true,
|
|
82213
|
-
type: 'string',
|
|
82214
|
-
},
|
|
82215
|
-
search: {
|
|
82216
|
-
description:
|
|
82217
|
-
'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`.',
|
|
82218
|
-
minLength: 1,
|
|
82219
|
-
type: 'string',
|
|
82220
|
-
},
|
|
82221
|
-
space_id: {
|
|
82222
|
-
description:
|
|
82223
|
-
'ID of the space for which you want to list devices.',
|
|
82224
|
-
format: 'uuid',
|
|
82225
|
-
type: 'string',
|
|
82226
|
-
},
|
|
82227
|
-
unstable_location_id: {
|
|
82228
|
-
deprecated: true,
|
|
82229
|
-
format: 'uuid',
|
|
82230
|
-
nullable: true,
|
|
82231
|
-
type: 'string',
|
|
82232
|
-
'x-deprecated': 'Use `space_id`.',
|
|
82233
|
-
},
|
|
82234
|
-
user_identifier_key: {
|
|
82235
|
-
description:
|
|
82236
|
-
'Your own internal user ID for the user for which you want to list devices.',
|
|
82237
|
-
type: 'string',
|
|
82238
|
-
},
|
|
82239
81192
|
},
|
|
82240
81193
|
type: 'object',
|
|
82241
81194
|
},
|