@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.
|
@@ -33121,6 +33121,7 @@ const openapi = {
|
|
|
33121
33121
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
33122
33122
|
'x-fern-sdk-method-name': 'get',
|
|
33123
33123
|
'x-fern-sdk-return-value': 'access_code',
|
|
33124
|
+
'x-has-required-parameters': true,
|
|
33124
33125
|
'x-response-key': 'access_code',
|
|
33125
33126
|
'x-title': 'Get an Access Code',
|
|
33126
33127
|
},
|
|
@@ -33185,6 +33186,7 @@ const openapi = {
|
|
|
33185
33186
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
33186
33187
|
'x-fern-sdk-method-name': 'get',
|
|
33187
33188
|
'x-fern-sdk-return-value': 'access_code',
|
|
33189
|
+
'x-has-required-parameters': true,
|
|
33188
33190
|
'x-response-key': 'access_code',
|
|
33189
33191
|
'x-title': 'Get an Access Code',
|
|
33190
33192
|
},
|
|
@@ -33783,6 +33785,7 @@ const openapi = {
|
|
|
33783
33785
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
33784
33786
|
'x-fern-sdk-method-name': 'list',
|
|
33785
33787
|
'x-fern-sdk-return-value': 'access_codes',
|
|
33788
|
+
'x-has-required-parameters': true,
|
|
33786
33789
|
'x-response-key': 'access_codes',
|
|
33787
33790
|
'x-title': 'List Access Codes',
|
|
33788
33791
|
},
|
|
@@ -33885,6 +33888,7 @@ const openapi = {
|
|
|
33885
33888
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
33886
33889
|
'x-fern-sdk-method-name': 'list',
|
|
33887
33890
|
'x-fern-sdk-return-value': 'access_codes',
|
|
33891
|
+
'x-has-required-parameters': true,
|
|
33888
33892
|
'x-response-key': 'access_codes',
|
|
33889
33893
|
'x-title': 'List Access Codes',
|
|
33890
33894
|
},
|
|
@@ -34414,6 +34418,7 @@ const openapi = {
|
|
|
34414
34418
|
'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
|
|
34415
34419
|
'x-fern-sdk-method-name': 'get',
|
|
34416
34420
|
'x-fern-sdk-return-value': 'access_code',
|
|
34421
|
+
'x-has-required-parameters': true,
|
|
34417
34422
|
'x-response-key': 'access_code',
|
|
34418
34423
|
'x-title': 'Get an Unmanaged Access Code',
|
|
34419
34424
|
},
|
|
@@ -34480,6 +34485,7 @@ const openapi = {
|
|
|
34480
34485
|
'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
|
|
34481
34486
|
'x-fern-sdk-method-name': 'get',
|
|
34482
34487
|
'x-fern-sdk-return-value': 'access_code',
|
|
34488
|
+
'x-has-required-parameters': true,
|
|
34483
34489
|
'x-response-key': 'access_code',
|
|
34484
34490
|
'x-title': 'Get an Unmanaged Access Code',
|
|
34485
34491
|
},
|
|
@@ -34839,32 +34845,10 @@ const openapi = {
|
|
|
34839
34845
|
description: '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`.',
|
|
34840
34846
|
type: 'boolean',
|
|
34841
34847
|
},
|
|
34842
|
-
is_offline_access_code: {
|
|
34843
|
-
description: 'Indicates whether the access code is an [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes).',
|
|
34844
|
-
type: 'boolean',
|
|
34845
|
-
},
|
|
34846
|
-
is_one_time_use: {
|
|
34847
|
-
description: '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.',
|
|
34848
|
-
type: 'boolean',
|
|
34849
|
-
},
|
|
34850
|
-
max_time_rounding: {
|
|
34851
|
-
description: '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`.',
|
|
34852
|
-
enum: ['1hour', '1day', '1h', '1d'],
|
|
34853
|
-
type: 'string',
|
|
34854
|
-
},
|
|
34855
34848
|
name: {
|
|
34856
34849
|
description: "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).",
|
|
34857
34850
|
type: 'string',
|
|
34858
34851
|
},
|
|
34859
|
-
prefer_native_scheduling: {
|
|
34860
|
-
description: '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`.',
|
|
34861
|
-
type: 'boolean',
|
|
34862
|
-
},
|
|
34863
|
-
preferred_code_length: {
|
|
34864
|
-
description: '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.',
|
|
34865
|
-
format: 'float',
|
|
34866
|
-
type: 'number',
|
|
34867
|
-
},
|
|
34868
34852
|
starts_at: {
|
|
34869
34853
|
description: '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.',
|
|
34870
34854
|
type: 'string',
|
|
@@ -34879,15 +34863,6 @@ const openapi = {
|
|
|
34879
34863
|
enum: ['ongoing', 'time_bound'],
|
|
34880
34864
|
type: 'string',
|
|
34881
34865
|
},
|
|
34882
|
-
use_backup_access_code_pool: {
|
|
34883
|
-
description: '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).',
|
|
34884
|
-
type: 'boolean',
|
|
34885
|
-
},
|
|
34886
|
-
use_offline_access_code: {
|
|
34887
|
-
deprecated: true,
|
|
34888
|
-
type: 'boolean',
|
|
34889
|
-
'x-deprecated': 'Use `is_offline_access_code` instead.',
|
|
34890
|
-
},
|
|
34891
34866
|
},
|
|
34892
34867
|
required: ['access_code_id'],
|
|
34893
34868
|
type: 'object',
|
|
@@ -34976,32 +34951,10 @@ const openapi = {
|
|
|
34976
34951
|
description: '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`.',
|
|
34977
34952
|
type: 'boolean',
|
|
34978
34953
|
},
|
|
34979
|
-
is_offline_access_code: {
|
|
34980
|
-
description: 'Indicates whether the access code is an [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes).',
|
|
34981
|
-
type: 'boolean',
|
|
34982
|
-
},
|
|
34983
|
-
is_one_time_use: {
|
|
34984
|
-
description: '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.',
|
|
34985
|
-
type: 'boolean',
|
|
34986
|
-
},
|
|
34987
|
-
max_time_rounding: {
|
|
34988
|
-
description: '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`.',
|
|
34989
|
-
enum: ['1hour', '1day', '1h', '1d'],
|
|
34990
|
-
type: 'string',
|
|
34991
|
-
},
|
|
34992
34954
|
name: {
|
|
34993
34955
|
description: "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).",
|
|
34994
34956
|
type: 'string',
|
|
34995
34957
|
},
|
|
34996
|
-
prefer_native_scheduling: {
|
|
34997
|
-
description: '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`.',
|
|
34998
|
-
type: 'boolean',
|
|
34999
|
-
},
|
|
35000
|
-
preferred_code_length: {
|
|
35001
|
-
description: '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.',
|
|
35002
|
-
format: 'float',
|
|
35003
|
-
type: 'number',
|
|
35004
|
-
},
|
|
35005
34958
|
starts_at: {
|
|
35006
34959
|
description: '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.',
|
|
35007
34960
|
type: 'string',
|
|
@@ -35016,15 +34969,6 @@ const openapi = {
|
|
|
35016
34969
|
enum: ['ongoing', 'time_bound'],
|
|
35017
34970
|
type: 'string',
|
|
35018
34971
|
},
|
|
35019
|
-
use_backup_access_code_pool: {
|
|
35020
|
-
description: '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).',
|
|
35021
|
-
type: 'boolean',
|
|
35022
|
-
},
|
|
35023
|
-
use_offline_access_code: {
|
|
35024
|
-
deprecated: true,
|
|
35025
|
-
type: 'boolean',
|
|
35026
|
-
'x-deprecated': 'Use `is_offline_access_code` instead.',
|
|
35027
|
-
},
|
|
35028
34972
|
},
|
|
35029
34973
|
required: ['access_code_id'],
|
|
35030
34974
|
type: 'object',
|
|
@@ -35113,32 +35057,10 @@ const openapi = {
|
|
|
35113
35057
|
description: '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`.',
|
|
35114
35058
|
type: 'boolean',
|
|
35115
35059
|
},
|
|
35116
|
-
is_offline_access_code: {
|
|
35117
|
-
description: 'Indicates whether the access code is an [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes).',
|
|
35118
|
-
type: 'boolean',
|
|
35119
|
-
},
|
|
35120
|
-
is_one_time_use: {
|
|
35121
|
-
description: '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.',
|
|
35122
|
-
type: 'boolean',
|
|
35123
|
-
},
|
|
35124
|
-
max_time_rounding: {
|
|
35125
|
-
description: '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`.',
|
|
35126
|
-
enum: ['1hour', '1day', '1h', '1d'],
|
|
35127
|
-
type: 'string',
|
|
35128
|
-
},
|
|
35129
35060
|
name: {
|
|
35130
35061
|
description: "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).",
|
|
35131
35062
|
type: 'string',
|
|
35132
35063
|
},
|
|
35133
|
-
prefer_native_scheduling: {
|
|
35134
|
-
description: '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`.',
|
|
35135
|
-
type: 'boolean',
|
|
35136
|
-
},
|
|
35137
|
-
preferred_code_length: {
|
|
35138
|
-
description: '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.',
|
|
35139
|
-
format: 'float',
|
|
35140
|
-
type: 'number',
|
|
35141
|
-
},
|
|
35142
35064
|
starts_at: {
|
|
35143
35065
|
description: '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.',
|
|
35144
35066
|
type: 'string',
|
|
@@ -35153,15 +35075,6 @@ const openapi = {
|
|
|
35153
35075
|
enum: ['ongoing', 'time_bound'],
|
|
35154
35076
|
type: 'string',
|
|
35155
35077
|
},
|
|
35156
|
-
use_backup_access_code_pool: {
|
|
35157
|
-
description: '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).',
|
|
35158
|
-
type: 'boolean',
|
|
35159
|
-
},
|
|
35160
|
-
use_offline_access_code: {
|
|
35161
|
-
deprecated: true,
|
|
35162
|
-
type: 'boolean',
|
|
35163
|
-
'x-deprecated': 'Use `is_offline_access_code` instead.',
|
|
35164
|
-
},
|
|
35165
35078
|
},
|
|
35166
35079
|
required: ['access_code_id'],
|
|
35167
35080
|
type: 'object',
|
|
@@ -35892,6 +35805,7 @@ const openapi = {
|
|
|
35892
35805
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
35893
35806
|
'x-fern-sdk-method-name': 'get_related',
|
|
35894
35807
|
'x-fern-sdk-return-value': 'batch',
|
|
35808
|
+
'x-has-required-parameters': true,
|
|
35895
35809
|
'x-response-key': 'batch',
|
|
35896
35810
|
'x-title': 'Get related Access Grant resources',
|
|
35897
35811
|
},
|
|
@@ -36033,6 +35947,7 @@ const openapi = {
|
|
|
36033
35947
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
36034
35948
|
'x-fern-sdk-method-name': 'get_related',
|
|
36035
35949
|
'x-fern-sdk-return-value': 'batch',
|
|
35950
|
+
'x-has-required-parameters': true,
|
|
36036
35951
|
'x-response-key': 'batch',
|
|
36037
35952
|
'x-title': 'Get related Access Grant resources',
|
|
36038
35953
|
},
|
|
@@ -36884,6 +36799,7 @@ const openapi = {
|
|
|
36884
36799
|
tags: [],
|
|
36885
36800
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
36886
36801
|
'x-fern-sdk-method-name': 'update',
|
|
36802
|
+
'x-has-required-parameters': true,
|
|
36887
36803
|
'x-response-key': null,
|
|
36888
36804
|
'x-title': 'Update an Access Grant',
|
|
36889
36805
|
},
|
|
@@ -36953,6 +36869,7 @@ const openapi = {
|
|
|
36953
36869
|
tags: [],
|
|
36954
36870
|
'x-fern-sdk-group-name': ['access_grants'],
|
|
36955
36871
|
'x-fern-sdk-method-name': 'update',
|
|
36872
|
+
'x-has-required-parameters': true,
|
|
36956
36873
|
'x-response-key': null,
|
|
36957
36874
|
'x-title': 'Update an Access Grant',
|
|
36958
36875
|
},
|
|
@@ -37696,6 +37613,7 @@ const openapi = {
|
|
|
37696
37613
|
'x-fern-sdk-group-name': ['access_methods'],
|
|
37697
37614
|
'x-fern-sdk-method-name': 'list',
|
|
37698
37615
|
'x-fern-sdk-return-value': 'access_methods',
|
|
37616
|
+
'x-has-required-parameters': true,
|
|
37699
37617
|
'x-response-key': 'access_methods',
|
|
37700
37618
|
'x-title': 'List Access Methods',
|
|
37701
37619
|
},
|
|
@@ -37791,6 +37709,7 @@ const openapi = {
|
|
|
37791
37709
|
'x-fern-sdk-group-name': ['access_methods'],
|
|
37792
37710
|
'x-fern-sdk-method-name': 'list',
|
|
37793
37711
|
'x-fern-sdk-return-value': 'access_methods',
|
|
37712
|
+
'x-has-required-parameters': true,
|
|
37794
37713
|
'x-response-key': 'access_methods',
|
|
37795
37714
|
'x-title': 'List Access Methods',
|
|
37796
37715
|
},
|
|
@@ -42907,6 +42826,7 @@ const openapi = {
|
|
|
42907
42826
|
tags: ['/acs'],
|
|
42908
42827
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
42909
42828
|
'x-fern-sdk-method-name': 'delete',
|
|
42829
|
+
'x-has-required-parameters': true,
|
|
42910
42830
|
'x-response-key': null,
|
|
42911
42831
|
'x-title': 'Delete an ACS User',
|
|
42912
42832
|
},
|
|
@@ -42964,6 +42884,7 @@ const openapi = {
|
|
|
42964
42884
|
tags: ['/acs'],
|
|
42965
42885
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
42966
42886
|
'x-fern-sdk-method-name': 'delete',
|
|
42887
|
+
'x-has-required-parameters': true,
|
|
42967
42888
|
'x-response-key': null,
|
|
42968
42889
|
'x-title': 'Delete an ACS User',
|
|
42969
42890
|
},
|
|
@@ -43031,6 +42952,7 @@ const openapi = {
|
|
|
43031
42952
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
43032
42953
|
'x-fern-sdk-method-name': 'get',
|
|
43033
42954
|
'x-fern-sdk-return-value': 'acs_user',
|
|
42955
|
+
'x-has-required-parameters': true,
|
|
43034
42956
|
'x-response-key': 'acs_user',
|
|
43035
42957
|
'x-title': 'Get an ACS User',
|
|
43036
42958
|
},
|
|
@@ -43093,6 +43015,7 @@ const openapi = {
|
|
|
43093
43015
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
43094
43016
|
'x-fern-sdk-method-name': 'get',
|
|
43095
43017
|
'x-fern-sdk-return-value': 'acs_user',
|
|
43018
|
+
'x-has-required-parameters': true,
|
|
43096
43019
|
'x-response-key': 'acs_user',
|
|
43097
43020
|
'x-title': 'Get an ACS User',
|
|
43098
43021
|
},
|
|
@@ -43373,6 +43296,7 @@ const openapi = {
|
|
|
43373
43296
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
43374
43297
|
'x-fern-sdk-method-name': 'list_accessible_entrances',
|
|
43375
43298
|
'x-fern-sdk-return-value': 'acs_entrances',
|
|
43299
|
+
'x-has-required-parameters': true,
|
|
43376
43300
|
'x-response-key': 'acs_entrances',
|
|
43377
43301
|
'x-title': 'List ACS User-Accessible Entrances',
|
|
43378
43302
|
},
|
|
@@ -43439,6 +43363,7 @@ const openapi = {
|
|
|
43439
43363
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
43440
43364
|
'x-fern-sdk-method-name': 'list_accessible_entrances',
|
|
43441
43365
|
'x-fern-sdk-return-value': 'acs_entrances',
|
|
43366
|
+
'x-has-required-parameters': true,
|
|
43442
43367
|
'x-response-key': 'acs_entrances',
|
|
43443
43368
|
'x-title': 'List ACS User-Accessible Entrances',
|
|
43444
43369
|
},
|
|
@@ -43621,6 +43546,7 @@ const openapi = {
|
|
|
43621
43546
|
tags: ['/acs'],
|
|
43622
43547
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
43623
43548
|
'x-fern-sdk-method-name': 'revoke_access_to_all_entrances',
|
|
43549
|
+
'x-has-required-parameters': true,
|
|
43624
43550
|
'x-response-key': null,
|
|
43625
43551
|
'x-title': 'Revoke ACS User Access to All Entrances',
|
|
43626
43552
|
},
|
|
@@ -43680,6 +43606,7 @@ const openapi = {
|
|
|
43680
43606
|
tags: ['/acs'],
|
|
43681
43607
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
43682
43608
|
'x-fern-sdk-method-name': 'suspend',
|
|
43609
|
+
'x-has-required-parameters': true,
|
|
43683
43610
|
'x-response-key': null,
|
|
43684
43611
|
'x-title': 'Suspend an ACS User',
|
|
43685
43612
|
},
|
|
@@ -44025,6 +43952,7 @@ const openapi = {
|
|
|
44025
43952
|
tags: ['/acs'],
|
|
44026
43953
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
44027
43954
|
'x-fern-sdk-method-name': 'unsuspend',
|
|
43955
|
+
'x-has-required-parameters': true,
|
|
44028
43956
|
'x-response-key': null,
|
|
44029
43957
|
'x-title': 'Unsuspend an ACS User',
|
|
44030
43958
|
},
|
|
@@ -44127,6 +44055,7 @@ const openapi = {
|
|
|
44127
44055
|
tags: ['/acs'],
|
|
44128
44056
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
44129
44057
|
'x-fern-sdk-method-name': 'update',
|
|
44058
|
+
'x-has-required-parameters': true,
|
|
44130
44059
|
'x-response-key': null,
|
|
44131
44060
|
'x-title': 'Update an ACS User',
|
|
44132
44061
|
},
|
|
@@ -44227,6 +44156,7 @@ const openapi = {
|
|
|
44227
44156
|
tags: ['/acs'],
|
|
44228
44157
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
44229
44158
|
'x-fern-sdk-method-name': 'update',
|
|
44159
|
+
'x-has-required-parameters': true,
|
|
44230
44160
|
'x-response-key': null,
|
|
44231
44161
|
'x-title': 'Update an ACS User',
|
|
44232
44162
|
},
|
|
@@ -45337,6 +45267,7 @@ const openapi = {
|
|
|
45337
45267
|
tags: ['/client_sessions'],
|
|
45338
45268
|
'x-fern-sdk-group-name': ['client_sessions'],
|
|
45339
45269
|
'x-fern-sdk-method-name': 'grant_access',
|
|
45270
|
+
'x-has-required-parameters': true,
|
|
45340
45271
|
'x-response-key': null,
|
|
45341
45272
|
'x-title': 'Grant Access to a Client Session',
|
|
45342
45273
|
},
|
|
@@ -45415,6 +45346,7 @@ const openapi = {
|
|
|
45415
45346
|
tags: ['/client_sessions'],
|
|
45416
45347
|
'x-fern-sdk-group-name': ['client_sessions'],
|
|
45417
45348
|
'x-fern-sdk-method-name': 'grant_access',
|
|
45349
|
+
'x-has-required-parameters': true,
|
|
45418
45350
|
'x-response-key': null,
|
|
45419
45351
|
'x-title': 'Grant Access to a Client Session',
|
|
45420
45352
|
},
|
|
@@ -49572,6 +49504,7 @@ const openapi = {
|
|
|
49572
49504
|
'x-fern-sdk-group-name': ['devices'],
|
|
49573
49505
|
'x-fern-sdk-method-name': 'get',
|
|
49574
49506
|
'x-fern-sdk-return-value': 'device',
|
|
49507
|
+
'x-has-required-parameters': true,
|
|
49575
49508
|
'x-response-key': 'device',
|
|
49576
49509
|
'x-title': 'Get a Device',
|
|
49577
49510
|
},
|
|
@@ -49631,6 +49564,7 @@ const openapi = {
|
|
|
49631
49564
|
'x-fern-sdk-group-name': ['devices'],
|
|
49632
49565
|
'x-fern-sdk-method-name': 'get',
|
|
49633
49566
|
'x-fern-sdk-return-value': 'device',
|
|
49567
|
+
'x-has-required-parameters': true,
|
|
49634
49568
|
'x-response-key': 'device',
|
|
49635
49569
|
'x-title': 'Get a Device',
|
|
49636
49570
|
},
|
|
@@ -52343,6 +52277,7 @@ const openapi = {
|
|
|
52343
52277
|
'x-fern-sdk-group-name': ['devices', 'unmanaged'],
|
|
52344
52278
|
'x-fern-sdk-method-name': 'get',
|
|
52345
52279
|
'x-fern-sdk-return-value': 'device',
|
|
52280
|
+
'x-has-required-parameters': true,
|
|
52346
52281
|
'x-response-key': 'device',
|
|
52347
52282
|
'x-title': 'Get an Unmanaged Device',
|
|
52348
52283
|
},
|
|
@@ -52400,6 +52335,7 @@ const openapi = {
|
|
|
52400
52335
|
'x-fern-sdk-group-name': ['devices', 'unmanaged'],
|
|
52401
52336
|
'x-fern-sdk-method-name': 'get',
|
|
52402
52337
|
'x-fern-sdk-return-value': 'device',
|
|
52338
|
+
'x-has-required-parameters': true,
|
|
52403
52339
|
'x-response-key': 'device',
|
|
52404
52340
|
'x-title': 'Get an Unmanaged Device',
|
|
52405
52341
|
},
|
|
@@ -52680,25 +52616,6 @@ const openapi = {
|
|
|
52680
52616
|
type: 'string',
|
|
52681
52617
|
},
|
|
52682
52618
|
},
|
|
52683
|
-
{
|
|
52684
|
-
in: 'query',
|
|
52685
|
-
name: 'user_identifier_key',
|
|
52686
|
-
schema: {
|
|
52687
|
-
description: 'Your own internal user ID for the user for which you want to list devices.',
|
|
52688
|
-
type: 'string',
|
|
52689
|
-
},
|
|
52690
|
-
},
|
|
52691
|
-
{
|
|
52692
|
-
in: 'query',
|
|
52693
|
-
name: 'custom_metadata_has',
|
|
52694
|
-
schema: {
|
|
52695
|
-
additionalProperties: {
|
|
52696
|
-
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
52697
|
-
},
|
|
52698
|
-
description: '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.',
|
|
52699
|
-
type: 'object',
|
|
52700
|
-
},
|
|
52701
|
-
},
|
|
52702
52619
|
{
|
|
52703
52620
|
in: 'query',
|
|
52704
52621
|
name: 'page_cursor',
|
|
@@ -52774,26 +52691,6 @@ const openapi = {
|
|
|
52774
52691
|
'x-undocumented': 'Only used internally.',
|
|
52775
52692
|
},
|
|
52776
52693
|
},
|
|
52777
|
-
{
|
|
52778
|
-
in: 'query',
|
|
52779
|
-
name: 'unstable_location_id',
|
|
52780
|
-
schema: {
|
|
52781
|
-
deprecated: true,
|
|
52782
|
-
format: 'uuid',
|
|
52783
|
-
nullable: true,
|
|
52784
|
-
type: 'string',
|
|
52785
|
-
'x-deprecated': 'Use `space_id`.',
|
|
52786
|
-
},
|
|
52787
|
-
},
|
|
52788
|
-
{
|
|
52789
|
-
in: 'query',
|
|
52790
|
-
name: 'space_id',
|
|
52791
|
-
schema: {
|
|
52792
|
-
description: 'ID of the space for which you want to list devices.',
|
|
52793
|
-
format: 'uuid',
|
|
52794
|
-
type: 'string',
|
|
52795
|
-
},
|
|
52796
|
-
},
|
|
52797
52694
|
{
|
|
52798
52695
|
in: 'query',
|
|
52799
52696
|
name: 'search',
|
|
@@ -52881,13 +52778,6 @@ const openapi = {
|
|
|
52881
52778
|
format: 'date-time',
|
|
52882
52779
|
type: 'string',
|
|
52883
52780
|
},
|
|
52884
|
-
custom_metadata_has: {
|
|
52885
|
-
additionalProperties: {
|
|
52886
|
-
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
52887
|
-
},
|
|
52888
|
-
description: '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.',
|
|
52889
|
-
type: 'object',
|
|
52890
|
-
},
|
|
52891
52781
|
customer_key: {
|
|
52892
52782
|
description: 'Customer key for which you want to list devices.',
|
|
52893
52783
|
type: 'string',
|
|
@@ -53177,22 +53067,6 @@ const openapi = {
|
|
|
53177
53067
|
minLength: 1,
|
|
53178
53068
|
type: 'string',
|
|
53179
53069
|
},
|
|
53180
|
-
space_id: {
|
|
53181
|
-
description: 'ID of the space for which you want to list devices.',
|
|
53182
|
-
format: 'uuid',
|
|
53183
|
-
type: 'string',
|
|
53184
|
-
},
|
|
53185
|
-
unstable_location_id: {
|
|
53186
|
-
deprecated: true,
|
|
53187
|
-
format: 'uuid',
|
|
53188
|
-
nullable: true,
|
|
53189
|
-
type: 'string',
|
|
53190
|
-
'x-deprecated': 'Use `space_id`.',
|
|
53191
|
-
},
|
|
53192
|
-
user_identifier_key: {
|
|
53193
|
-
description: 'Your own internal user ID for the user for which you want to list devices.',
|
|
53194
|
-
type: 'string',
|
|
53195
|
-
},
|
|
53196
53070
|
},
|
|
53197
53071
|
type: 'object',
|
|
53198
53072
|
},
|
|
@@ -53607,6 +53481,7 @@ const openapi = {
|
|
|
53607
53481
|
'x-fern-sdk-group-name': ['events'],
|
|
53608
53482
|
'x-fern-sdk-method-name': 'get',
|
|
53609
53483
|
'x-fern-sdk-return-value': 'event',
|
|
53484
|
+
'x-has-required-parameters': true,
|
|
53610
53485
|
'x-response-key': 'event',
|
|
53611
53486
|
'x-title': 'Get an Event',
|
|
53612
53487
|
},
|
|
@@ -53672,6 +53547,7 @@ const openapi = {
|
|
|
53672
53547
|
'x-fern-sdk-group-name': ['events'],
|
|
53673
53548
|
'x-fern-sdk-method-name': 'get',
|
|
53674
53549
|
'x-fern-sdk-return-value': 'event',
|
|
53550
|
+
'x-has-required-parameters': true,
|
|
53675
53551
|
'x-response-key': 'event',
|
|
53676
53552
|
'x-title': 'Get an Event',
|
|
53677
53553
|
},
|
|
@@ -54202,6 +54078,7 @@ const openapi = {
|
|
|
54202
54078
|
'x-fern-sdk-group-name': ['events'],
|
|
54203
54079
|
'x-fern-sdk-method-name': 'list',
|
|
54204
54080
|
'x-fern-sdk-return-value': 'events',
|
|
54081
|
+
'x-has-required-parameters': true,
|
|
54205
54082
|
'x-response-key': 'events',
|
|
54206
54083
|
'x-title': 'List Events',
|
|
54207
54084
|
},
|
|
@@ -54627,6 +54504,7 @@ const openapi = {
|
|
|
54627
54504
|
'x-fern-sdk-group-name': ['events'],
|
|
54628
54505
|
'x-fern-sdk-method-name': 'list',
|
|
54629
54506
|
'x-fern-sdk-return-value': 'events',
|
|
54507
|
+
'x-has-required-parameters': true,
|
|
54630
54508
|
'x-response-key': 'events',
|
|
54631
54509
|
'x-title': 'List Events',
|
|
54632
54510
|
},
|
|
@@ -54778,6 +54656,7 @@ const openapi = {
|
|
|
54778
54656
|
'x-fern-sdk-group-name': ['instant_keys'],
|
|
54779
54657
|
'x-fern-sdk-method-name': 'get',
|
|
54780
54658
|
'x-fern-sdk-return-value': 'instant_key',
|
|
54659
|
+
'x-has-required-parameters': true,
|
|
54781
54660
|
'x-response-key': 'instant_key',
|
|
54782
54661
|
'x-title': 'Get an Instant Key',
|
|
54783
54662
|
},
|
|
@@ -54835,6 +54714,7 @@ const openapi = {
|
|
|
54835
54714
|
'x-fern-sdk-group-name': ['instant_keys'],
|
|
54836
54715
|
'x-fern-sdk-method-name': 'get',
|
|
54837
54716
|
'x-fern-sdk-return-value': 'instant_key',
|
|
54717
|
+
'x-has-required-parameters': true,
|
|
54838
54718
|
'x-response-key': 'instant_key',
|
|
54839
54719
|
'x-title': 'Get an Instant Key',
|
|
54840
54720
|
},
|
|
@@ -55071,6 +54951,7 @@ const openapi = {
|
|
|
55071
54951
|
'x-fern-sdk-group-name': ['locks'],
|
|
55072
54952
|
'x-fern-sdk-method-name': 'get',
|
|
55073
54953
|
'x-fern-sdk-return-value': 'device',
|
|
54954
|
+
'x-has-required-parameters': true,
|
|
55074
54955
|
'x-response-key': 'device',
|
|
55075
54956
|
'x-title': 'Get a Lock',
|
|
55076
54957
|
},
|
|
@@ -55130,6 +55011,7 @@ const openapi = {
|
|
|
55130
55011
|
'x-fern-sdk-group-name': ['locks'],
|
|
55131
55012
|
'x-fern-sdk-method-name': 'get',
|
|
55132
55013
|
'x-fern-sdk-return-value': 'device',
|
|
55014
|
+
'x-has-required-parameters': true,
|
|
55133
55015
|
'x-response-key': 'device',
|
|
55134
55016
|
'x-title': 'Get a Lock',
|
|
55135
55017
|
},
|
|
@@ -55156,15 +55038,6 @@ const openapi = {
|
|
|
55156
55038
|
type: 'string',
|
|
55157
55039
|
},
|
|
55158
55040
|
},
|
|
55159
|
-
{
|
|
55160
|
-
in: 'query',
|
|
55161
|
-
name: 'connected_account_ids',
|
|
55162
|
-
schema: {
|
|
55163
|
-
description: 'Array of IDs of the connected accounts for which you want to list devices.',
|
|
55164
|
-
items: { format: 'uuid', type: 'string' },
|
|
55165
|
-
type: 'array',
|
|
55166
|
-
},
|
|
55167
|
-
},
|
|
55168
55041
|
{
|
|
55169
55042
|
in: 'query',
|
|
55170
55043
|
name: 'connect_webview_id',
|
|
@@ -55300,157 +55173,6 @@ const openapi = {
|
|
|
55300
55173
|
type: 'string',
|
|
55301
55174
|
},
|
|
55302
55175
|
},
|
|
55303
|
-
{
|
|
55304
|
-
in: 'query',
|
|
55305
|
-
name: 'device_ids',
|
|
55306
|
-
schema: {
|
|
55307
|
-
description: 'Array of device IDs for which you want to list devices.',
|
|
55308
|
-
items: { format: 'uuid', type: 'string' },
|
|
55309
|
-
type: 'array',
|
|
55310
|
-
},
|
|
55311
|
-
},
|
|
55312
|
-
{
|
|
55313
|
-
in: 'query',
|
|
55314
|
-
name: 'limit',
|
|
55315
|
-
schema: {
|
|
55316
|
-
default: 500,
|
|
55317
|
-
description: 'Numerical limit on the number of devices to return.',
|
|
55318
|
-
format: 'float',
|
|
55319
|
-
type: 'number',
|
|
55320
|
-
},
|
|
55321
|
-
},
|
|
55322
|
-
{
|
|
55323
|
-
in: 'query',
|
|
55324
|
-
name: 'created_before',
|
|
55325
|
-
schema: {
|
|
55326
|
-
description: 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
55327
|
-
format: 'date-time',
|
|
55328
|
-
type: 'string',
|
|
55329
|
-
},
|
|
55330
|
-
},
|
|
55331
|
-
{
|
|
55332
|
-
in: 'query',
|
|
55333
|
-
name: 'user_identifier_key',
|
|
55334
|
-
schema: {
|
|
55335
|
-
description: 'Your own internal user ID for the user for which you want to list devices.',
|
|
55336
|
-
type: 'string',
|
|
55337
|
-
},
|
|
55338
|
-
},
|
|
55339
|
-
{
|
|
55340
|
-
in: 'query',
|
|
55341
|
-
name: 'custom_metadata_has',
|
|
55342
|
-
schema: {
|
|
55343
|
-
additionalProperties: {
|
|
55344
|
-
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
55345
|
-
},
|
|
55346
|
-
description: '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.',
|
|
55347
|
-
type: 'object',
|
|
55348
|
-
},
|
|
55349
|
-
},
|
|
55350
|
-
{
|
|
55351
|
-
in: 'query',
|
|
55352
|
-
name: 'page_cursor',
|
|
55353
|
-
schema: {
|
|
55354
|
-
description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
55355
|
-
nullable: true,
|
|
55356
|
-
type: 'string',
|
|
55357
|
-
},
|
|
55358
|
-
},
|
|
55359
|
-
{
|
|
55360
|
-
in: 'query',
|
|
55361
|
-
name: 'include_if',
|
|
55362
|
-
schema: {
|
|
55363
|
-
items: {
|
|
55364
|
-
enum: [
|
|
55365
|
-
'can_remotely_unlock',
|
|
55366
|
-
'can_remotely_lock',
|
|
55367
|
-
'can_program_offline_access_codes',
|
|
55368
|
-
'can_program_online_access_codes',
|
|
55369
|
-
'can_hvac_heat',
|
|
55370
|
-
'can_hvac_cool',
|
|
55371
|
-
'can_hvac_heat_cool',
|
|
55372
|
-
'can_turn_off_hvac',
|
|
55373
|
-
'can_simulate_removal',
|
|
55374
|
-
'can_simulate_connection',
|
|
55375
|
-
'can_simulate_disconnection',
|
|
55376
|
-
'can_unlock_with_code',
|
|
55377
|
-
'can_run_thermostat_programs',
|
|
55378
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
55379
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
55380
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
55381
|
-
'can_simulate_hub_connection',
|
|
55382
|
-
'can_simulate_hub_disconnection',
|
|
55383
|
-
'can_simulate_paid_subscription',
|
|
55384
|
-
'can_configure_auto_lock',
|
|
55385
|
-
],
|
|
55386
|
-
type: 'string',
|
|
55387
|
-
},
|
|
55388
|
-
type: 'array',
|
|
55389
|
-
'x-undocumented': 'Only used internally.',
|
|
55390
|
-
},
|
|
55391
|
-
},
|
|
55392
|
-
{
|
|
55393
|
-
in: 'query',
|
|
55394
|
-
name: 'exclude_if',
|
|
55395
|
-
schema: {
|
|
55396
|
-
items: {
|
|
55397
|
-
enum: [
|
|
55398
|
-
'can_remotely_unlock',
|
|
55399
|
-
'can_remotely_lock',
|
|
55400
|
-
'can_program_offline_access_codes',
|
|
55401
|
-
'can_program_online_access_codes',
|
|
55402
|
-
'can_hvac_heat',
|
|
55403
|
-
'can_hvac_cool',
|
|
55404
|
-
'can_hvac_heat_cool',
|
|
55405
|
-
'can_turn_off_hvac',
|
|
55406
|
-
'can_simulate_removal',
|
|
55407
|
-
'can_simulate_connection',
|
|
55408
|
-
'can_simulate_disconnection',
|
|
55409
|
-
'can_unlock_with_code',
|
|
55410
|
-
'can_run_thermostat_programs',
|
|
55411
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
55412
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
55413
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
55414
|
-
'can_simulate_hub_connection',
|
|
55415
|
-
'can_simulate_hub_disconnection',
|
|
55416
|
-
'can_simulate_paid_subscription',
|
|
55417
|
-
'can_configure_auto_lock',
|
|
55418
|
-
],
|
|
55419
|
-
type: 'string',
|
|
55420
|
-
},
|
|
55421
|
-
type: 'array',
|
|
55422
|
-
'x-undocumented': 'Only used internally.',
|
|
55423
|
-
},
|
|
55424
|
-
},
|
|
55425
|
-
{
|
|
55426
|
-
in: 'query',
|
|
55427
|
-
name: 'unstable_location_id',
|
|
55428
|
-
schema: {
|
|
55429
|
-
deprecated: true,
|
|
55430
|
-
format: 'uuid',
|
|
55431
|
-
nullable: true,
|
|
55432
|
-
type: 'string',
|
|
55433
|
-
'x-deprecated': 'Use `space_id`.',
|
|
55434
|
-
},
|
|
55435
|
-
},
|
|
55436
|
-
{
|
|
55437
|
-
in: 'query',
|
|
55438
|
-
name: 'space_id',
|
|
55439
|
-
schema: {
|
|
55440
|
-
description: 'ID of the space for which you want to list devices.',
|
|
55441
|
-
format: 'uuid',
|
|
55442
|
-
type: 'string',
|
|
55443
|
-
},
|
|
55444
|
-
},
|
|
55445
|
-
{
|
|
55446
|
-
in: 'query',
|
|
55447
|
-
name: 'search',
|
|
55448
|
-
schema: {
|
|
55449
|
-
description: '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`.',
|
|
55450
|
-
minLength: 1,
|
|
55451
|
-
type: 'string',
|
|
55452
|
-
},
|
|
55453
|
-
},
|
|
55454
55176
|
],
|
|
55455
55177
|
responses: {
|
|
55456
55178
|
200: {
|
|
@@ -55511,32 +55233,10 @@ const openapi = {
|
|
|
55511
55233
|
format: 'uuid',
|
|
55512
55234
|
type: 'string',
|
|
55513
55235
|
},
|
|
55514
|
-
connected_account_ids: {
|
|
55515
|
-
description: 'Array of IDs of the connected accounts for which you want to list devices.',
|
|
55516
|
-
items: { format: 'uuid', type: 'string' },
|
|
55517
|
-
type: 'array',
|
|
55518
|
-
},
|
|
55519
|
-
created_before: {
|
|
55520
|
-
description: 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
55521
|
-
format: 'date-time',
|
|
55522
|
-
type: 'string',
|
|
55523
|
-
},
|
|
55524
|
-
custom_metadata_has: {
|
|
55525
|
-
additionalProperties: {
|
|
55526
|
-
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
55527
|
-
},
|
|
55528
|
-
description: '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.',
|
|
55529
|
-
type: 'object',
|
|
55530
|
-
},
|
|
55531
55236
|
customer_key: {
|
|
55532
55237
|
description: 'Customer key for which you want to list devices.',
|
|
55533
55238
|
type: 'string',
|
|
55534
55239
|
},
|
|
55535
|
-
device_ids: {
|
|
55536
|
-
description: 'Array of device IDs for which you want to list devices.',
|
|
55537
|
-
items: { format: 'uuid', type: 'string' },
|
|
55538
|
-
type: 'array',
|
|
55539
|
-
},
|
|
55540
55240
|
device_type: {
|
|
55541
55241
|
description: 'Device type of the locks that you want to list.',
|
|
55542
55242
|
enum: [
|
|
@@ -55613,70 +55313,6 @@ const openapi = {
|
|
|
55613
55313
|
},
|
|
55614
55314
|
type: 'array',
|
|
55615
55315
|
},
|
|
55616
|
-
exclude_if: {
|
|
55617
|
-
items: {
|
|
55618
|
-
enum: [
|
|
55619
|
-
'can_remotely_unlock',
|
|
55620
|
-
'can_remotely_lock',
|
|
55621
|
-
'can_program_offline_access_codes',
|
|
55622
|
-
'can_program_online_access_codes',
|
|
55623
|
-
'can_hvac_heat',
|
|
55624
|
-
'can_hvac_cool',
|
|
55625
|
-
'can_hvac_heat_cool',
|
|
55626
|
-
'can_turn_off_hvac',
|
|
55627
|
-
'can_simulate_removal',
|
|
55628
|
-
'can_simulate_connection',
|
|
55629
|
-
'can_simulate_disconnection',
|
|
55630
|
-
'can_unlock_with_code',
|
|
55631
|
-
'can_run_thermostat_programs',
|
|
55632
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
55633
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
55634
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
55635
|
-
'can_simulate_hub_connection',
|
|
55636
|
-
'can_simulate_hub_disconnection',
|
|
55637
|
-
'can_simulate_paid_subscription',
|
|
55638
|
-
'can_configure_auto_lock',
|
|
55639
|
-
],
|
|
55640
|
-
type: 'string',
|
|
55641
|
-
},
|
|
55642
|
-
type: 'array',
|
|
55643
|
-
'x-undocumented': 'Only used internally.',
|
|
55644
|
-
},
|
|
55645
|
-
include_if: {
|
|
55646
|
-
items: {
|
|
55647
|
-
enum: [
|
|
55648
|
-
'can_remotely_unlock',
|
|
55649
|
-
'can_remotely_lock',
|
|
55650
|
-
'can_program_offline_access_codes',
|
|
55651
|
-
'can_program_online_access_codes',
|
|
55652
|
-
'can_hvac_heat',
|
|
55653
|
-
'can_hvac_cool',
|
|
55654
|
-
'can_hvac_heat_cool',
|
|
55655
|
-
'can_turn_off_hvac',
|
|
55656
|
-
'can_simulate_removal',
|
|
55657
|
-
'can_simulate_connection',
|
|
55658
|
-
'can_simulate_disconnection',
|
|
55659
|
-
'can_unlock_with_code',
|
|
55660
|
-
'can_run_thermostat_programs',
|
|
55661
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
55662
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
55663
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
55664
|
-
'can_simulate_hub_connection',
|
|
55665
|
-
'can_simulate_hub_disconnection',
|
|
55666
|
-
'can_simulate_paid_subscription',
|
|
55667
|
-
'can_configure_auto_lock',
|
|
55668
|
-
],
|
|
55669
|
-
type: 'string',
|
|
55670
|
-
},
|
|
55671
|
-
type: 'array',
|
|
55672
|
-
'x-undocumented': 'Only used internally.',
|
|
55673
|
-
},
|
|
55674
|
-
limit: {
|
|
55675
|
-
default: 500,
|
|
55676
|
-
description: 'Numerical limit on the number of devices to return.',
|
|
55677
|
-
format: 'float',
|
|
55678
|
-
type: 'number',
|
|
55679
|
-
},
|
|
55680
55316
|
manufacturer: {
|
|
55681
55317
|
description: 'Manufacturer of the locks that you want to list.',
|
|
55682
55318
|
enum: [
|
|
@@ -55715,32 +55351,6 @@ const openapi = {
|
|
|
55715
55351
|
],
|
|
55716
55352
|
type: 'string',
|
|
55717
55353
|
},
|
|
55718
|
-
page_cursor: {
|
|
55719
|
-
description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
55720
|
-
nullable: true,
|
|
55721
|
-
type: 'string',
|
|
55722
|
-
},
|
|
55723
|
-
search: {
|
|
55724
|
-
description: '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`.',
|
|
55725
|
-
minLength: 1,
|
|
55726
|
-
type: 'string',
|
|
55727
|
-
},
|
|
55728
|
-
space_id: {
|
|
55729
|
-
description: 'ID of the space for which you want to list devices.',
|
|
55730
|
-
format: 'uuid',
|
|
55731
|
-
type: 'string',
|
|
55732
|
-
},
|
|
55733
|
-
unstable_location_id: {
|
|
55734
|
-
deprecated: true,
|
|
55735
|
-
format: 'uuid',
|
|
55736
|
-
nullable: true,
|
|
55737
|
-
type: 'string',
|
|
55738
|
-
'x-deprecated': 'Use `space_id`.',
|
|
55739
|
-
},
|
|
55740
|
-
user_identifier_key: {
|
|
55741
|
-
description: 'Your own internal user ID for the user for which you want to list devices.',
|
|
55742
|
-
type: 'string',
|
|
55743
|
-
},
|
|
55744
55354
|
},
|
|
55745
55355
|
type: 'object',
|
|
55746
55356
|
},
|
|
@@ -56057,15 +55667,6 @@ const openapi = {
|
|
|
56057
55667
|
type: 'string',
|
|
56058
55668
|
},
|
|
56059
55669
|
},
|
|
56060
|
-
{
|
|
56061
|
-
in: 'query',
|
|
56062
|
-
name: 'connected_account_ids',
|
|
56063
|
-
schema: {
|
|
56064
|
-
description: 'Array of IDs of the connected accounts for which you want to list devices.',
|
|
56065
|
-
items: { format: 'uuid', type: 'string' },
|
|
56066
|
-
type: 'array',
|
|
56067
|
-
},
|
|
56068
|
-
},
|
|
56069
55670
|
{
|
|
56070
55671
|
in: 'query',
|
|
56071
55672
|
name: 'connect_webview_id',
|
|
@@ -56106,157 +55707,6 @@ const openapi = {
|
|
|
56106
55707
|
type: 'string',
|
|
56107
55708
|
},
|
|
56108
55709
|
},
|
|
56109
|
-
{
|
|
56110
|
-
in: 'query',
|
|
56111
|
-
name: 'device_ids',
|
|
56112
|
-
schema: {
|
|
56113
|
-
description: 'Array of device IDs for which you want to list devices.',
|
|
56114
|
-
items: { format: 'uuid', type: 'string' },
|
|
56115
|
-
type: 'array',
|
|
56116
|
-
},
|
|
56117
|
-
},
|
|
56118
|
-
{
|
|
56119
|
-
in: 'query',
|
|
56120
|
-
name: 'limit',
|
|
56121
|
-
schema: {
|
|
56122
|
-
default: 500,
|
|
56123
|
-
description: 'Numerical limit on the number of devices to return.',
|
|
56124
|
-
format: 'float',
|
|
56125
|
-
type: 'number',
|
|
56126
|
-
},
|
|
56127
|
-
},
|
|
56128
|
-
{
|
|
56129
|
-
in: 'query',
|
|
56130
|
-
name: 'created_before',
|
|
56131
|
-
schema: {
|
|
56132
|
-
description: 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
56133
|
-
format: 'date-time',
|
|
56134
|
-
type: 'string',
|
|
56135
|
-
},
|
|
56136
|
-
},
|
|
56137
|
-
{
|
|
56138
|
-
in: 'query',
|
|
56139
|
-
name: 'user_identifier_key',
|
|
56140
|
-
schema: {
|
|
56141
|
-
description: 'Your own internal user ID for the user for which you want to list devices.',
|
|
56142
|
-
type: 'string',
|
|
56143
|
-
},
|
|
56144
|
-
},
|
|
56145
|
-
{
|
|
56146
|
-
in: 'query',
|
|
56147
|
-
name: 'custom_metadata_has',
|
|
56148
|
-
schema: {
|
|
56149
|
-
additionalProperties: {
|
|
56150
|
-
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
56151
|
-
},
|
|
56152
|
-
description: '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.',
|
|
56153
|
-
type: 'object',
|
|
56154
|
-
},
|
|
56155
|
-
},
|
|
56156
|
-
{
|
|
56157
|
-
in: 'query',
|
|
56158
|
-
name: 'page_cursor',
|
|
56159
|
-
schema: {
|
|
56160
|
-
description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
56161
|
-
nullable: true,
|
|
56162
|
-
type: 'string',
|
|
56163
|
-
},
|
|
56164
|
-
},
|
|
56165
|
-
{
|
|
56166
|
-
in: 'query',
|
|
56167
|
-
name: 'include_if',
|
|
56168
|
-
schema: {
|
|
56169
|
-
items: {
|
|
56170
|
-
enum: [
|
|
56171
|
-
'can_remotely_unlock',
|
|
56172
|
-
'can_remotely_lock',
|
|
56173
|
-
'can_program_offline_access_codes',
|
|
56174
|
-
'can_program_online_access_codes',
|
|
56175
|
-
'can_hvac_heat',
|
|
56176
|
-
'can_hvac_cool',
|
|
56177
|
-
'can_hvac_heat_cool',
|
|
56178
|
-
'can_turn_off_hvac',
|
|
56179
|
-
'can_simulate_removal',
|
|
56180
|
-
'can_simulate_connection',
|
|
56181
|
-
'can_simulate_disconnection',
|
|
56182
|
-
'can_unlock_with_code',
|
|
56183
|
-
'can_run_thermostat_programs',
|
|
56184
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
56185
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
56186
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
56187
|
-
'can_simulate_hub_connection',
|
|
56188
|
-
'can_simulate_hub_disconnection',
|
|
56189
|
-
'can_simulate_paid_subscription',
|
|
56190
|
-
'can_configure_auto_lock',
|
|
56191
|
-
],
|
|
56192
|
-
type: 'string',
|
|
56193
|
-
},
|
|
56194
|
-
type: 'array',
|
|
56195
|
-
'x-undocumented': 'Only used internally.',
|
|
56196
|
-
},
|
|
56197
|
-
},
|
|
56198
|
-
{
|
|
56199
|
-
in: 'query',
|
|
56200
|
-
name: 'exclude_if',
|
|
56201
|
-
schema: {
|
|
56202
|
-
items: {
|
|
56203
|
-
enum: [
|
|
56204
|
-
'can_remotely_unlock',
|
|
56205
|
-
'can_remotely_lock',
|
|
56206
|
-
'can_program_offline_access_codes',
|
|
56207
|
-
'can_program_online_access_codes',
|
|
56208
|
-
'can_hvac_heat',
|
|
56209
|
-
'can_hvac_cool',
|
|
56210
|
-
'can_hvac_heat_cool',
|
|
56211
|
-
'can_turn_off_hvac',
|
|
56212
|
-
'can_simulate_removal',
|
|
56213
|
-
'can_simulate_connection',
|
|
56214
|
-
'can_simulate_disconnection',
|
|
56215
|
-
'can_unlock_with_code',
|
|
56216
|
-
'can_run_thermostat_programs',
|
|
56217
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
56218
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
56219
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
56220
|
-
'can_simulate_hub_connection',
|
|
56221
|
-
'can_simulate_hub_disconnection',
|
|
56222
|
-
'can_simulate_paid_subscription',
|
|
56223
|
-
'can_configure_auto_lock',
|
|
56224
|
-
],
|
|
56225
|
-
type: 'string',
|
|
56226
|
-
},
|
|
56227
|
-
type: 'array',
|
|
56228
|
-
'x-undocumented': 'Only used internally.',
|
|
56229
|
-
},
|
|
56230
|
-
},
|
|
56231
|
-
{
|
|
56232
|
-
in: 'query',
|
|
56233
|
-
name: 'unstable_location_id',
|
|
56234
|
-
schema: {
|
|
56235
|
-
deprecated: true,
|
|
56236
|
-
format: 'uuid',
|
|
56237
|
-
nullable: true,
|
|
56238
|
-
type: 'string',
|
|
56239
|
-
'x-deprecated': 'Use `space_id`.',
|
|
56240
|
-
},
|
|
56241
|
-
},
|
|
56242
|
-
{
|
|
56243
|
-
in: 'query',
|
|
56244
|
-
name: 'space_id',
|
|
56245
|
-
schema: {
|
|
56246
|
-
description: 'ID of the space for which you want to list devices.',
|
|
56247
|
-
format: 'uuid',
|
|
56248
|
-
type: 'string',
|
|
56249
|
-
},
|
|
56250
|
-
},
|
|
56251
|
-
{
|
|
56252
|
-
in: 'query',
|
|
56253
|
-
name: 'search',
|
|
56254
|
-
schema: {
|
|
56255
|
-
description: '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`.',
|
|
56256
|
-
minLength: 1,
|
|
56257
|
-
type: 'string',
|
|
56258
|
-
},
|
|
56259
|
-
},
|
|
56260
55710
|
],
|
|
56261
55711
|
responses: {
|
|
56262
55712
|
200: {
|
|
@@ -56317,32 +55767,10 @@ const openapi = {
|
|
|
56317
55767
|
format: 'uuid',
|
|
56318
55768
|
type: 'string',
|
|
56319
55769
|
},
|
|
56320
|
-
connected_account_ids: {
|
|
56321
|
-
description: 'Array of IDs of the connected accounts for which you want to list devices.',
|
|
56322
|
-
items: { format: 'uuid', type: 'string' },
|
|
56323
|
-
type: 'array',
|
|
56324
|
-
},
|
|
56325
|
-
created_before: {
|
|
56326
|
-
description: 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
56327
|
-
format: 'date-time',
|
|
56328
|
-
type: 'string',
|
|
56329
|
-
},
|
|
56330
|
-
custom_metadata_has: {
|
|
56331
|
-
additionalProperties: {
|
|
56332
|
-
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
56333
|
-
},
|
|
56334
|
-
description: '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.',
|
|
56335
|
-
type: 'object',
|
|
56336
|
-
},
|
|
56337
55770
|
customer_key: {
|
|
56338
55771
|
description: 'Customer key for which you want to list devices.',
|
|
56339
55772
|
type: 'string',
|
|
56340
55773
|
},
|
|
56341
|
-
device_ids: {
|
|
56342
|
-
description: 'Array of device IDs for which you want to list devices.',
|
|
56343
|
-
items: { format: 'uuid', type: 'string' },
|
|
56344
|
-
type: 'array',
|
|
56345
|
-
},
|
|
56346
55774
|
device_type: {
|
|
56347
55775
|
description: 'Device type of the noise sensors that you want to list.',
|
|
56348
55776
|
enum: ['noiseaware_activity_zone', 'minut_sensor'],
|
|
@@ -56357,101 +55785,11 @@ const openapi = {
|
|
|
56357
55785
|
},
|
|
56358
55786
|
type: 'array',
|
|
56359
55787
|
},
|
|
56360
|
-
exclude_if: {
|
|
56361
|
-
items: {
|
|
56362
|
-
enum: [
|
|
56363
|
-
'can_remotely_unlock',
|
|
56364
|
-
'can_remotely_lock',
|
|
56365
|
-
'can_program_offline_access_codes',
|
|
56366
|
-
'can_program_online_access_codes',
|
|
56367
|
-
'can_hvac_heat',
|
|
56368
|
-
'can_hvac_cool',
|
|
56369
|
-
'can_hvac_heat_cool',
|
|
56370
|
-
'can_turn_off_hvac',
|
|
56371
|
-
'can_simulate_removal',
|
|
56372
|
-
'can_simulate_connection',
|
|
56373
|
-
'can_simulate_disconnection',
|
|
56374
|
-
'can_unlock_with_code',
|
|
56375
|
-
'can_run_thermostat_programs',
|
|
56376
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
56377
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
56378
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
56379
|
-
'can_simulate_hub_connection',
|
|
56380
|
-
'can_simulate_hub_disconnection',
|
|
56381
|
-
'can_simulate_paid_subscription',
|
|
56382
|
-
'can_configure_auto_lock',
|
|
56383
|
-
],
|
|
56384
|
-
type: 'string',
|
|
56385
|
-
},
|
|
56386
|
-
type: 'array',
|
|
56387
|
-
'x-undocumented': 'Only used internally.',
|
|
56388
|
-
},
|
|
56389
|
-
include_if: {
|
|
56390
|
-
items: {
|
|
56391
|
-
enum: [
|
|
56392
|
-
'can_remotely_unlock',
|
|
56393
|
-
'can_remotely_lock',
|
|
56394
|
-
'can_program_offline_access_codes',
|
|
56395
|
-
'can_program_online_access_codes',
|
|
56396
|
-
'can_hvac_heat',
|
|
56397
|
-
'can_hvac_cool',
|
|
56398
|
-
'can_hvac_heat_cool',
|
|
56399
|
-
'can_turn_off_hvac',
|
|
56400
|
-
'can_simulate_removal',
|
|
56401
|
-
'can_simulate_connection',
|
|
56402
|
-
'can_simulate_disconnection',
|
|
56403
|
-
'can_unlock_with_code',
|
|
56404
|
-
'can_run_thermostat_programs',
|
|
56405
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
56406
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
56407
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
56408
|
-
'can_simulate_hub_connection',
|
|
56409
|
-
'can_simulate_hub_disconnection',
|
|
56410
|
-
'can_simulate_paid_subscription',
|
|
56411
|
-
'can_configure_auto_lock',
|
|
56412
|
-
],
|
|
56413
|
-
type: 'string',
|
|
56414
|
-
},
|
|
56415
|
-
type: 'array',
|
|
56416
|
-
'x-undocumented': 'Only used internally.',
|
|
56417
|
-
},
|
|
56418
|
-
limit: {
|
|
56419
|
-
default: 500,
|
|
56420
|
-
description: 'Numerical limit on the number of devices to return.',
|
|
56421
|
-
format: 'float',
|
|
56422
|
-
type: 'number',
|
|
56423
|
-
},
|
|
56424
55788
|
manufacturer: {
|
|
56425
55789
|
description: 'Manufacturers of the noise sensors that you want to list.',
|
|
56426
55790
|
enum: ['minut', 'noiseaware'],
|
|
56427
55791
|
type: 'string',
|
|
56428
55792
|
},
|
|
56429
|
-
page_cursor: {
|
|
56430
|
-
description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
56431
|
-
nullable: true,
|
|
56432
|
-
type: 'string',
|
|
56433
|
-
},
|
|
56434
|
-
search: {
|
|
56435
|
-
description: '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`.',
|
|
56436
|
-
minLength: 1,
|
|
56437
|
-
type: 'string',
|
|
56438
|
-
},
|
|
56439
|
-
space_id: {
|
|
56440
|
-
description: 'ID of the space for which you want to list devices.',
|
|
56441
|
-
format: 'uuid',
|
|
56442
|
-
type: 'string',
|
|
56443
|
-
},
|
|
56444
|
-
unstable_location_id: {
|
|
56445
|
-
deprecated: true,
|
|
56446
|
-
format: 'uuid',
|
|
56447
|
-
nullable: true,
|
|
56448
|
-
type: 'string',
|
|
56449
|
-
'x-deprecated': 'Use `space_id`.',
|
|
56450
|
-
},
|
|
56451
|
-
user_identifier_key: {
|
|
56452
|
-
description: 'Your own internal user ID for the user for which you want to list devices.',
|
|
56453
|
-
type: 'string',
|
|
56454
|
-
},
|
|
56455
55793
|
},
|
|
56456
55794
|
type: 'object',
|
|
56457
55795
|
},
|
|
@@ -69507,6 +68845,7 @@ const openapi = {
|
|
|
69507
68845
|
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'reservations'],
|
|
69508
68846
|
'x-fern-sdk-method-name': 'get',
|
|
69509
68847
|
'x-fern-sdk-return-value': 'reservation',
|
|
68848
|
+
'x-has-required-parameters': true,
|
|
69510
68849
|
'x-response-key': 'reservation',
|
|
69511
68850
|
'x-title': 'Get Reservation for Customer',
|
|
69512
68851
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
@@ -69725,6 +69064,7 @@ const openapi = {
|
|
|
69725
69064
|
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'reservations'],
|
|
69726
69065
|
'x-fern-sdk-method-name': 'get',
|
|
69727
69066
|
'x-fern-sdk-return-value': 'reservation',
|
|
69067
|
+
'x-has-required-parameters': true,
|
|
69728
69068
|
'x-response-key': 'reservation',
|
|
69729
69069
|
'x-title': 'Get Reservation for Customer',
|
|
69730
69070
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
@@ -73931,6 +73271,7 @@ const openapi = {
|
|
|
73931
73271
|
'x-fern-sdk-group-name': ['spaces'],
|
|
73932
73272
|
'x-fern-sdk-method-name': 'get_related',
|
|
73933
73273
|
'x-fern-sdk-return-value': 'batch',
|
|
73274
|
+
'x-has-required-parameters': true,
|
|
73934
73275
|
'x-response-key': 'batch',
|
|
73935
73276
|
'x-title': 'Get related Space resources',
|
|
73936
73277
|
},
|
|
@@ -74058,6 +73399,7 @@ const openapi = {
|
|
|
74058
73399
|
'x-fern-sdk-group-name': ['spaces'],
|
|
74059
73400
|
'x-fern-sdk-method-name': 'get_related',
|
|
74060
73401
|
'x-fern-sdk-return-value': 'batch',
|
|
73402
|
+
'x-has-required-parameters': true,
|
|
74061
73403
|
'x-response-key': 'batch',
|
|
74062
73404
|
'x-title': 'Get related Space resources',
|
|
74063
73405
|
},
|
|
@@ -75585,6 +74927,7 @@ const openapi = {
|
|
|
75585
74927
|
'x-fern-sdk-group-name': ['thermostats'],
|
|
75586
74928
|
'x-fern-sdk-method-name': 'get',
|
|
75587
74929
|
'x-fern-sdk-return-value': 'thermostat',
|
|
74930
|
+
'x-has-required-parameters': true,
|
|
75588
74931
|
'x-response-key': 'thermostat',
|
|
75589
74932
|
'x-title': 'Get a Thermostat',
|
|
75590
74933
|
'x-undocumented': 'Will be removed.',
|
|
@@ -75643,6 +74986,7 @@ const openapi = {
|
|
|
75643
74986
|
'x-fern-sdk-group-name': ['thermostats'],
|
|
75644
74987
|
'x-fern-sdk-method-name': 'get',
|
|
75645
74988
|
'x-fern-sdk-return-value': 'thermostat',
|
|
74989
|
+
'x-has-required-parameters': true,
|
|
75646
74990
|
'x-response-key': 'thermostat',
|
|
75647
74991
|
'x-title': 'Get a Thermostat',
|
|
75648
74992
|
'x-undocumented': 'Will be removed.',
|
|
@@ -75826,15 +75170,6 @@ const openapi = {
|
|
|
75826
75170
|
type: 'string',
|
|
75827
75171
|
},
|
|
75828
75172
|
},
|
|
75829
|
-
{
|
|
75830
|
-
in: 'query',
|
|
75831
|
-
name: 'connected_account_ids',
|
|
75832
|
-
schema: {
|
|
75833
|
-
description: 'Array of IDs of the connected accounts for which you want to list devices.',
|
|
75834
|
-
items: { format: 'uuid', type: 'string' },
|
|
75835
|
-
type: 'array',
|
|
75836
|
-
},
|
|
75837
|
-
},
|
|
75838
75173
|
{
|
|
75839
75174
|
in: 'query',
|
|
75840
75175
|
name: 'connect_webview_id',
|
|
@@ -75896,157 +75231,6 @@ const openapi = {
|
|
|
75896
75231
|
type: 'string',
|
|
75897
75232
|
},
|
|
75898
75233
|
},
|
|
75899
|
-
{
|
|
75900
|
-
in: 'query',
|
|
75901
|
-
name: 'device_ids',
|
|
75902
|
-
schema: {
|
|
75903
|
-
description: 'Array of device IDs for which you want to list devices.',
|
|
75904
|
-
items: { format: 'uuid', type: 'string' },
|
|
75905
|
-
type: 'array',
|
|
75906
|
-
},
|
|
75907
|
-
},
|
|
75908
|
-
{
|
|
75909
|
-
in: 'query',
|
|
75910
|
-
name: 'limit',
|
|
75911
|
-
schema: {
|
|
75912
|
-
default: 500,
|
|
75913
|
-
description: 'Numerical limit on the number of devices to return.',
|
|
75914
|
-
format: 'float',
|
|
75915
|
-
type: 'number',
|
|
75916
|
-
},
|
|
75917
|
-
},
|
|
75918
|
-
{
|
|
75919
|
-
in: 'query',
|
|
75920
|
-
name: 'created_before',
|
|
75921
|
-
schema: {
|
|
75922
|
-
description: 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
75923
|
-
format: 'date-time',
|
|
75924
|
-
type: 'string',
|
|
75925
|
-
},
|
|
75926
|
-
},
|
|
75927
|
-
{
|
|
75928
|
-
in: 'query',
|
|
75929
|
-
name: 'user_identifier_key',
|
|
75930
|
-
schema: {
|
|
75931
|
-
description: 'Your own internal user ID for the user for which you want to list devices.',
|
|
75932
|
-
type: 'string',
|
|
75933
|
-
},
|
|
75934
|
-
},
|
|
75935
|
-
{
|
|
75936
|
-
in: 'query',
|
|
75937
|
-
name: 'custom_metadata_has',
|
|
75938
|
-
schema: {
|
|
75939
|
-
additionalProperties: {
|
|
75940
|
-
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
75941
|
-
},
|
|
75942
|
-
description: '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.',
|
|
75943
|
-
type: 'object',
|
|
75944
|
-
},
|
|
75945
|
-
},
|
|
75946
|
-
{
|
|
75947
|
-
in: 'query',
|
|
75948
|
-
name: 'page_cursor',
|
|
75949
|
-
schema: {
|
|
75950
|
-
description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
75951
|
-
nullable: true,
|
|
75952
|
-
type: 'string',
|
|
75953
|
-
},
|
|
75954
|
-
},
|
|
75955
|
-
{
|
|
75956
|
-
in: 'query',
|
|
75957
|
-
name: 'include_if',
|
|
75958
|
-
schema: {
|
|
75959
|
-
items: {
|
|
75960
|
-
enum: [
|
|
75961
|
-
'can_remotely_unlock',
|
|
75962
|
-
'can_remotely_lock',
|
|
75963
|
-
'can_program_offline_access_codes',
|
|
75964
|
-
'can_program_online_access_codes',
|
|
75965
|
-
'can_hvac_heat',
|
|
75966
|
-
'can_hvac_cool',
|
|
75967
|
-
'can_hvac_heat_cool',
|
|
75968
|
-
'can_turn_off_hvac',
|
|
75969
|
-
'can_simulate_removal',
|
|
75970
|
-
'can_simulate_connection',
|
|
75971
|
-
'can_simulate_disconnection',
|
|
75972
|
-
'can_unlock_with_code',
|
|
75973
|
-
'can_run_thermostat_programs',
|
|
75974
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
75975
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
75976
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
75977
|
-
'can_simulate_hub_connection',
|
|
75978
|
-
'can_simulate_hub_disconnection',
|
|
75979
|
-
'can_simulate_paid_subscription',
|
|
75980
|
-
'can_configure_auto_lock',
|
|
75981
|
-
],
|
|
75982
|
-
type: 'string',
|
|
75983
|
-
},
|
|
75984
|
-
type: 'array',
|
|
75985
|
-
'x-undocumented': 'Only used internally.',
|
|
75986
|
-
},
|
|
75987
|
-
},
|
|
75988
|
-
{
|
|
75989
|
-
in: 'query',
|
|
75990
|
-
name: 'exclude_if',
|
|
75991
|
-
schema: {
|
|
75992
|
-
items: {
|
|
75993
|
-
enum: [
|
|
75994
|
-
'can_remotely_unlock',
|
|
75995
|
-
'can_remotely_lock',
|
|
75996
|
-
'can_program_offline_access_codes',
|
|
75997
|
-
'can_program_online_access_codes',
|
|
75998
|
-
'can_hvac_heat',
|
|
75999
|
-
'can_hvac_cool',
|
|
76000
|
-
'can_hvac_heat_cool',
|
|
76001
|
-
'can_turn_off_hvac',
|
|
76002
|
-
'can_simulate_removal',
|
|
76003
|
-
'can_simulate_connection',
|
|
76004
|
-
'can_simulate_disconnection',
|
|
76005
|
-
'can_unlock_with_code',
|
|
76006
|
-
'can_run_thermostat_programs',
|
|
76007
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
76008
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
76009
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
76010
|
-
'can_simulate_hub_connection',
|
|
76011
|
-
'can_simulate_hub_disconnection',
|
|
76012
|
-
'can_simulate_paid_subscription',
|
|
76013
|
-
'can_configure_auto_lock',
|
|
76014
|
-
],
|
|
76015
|
-
type: 'string',
|
|
76016
|
-
},
|
|
76017
|
-
type: 'array',
|
|
76018
|
-
'x-undocumented': 'Only used internally.',
|
|
76019
|
-
},
|
|
76020
|
-
},
|
|
76021
|
-
{
|
|
76022
|
-
in: 'query',
|
|
76023
|
-
name: 'unstable_location_id',
|
|
76024
|
-
schema: {
|
|
76025
|
-
deprecated: true,
|
|
76026
|
-
format: 'uuid',
|
|
76027
|
-
nullable: true,
|
|
76028
|
-
type: 'string',
|
|
76029
|
-
'x-deprecated': 'Use `space_id`.',
|
|
76030
|
-
},
|
|
76031
|
-
},
|
|
76032
|
-
{
|
|
76033
|
-
in: 'query',
|
|
76034
|
-
name: 'space_id',
|
|
76035
|
-
schema: {
|
|
76036
|
-
description: 'ID of the space for which you want to list devices.',
|
|
76037
|
-
format: 'uuid',
|
|
76038
|
-
type: 'string',
|
|
76039
|
-
},
|
|
76040
|
-
},
|
|
76041
|
-
{
|
|
76042
|
-
in: 'query',
|
|
76043
|
-
name: 'search',
|
|
76044
|
-
schema: {
|
|
76045
|
-
description: '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`.',
|
|
76046
|
-
minLength: 1,
|
|
76047
|
-
type: 'string',
|
|
76048
|
-
},
|
|
76049
|
-
},
|
|
76050
75234
|
],
|
|
76051
75235
|
responses: {
|
|
76052
75236
|
200: {
|
|
@@ -76107,32 +75291,10 @@ const openapi = {
|
|
|
76107
75291
|
format: 'uuid',
|
|
76108
75292
|
type: 'string',
|
|
76109
75293
|
},
|
|
76110
|
-
connected_account_ids: {
|
|
76111
|
-
description: 'Array of IDs of the connected accounts for which you want to list devices.',
|
|
76112
|
-
items: { format: 'uuid', type: 'string' },
|
|
76113
|
-
type: 'array',
|
|
76114
|
-
},
|
|
76115
|
-
created_before: {
|
|
76116
|
-
description: 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
76117
|
-
format: 'date-time',
|
|
76118
|
-
type: 'string',
|
|
76119
|
-
},
|
|
76120
|
-
custom_metadata_has: {
|
|
76121
|
-
additionalProperties: {
|
|
76122
|
-
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
76123
|
-
},
|
|
76124
|
-
description: '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.',
|
|
76125
|
-
type: 'object',
|
|
76126
|
-
},
|
|
76127
75294
|
customer_key: {
|
|
76128
75295
|
description: 'Customer key for which you want to list devices.',
|
|
76129
75296
|
type: 'string',
|
|
76130
75297
|
},
|
|
76131
|
-
device_ids: {
|
|
76132
|
-
description: 'Array of device IDs for which you want to list devices.',
|
|
76133
|
-
items: { format: 'uuid', type: 'string' },
|
|
76134
|
-
type: 'array',
|
|
76135
|
-
},
|
|
76136
75298
|
device_type: {
|
|
76137
75299
|
description: 'Device type by which you want to filter thermostat devices.',
|
|
76138
75300
|
enum: [
|
|
@@ -76161,70 +75323,6 @@ const openapi = {
|
|
|
76161
75323
|
},
|
|
76162
75324
|
type: 'array',
|
|
76163
75325
|
},
|
|
76164
|
-
exclude_if: {
|
|
76165
|
-
items: {
|
|
76166
|
-
enum: [
|
|
76167
|
-
'can_remotely_unlock',
|
|
76168
|
-
'can_remotely_lock',
|
|
76169
|
-
'can_program_offline_access_codes',
|
|
76170
|
-
'can_program_online_access_codes',
|
|
76171
|
-
'can_hvac_heat',
|
|
76172
|
-
'can_hvac_cool',
|
|
76173
|
-
'can_hvac_heat_cool',
|
|
76174
|
-
'can_turn_off_hvac',
|
|
76175
|
-
'can_simulate_removal',
|
|
76176
|
-
'can_simulate_connection',
|
|
76177
|
-
'can_simulate_disconnection',
|
|
76178
|
-
'can_unlock_with_code',
|
|
76179
|
-
'can_run_thermostat_programs',
|
|
76180
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
76181
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
76182
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
76183
|
-
'can_simulate_hub_connection',
|
|
76184
|
-
'can_simulate_hub_disconnection',
|
|
76185
|
-
'can_simulate_paid_subscription',
|
|
76186
|
-
'can_configure_auto_lock',
|
|
76187
|
-
],
|
|
76188
|
-
type: 'string',
|
|
76189
|
-
},
|
|
76190
|
-
type: 'array',
|
|
76191
|
-
'x-undocumented': 'Only used internally.',
|
|
76192
|
-
},
|
|
76193
|
-
include_if: {
|
|
76194
|
-
items: {
|
|
76195
|
-
enum: [
|
|
76196
|
-
'can_remotely_unlock',
|
|
76197
|
-
'can_remotely_lock',
|
|
76198
|
-
'can_program_offline_access_codes',
|
|
76199
|
-
'can_program_online_access_codes',
|
|
76200
|
-
'can_hvac_heat',
|
|
76201
|
-
'can_hvac_cool',
|
|
76202
|
-
'can_hvac_heat_cool',
|
|
76203
|
-
'can_turn_off_hvac',
|
|
76204
|
-
'can_simulate_removal',
|
|
76205
|
-
'can_simulate_connection',
|
|
76206
|
-
'can_simulate_disconnection',
|
|
76207
|
-
'can_unlock_with_code',
|
|
76208
|
-
'can_run_thermostat_programs',
|
|
76209
|
-
'can_program_thermostat_programs_as_weekday_weekend',
|
|
76210
|
-
'can_program_thermostat_programs_as_different_each_day',
|
|
76211
|
-
'can_program_thermostat_programs_as_same_each_day',
|
|
76212
|
-
'can_simulate_hub_connection',
|
|
76213
|
-
'can_simulate_hub_disconnection',
|
|
76214
|
-
'can_simulate_paid_subscription',
|
|
76215
|
-
'can_configure_auto_lock',
|
|
76216
|
-
],
|
|
76217
|
-
type: 'string',
|
|
76218
|
-
},
|
|
76219
|
-
type: 'array',
|
|
76220
|
-
'x-undocumented': 'Only used internally.',
|
|
76221
|
-
},
|
|
76222
|
-
limit: {
|
|
76223
|
-
default: 500,
|
|
76224
|
-
description: 'Numerical limit on the number of devices to return.',
|
|
76225
|
-
format: 'float',
|
|
76226
|
-
type: 'number',
|
|
76227
|
-
},
|
|
76228
75326
|
manufacturer: {
|
|
76229
75327
|
description: 'Manufacturer by which you want to filter thermostat devices.',
|
|
76230
75328
|
enum: [
|
|
@@ -76237,32 +75335,6 @@ const openapi = {
|
|
|
76237
75335
|
],
|
|
76238
75336
|
type: 'string',
|
|
76239
75337
|
},
|
|
76240
|
-
page_cursor: {
|
|
76241
|
-
description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
76242
|
-
nullable: true,
|
|
76243
|
-
type: 'string',
|
|
76244
|
-
},
|
|
76245
|
-
search: {
|
|
76246
|
-
description: '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`.',
|
|
76247
|
-
minLength: 1,
|
|
76248
|
-
type: 'string',
|
|
76249
|
-
},
|
|
76250
|
-
space_id: {
|
|
76251
|
-
description: 'ID of the space for which you want to list devices.',
|
|
76252
|
-
format: 'uuid',
|
|
76253
|
-
type: 'string',
|
|
76254
|
-
},
|
|
76255
|
-
unstable_location_id: {
|
|
76256
|
-
deprecated: true,
|
|
76257
|
-
format: 'uuid',
|
|
76258
|
-
nullable: true,
|
|
76259
|
-
type: 'string',
|
|
76260
|
-
'x-deprecated': 'Use `space_id`.',
|
|
76261
|
-
},
|
|
76262
|
-
user_identifier_key: {
|
|
76263
|
-
description: 'Your own internal user ID for the user for which you want to list devices.',
|
|
76264
|
-
type: 'string',
|
|
76265
|
-
},
|
|
76266
75338
|
},
|
|
76267
75339
|
type: 'object',
|
|
76268
75340
|
},
|