@seamapi/types 1.288.2 → 1.289.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +119 -53
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +219 -165
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +18 -18
- package/lib/seam/connect/models/action-attempts/action-attempt.js +4 -4
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/{encode-card.d.ts → encode-credential.d.ts} +11 -11
- package/lib/seam/connect/models/action-attempts/{encode-card.js → encode-credential.js} +6 -6
- package/lib/seam/connect/models/action-attempts/encode-credential.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/{scan-card.d.ts → scan-credential.d.ts} +11 -11
- package/lib/seam/connect/models/action-attempts/{scan-card.js → scan-credential.js} +7 -7
- package/lib/seam/connect/models/action-attempts/scan-credential.js.map +1 -0
- package/lib/seam/connect/openapi.d.ts +36 -2
- package/lib/seam/connect/openapi.js +99 -33
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +165 -145
- package/package.json +1 -1
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +4 -4
- package/src/lib/seam/connect/models/action-attempts/{encode-card.ts → encode-credential.ts} +8 -6
- package/src/lib/seam/connect/models/action-attempts/{scan-card.ts → scan-credential.ts} +9 -7
- package/src/lib/seam/connect/openapi.ts +119 -33
- package/src/lib/seam/connect/route-types.ts +165 -145
- package/lib/seam/connect/models/action-attempts/encode-card.js.map +0 -1
- package/lib/seam/connect/models/action-attempts/scan-card.js.map +0 -1
|
@@ -9064,7 +9064,7 @@ declare const _default: {
|
|
|
9064
9064
|
'x-title': string;
|
|
9065
9065
|
};
|
|
9066
9066
|
};
|
|
9067
|
-
'/acs/encoders/
|
|
9067
|
+
'/acs/encoders/encode_credential': {
|
|
9068
9068
|
post: {
|
|
9069
9069
|
operationId: string;
|
|
9070
9070
|
requestBody: {
|
|
@@ -9073,10 +9073,12 @@ declare const _default: {
|
|
|
9073
9073
|
schema: {
|
|
9074
9074
|
properties: {
|
|
9075
9075
|
acs_credential_id: {
|
|
9076
|
+
description: string;
|
|
9076
9077
|
format: string;
|
|
9077
9078
|
type: string;
|
|
9078
9079
|
};
|
|
9079
9080
|
device_id: {
|
|
9081
|
+
description: string;
|
|
9080
9082
|
format: string;
|
|
9081
9083
|
type: string;
|
|
9082
9084
|
};
|
|
@@ -9260,7 +9262,7 @@ declare const _default: {
|
|
|
9260
9262
|
'x-undocumented': string;
|
|
9261
9263
|
};
|
|
9262
9264
|
};
|
|
9263
|
-
'/acs/encoders/
|
|
9265
|
+
'/acs/encoders/scan_credential': {
|
|
9264
9266
|
post: {
|
|
9265
9267
|
operationId: string;
|
|
9266
9268
|
requestBody: {
|
|
@@ -9269,10 +9271,12 @@ declare const _default: {
|
|
|
9269
9271
|
schema: {
|
|
9270
9272
|
properties: {
|
|
9271
9273
|
acs_system_id: {
|
|
9274
|
+
description: string;
|
|
9272
9275
|
format: string;
|
|
9273
9276
|
type: string;
|
|
9274
9277
|
};
|
|
9275
9278
|
device_id: {
|
|
9279
|
+
description: string;
|
|
9276
9280
|
format: string;
|
|
9277
9281
|
type: string;
|
|
9278
9282
|
};
|
|
@@ -15932,6 +15936,7 @@ declare const _default: {
|
|
|
15932
15936
|
};
|
|
15933
15937
|
'/thermostats/cool': {
|
|
15934
15938
|
post: {
|
|
15939
|
+
description: string;
|
|
15935
15940
|
operationId: string;
|
|
15936
15941
|
requestBody: {
|
|
15937
15942
|
content: {
|
|
@@ -15939,14 +15944,17 @@ declare const _default: {
|
|
|
15939
15944
|
schema: {
|
|
15940
15945
|
properties: {
|
|
15941
15946
|
cooling_set_point_celsius: {
|
|
15947
|
+
description: string;
|
|
15942
15948
|
format: string;
|
|
15943
15949
|
type: string;
|
|
15944
15950
|
};
|
|
15945
15951
|
cooling_set_point_fahrenheit: {
|
|
15952
|
+
description: string;
|
|
15946
15953
|
format: string;
|
|
15947
15954
|
type: string;
|
|
15948
15955
|
};
|
|
15949
15956
|
device_id: {
|
|
15957
|
+
description: string;
|
|
15950
15958
|
format: string;
|
|
15951
15959
|
type: string;
|
|
15952
15960
|
};
|
|
@@ -16015,6 +16023,7 @@ declare const _default: {
|
|
|
16015
16023
|
'x-fern-sdk-method-name': string;
|
|
16016
16024
|
'x-fern-sdk-return-value': string;
|
|
16017
16025
|
'x-response-key': string;
|
|
16026
|
+
'x-title': string;
|
|
16018
16027
|
};
|
|
16019
16028
|
};
|
|
16020
16029
|
'/thermostats/create_climate_preset': {
|
|
@@ -16183,6 +16192,7 @@ declare const _default: {
|
|
|
16183
16192
|
};
|
|
16184
16193
|
'/thermostats/get': {
|
|
16185
16194
|
post: {
|
|
16195
|
+
description: string;
|
|
16186
16196
|
operationId: string;
|
|
16187
16197
|
requestBody: {
|
|
16188
16198
|
content: {
|
|
@@ -16190,10 +16200,12 @@ declare const _default: {
|
|
|
16190
16200
|
schema: {
|
|
16191
16201
|
properties: {
|
|
16192
16202
|
device_id: {
|
|
16203
|
+
description: string;
|
|
16193
16204
|
format: string;
|
|
16194
16205
|
type: string;
|
|
16195
16206
|
};
|
|
16196
16207
|
name: {
|
|
16208
|
+
description: string;
|
|
16197
16209
|
type: string;
|
|
16198
16210
|
};
|
|
16199
16211
|
};
|
|
@@ -16257,10 +16269,12 @@ declare const _default: {
|
|
|
16257
16269
|
'x-fern-sdk-method-name': string;
|
|
16258
16270
|
'x-fern-sdk-return-value': string;
|
|
16259
16271
|
'x-response-key': string;
|
|
16272
|
+
'x-title': string;
|
|
16260
16273
|
};
|
|
16261
16274
|
};
|
|
16262
16275
|
'/thermostats/heat': {
|
|
16263
16276
|
post: {
|
|
16277
|
+
description: string;
|
|
16264
16278
|
operationId: string;
|
|
16265
16279
|
requestBody: {
|
|
16266
16280
|
content: {
|
|
@@ -16268,14 +16282,17 @@ declare const _default: {
|
|
|
16268
16282
|
schema: {
|
|
16269
16283
|
properties: {
|
|
16270
16284
|
device_id: {
|
|
16285
|
+
description: string;
|
|
16271
16286
|
format: string;
|
|
16272
16287
|
type: string;
|
|
16273
16288
|
};
|
|
16274
16289
|
heating_set_point_celsius: {
|
|
16290
|
+
description: string;
|
|
16275
16291
|
format: string;
|
|
16276
16292
|
type: string;
|
|
16277
16293
|
};
|
|
16278
16294
|
heating_set_point_fahrenheit: {
|
|
16295
|
+
description: string;
|
|
16279
16296
|
format: string;
|
|
16280
16297
|
type: string;
|
|
16281
16298
|
};
|
|
@@ -16344,10 +16361,12 @@ declare const _default: {
|
|
|
16344
16361
|
'x-fern-sdk-method-name': string;
|
|
16345
16362
|
'x-fern-sdk-return-value': string;
|
|
16346
16363
|
'x-response-key': string;
|
|
16364
|
+
'x-title': string;
|
|
16347
16365
|
};
|
|
16348
16366
|
};
|
|
16349
16367
|
'/thermostats/heat_cool': {
|
|
16350
16368
|
post: {
|
|
16369
|
+
description: string;
|
|
16351
16370
|
operationId: string;
|
|
16352
16371
|
requestBody: {
|
|
16353
16372
|
content: {
|
|
@@ -16355,22 +16374,27 @@ declare const _default: {
|
|
|
16355
16374
|
schema: {
|
|
16356
16375
|
properties: {
|
|
16357
16376
|
cooling_set_point_celsius: {
|
|
16377
|
+
description: string;
|
|
16358
16378
|
format: string;
|
|
16359
16379
|
type: string;
|
|
16360
16380
|
};
|
|
16361
16381
|
cooling_set_point_fahrenheit: {
|
|
16382
|
+
description: string;
|
|
16362
16383
|
format: string;
|
|
16363
16384
|
type: string;
|
|
16364
16385
|
};
|
|
16365
16386
|
device_id: {
|
|
16387
|
+
description: string;
|
|
16366
16388
|
format: string;
|
|
16367
16389
|
type: string;
|
|
16368
16390
|
};
|
|
16369
16391
|
heating_set_point_celsius: {
|
|
16392
|
+
description: string;
|
|
16370
16393
|
format: string;
|
|
16371
16394
|
type: string;
|
|
16372
16395
|
};
|
|
16373
16396
|
heating_set_point_fahrenheit: {
|
|
16397
|
+
description: string;
|
|
16374
16398
|
format: string;
|
|
16375
16399
|
type: string;
|
|
16376
16400
|
};
|
|
@@ -16439,10 +16463,12 @@ declare const _default: {
|
|
|
16439
16463
|
'x-fern-sdk-method-name': string;
|
|
16440
16464
|
'x-fern-sdk-return-value': string;
|
|
16441
16465
|
'x-response-key': string;
|
|
16466
|
+
'x-title': string;
|
|
16442
16467
|
};
|
|
16443
16468
|
};
|
|
16444
16469
|
'/thermostats/list': {
|
|
16445
16470
|
post: {
|
|
16471
|
+
description: string;
|
|
16446
16472
|
operationId: string;
|
|
16447
16473
|
requestBody: {
|
|
16448
16474
|
content: {
|
|
@@ -16594,10 +16620,12 @@ declare const _default: {
|
|
|
16594
16620
|
'x-fern-sdk-method-name': string;
|
|
16595
16621
|
'x-fern-sdk-return-value': string;
|
|
16596
16622
|
'x-response-key': string;
|
|
16623
|
+
'x-title': string;
|
|
16597
16624
|
};
|
|
16598
16625
|
};
|
|
16599
16626
|
'/thermostats/off': {
|
|
16600
16627
|
post: {
|
|
16628
|
+
description: string;
|
|
16601
16629
|
operationId: string;
|
|
16602
16630
|
requestBody: {
|
|
16603
16631
|
content: {
|
|
@@ -16605,6 +16633,7 @@ declare const _default: {
|
|
|
16605
16633
|
schema: {
|
|
16606
16634
|
properties: {
|
|
16607
16635
|
device_id: {
|
|
16636
|
+
description: string;
|
|
16608
16637
|
format: string;
|
|
16609
16638
|
type: string;
|
|
16610
16639
|
};
|
|
@@ -16673,6 +16702,7 @@ declare const _default: {
|
|
|
16673
16702
|
'x-fern-sdk-method-name': string;
|
|
16674
16703
|
'x-fern-sdk-return-value': string;
|
|
16675
16704
|
'x-response-key': string;
|
|
16705
|
+
'x-title': string;
|
|
16676
16706
|
};
|
|
16677
16707
|
};
|
|
16678
16708
|
'/thermostats/schedules/create': {
|
|
@@ -17232,6 +17262,7 @@ declare const _default: {
|
|
|
17232
17262
|
};
|
|
17233
17263
|
'/thermostats/set_fan_mode': {
|
|
17234
17264
|
post: {
|
|
17265
|
+
description: string;
|
|
17235
17266
|
operationId: string;
|
|
17236
17267
|
requestBody: {
|
|
17237
17268
|
content: {
|
|
@@ -17239,6 +17270,7 @@ declare const _default: {
|
|
|
17239
17270
|
schema: {
|
|
17240
17271
|
properties: {
|
|
17241
17272
|
device_id: {
|
|
17273
|
+
description: string;
|
|
17242
17274
|
format: string;
|
|
17243
17275
|
type: string;
|
|
17244
17276
|
};
|
|
@@ -17249,6 +17281,7 @@ declare const _default: {
|
|
|
17249
17281
|
'x-deprecated': string;
|
|
17250
17282
|
};
|
|
17251
17283
|
fan_mode_setting: {
|
|
17284
|
+
description: string;
|
|
17252
17285
|
enum: string[];
|
|
17253
17286
|
type: string;
|
|
17254
17287
|
};
|
|
@@ -17317,6 +17350,7 @@ declare const _default: {
|
|
|
17317
17350
|
'x-fern-sdk-method-name': string;
|
|
17318
17351
|
'x-fern-sdk-return-value': string;
|
|
17319
17352
|
'x-response-key': string;
|
|
17353
|
+
'x-title': string;
|
|
17320
17354
|
};
|
|
17321
17355
|
};
|
|
17322
17356
|
'/thermostats/set_temperature_threshold': {
|
|
@@ -1256,7 +1256,7 @@ export default {
|
|
|
1256
1256
|
type: 'object',
|
|
1257
1257
|
},
|
|
1258
1258
|
{
|
|
1259
|
-
description: 'Reading
|
|
1259
|
+
description: 'Reading credential data from physical encoder.',
|
|
1260
1260
|
properties: {
|
|
1261
1261
|
action_attempt_id: {
|
|
1262
1262
|
description: 'The ID of the action attempt.',
|
|
@@ -1264,7 +1264,7 @@ export default {
|
|
|
1264
1264
|
type: 'string',
|
|
1265
1265
|
'x-title': 'Action Attempt ID',
|
|
1266
1266
|
},
|
|
1267
|
-
action_type: { enum: ['
|
|
1267
|
+
action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
|
|
1268
1268
|
error: { nullable: true },
|
|
1269
1269
|
result: { nullable: true },
|
|
1270
1270
|
status: { enum: ['pending'], type: 'string' },
|
|
@@ -1279,7 +1279,7 @@ export default {
|
|
|
1279
1279
|
type: 'object',
|
|
1280
1280
|
},
|
|
1281
1281
|
{
|
|
1282
|
-
description: 'Reading
|
|
1282
|
+
description: 'Reading credential data from physical encoder succeeded.',
|
|
1283
1283
|
properties: {
|
|
1284
1284
|
action_attempt_id: {
|
|
1285
1285
|
description: 'The ID of the action attempt.',
|
|
@@ -1287,12 +1287,12 @@ export default {
|
|
|
1287
1287
|
type: 'string',
|
|
1288
1288
|
'x-title': 'Action Attempt ID',
|
|
1289
1289
|
},
|
|
1290
|
-
action_type: { enum: ['
|
|
1290
|
+
action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
|
|
1291
1291
|
error: { nullable: true },
|
|
1292
1292
|
result: {
|
|
1293
1293
|
properties: {
|
|
1294
1294
|
acs_credential_on_encoder: {
|
|
1295
|
-
description: 'Snapshot of
|
|
1295
|
+
description: 'Snapshot of credential data read from physical encoder.',
|
|
1296
1296
|
properties: {
|
|
1297
1297
|
card_number: {
|
|
1298
1298
|
description: 'A number or string that physically identifies this card.',
|
|
@@ -1726,7 +1726,7 @@ export default {
|
|
|
1726
1726
|
type: 'object',
|
|
1727
1727
|
},
|
|
1728
1728
|
{
|
|
1729
|
-
description: 'Reading
|
|
1729
|
+
description: 'Reading credential data from physical encoder failed.',
|
|
1730
1730
|
properties: {
|
|
1731
1731
|
action_attempt_id: {
|
|
1732
1732
|
description: 'The ID of the action attempt.',
|
|
@@ -1734,7 +1734,7 @@ export default {
|
|
|
1734
1734
|
type: 'string',
|
|
1735
1735
|
'x-title': 'Action Attempt ID',
|
|
1736
1736
|
},
|
|
1737
|
-
action_type: { enum: ['
|
|
1737
|
+
action_type: { enum: ['SCAN_CREDENTIAL'], type: 'string' },
|
|
1738
1738
|
error: {
|
|
1739
1739
|
oneOf: [
|
|
1740
1740
|
{
|
|
@@ -1779,7 +1779,7 @@ export default {
|
|
|
1779
1779
|
type: 'object',
|
|
1780
1780
|
},
|
|
1781
1781
|
{
|
|
1782
|
-
description: 'Encoding
|
|
1782
|
+
description: 'Encoding credential data from physical encoder.',
|
|
1783
1783
|
properties: {
|
|
1784
1784
|
action_attempt_id: {
|
|
1785
1785
|
description: 'The ID of the action attempt.',
|
|
@@ -1787,7 +1787,7 @@ export default {
|
|
|
1787
1787
|
type: 'string',
|
|
1788
1788
|
'x-title': 'Action Attempt ID',
|
|
1789
1789
|
},
|
|
1790
|
-
action_type: { enum: ['
|
|
1790
|
+
action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
|
|
1791
1791
|
error: { nullable: true },
|
|
1792
1792
|
result: { nullable: true },
|
|
1793
1793
|
status: { enum: ['pending'], type: 'string' },
|
|
@@ -1802,7 +1802,7 @@ export default {
|
|
|
1802
1802
|
type: 'object',
|
|
1803
1803
|
},
|
|
1804
1804
|
{
|
|
1805
|
-
description: 'Encoding
|
|
1805
|
+
description: 'Encoding credential data from physical encoder succeeded.',
|
|
1806
1806
|
properties: {
|
|
1807
1807
|
action_attempt_id: {
|
|
1808
1808
|
description: 'The ID of the action attempt.',
|
|
@@ -1810,7 +1810,7 @@ export default {
|
|
|
1810
1810
|
type: 'string',
|
|
1811
1811
|
'x-title': 'Action Attempt ID',
|
|
1812
1812
|
},
|
|
1813
|
-
action_type: { enum: ['
|
|
1813
|
+
action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
|
|
1814
1814
|
error: { nullable: true },
|
|
1815
1815
|
result: {
|
|
1816
1816
|
description: 'Means by which a user gains access at an entrance.\nThe `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
|
|
@@ -2147,7 +2147,7 @@ export default {
|
|
|
2147
2147
|
type: 'object',
|
|
2148
2148
|
},
|
|
2149
2149
|
{
|
|
2150
|
-
description: 'Encoding
|
|
2150
|
+
description: 'Encoding credential data from physical encoder failed.',
|
|
2151
2151
|
properties: {
|
|
2152
2152
|
action_attempt_id: {
|
|
2153
2153
|
description: 'The ID of the action attempt.',
|
|
@@ -2155,7 +2155,7 @@ export default {
|
|
|
2155
2155
|
type: 'string',
|
|
2156
2156
|
'x-title': 'Action Attempt ID',
|
|
2157
2157
|
},
|
|
2158
|
-
action_type: { enum: ['
|
|
2158
|
+
action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
|
|
2159
2159
|
error: {
|
|
2160
2160
|
oneOf: [
|
|
2161
2161
|
{
|
|
@@ -8867,16 +8867,24 @@ export default {
|
|
|
8867
8867
|
'x-title': 'Update a Credential',
|
|
8868
8868
|
},
|
|
8869
8869
|
},
|
|
8870
|
-
'/acs/encoders/
|
|
8870
|
+
'/acs/encoders/encode_credential': {
|
|
8871
8871
|
post: {
|
|
8872
|
-
operationId: '
|
|
8872
|
+
operationId: 'acsEncodersEncodeCredentialPost',
|
|
8873
8873
|
requestBody: {
|
|
8874
8874
|
content: {
|
|
8875
8875
|
'application/json': {
|
|
8876
8876
|
schema: {
|
|
8877
8877
|
properties: {
|
|
8878
|
-
acs_credential_id: {
|
|
8879
|
-
|
|
8878
|
+
acs_credential_id: {
|
|
8879
|
+
description: 'ID of the acs_credential to encode on a physical card.',
|
|
8880
|
+
format: 'uuid',
|
|
8881
|
+
type: 'string',
|
|
8882
|
+
},
|
|
8883
|
+
device_id: {
|
|
8884
|
+
description: 'ID of the encoder to use for the encoding.',
|
|
8885
|
+
format: 'uuid',
|
|
8886
|
+
type: 'string',
|
|
8887
|
+
},
|
|
8880
8888
|
},
|
|
8881
8889
|
required: ['device_id', 'acs_credential_id'],
|
|
8882
8890
|
type: 'object',
|
|
@@ -8910,10 +8918,10 @@ export default {
|
|
|
8910
8918
|
{ console_session: [] },
|
|
8911
8919
|
{ api_key: [] },
|
|
8912
8920
|
],
|
|
8913
|
-
summary: '/acs/encoders/
|
|
8921
|
+
summary: '/acs/encoders/encode_credential',
|
|
8914
8922
|
tags: ['/acs'],
|
|
8915
8923
|
'x-fern-sdk-group-name': ['acs', 'encoders'],
|
|
8916
|
-
'x-fern-sdk-method-name': '
|
|
8924
|
+
'x-fern-sdk-method-name': 'encode_credential',
|
|
8917
8925
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
8918
8926
|
'x-response-key': 'action_attempt',
|
|
8919
8927
|
'x-undocumented': 'Encoding a card is currently unimplemented.',
|
|
@@ -9005,16 +9013,24 @@ export default {
|
|
|
9005
9013
|
'x-undocumented': 'Encoders are in alpha.',
|
|
9006
9014
|
},
|
|
9007
9015
|
},
|
|
9008
|
-
'/acs/encoders/
|
|
9016
|
+
'/acs/encoders/scan_credential': {
|
|
9009
9017
|
post: {
|
|
9010
|
-
operationId: '
|
|
9018
|
+
operationId: 'acsEncodersScanCredentialPost',
|
|
9011
9019
|
requestBody: {
|
|
9012
9020
|
content: {
|
|
9013
9021
|
'application/json': {
|
|
9014
9022
|
schema: {
|
|
9015
9023
|
properties: {
|
|
9016
|
-
acs_system_id: {
|
|
9017
|
-
|
|
9024
|
+
acs_system_id: {
|
|
9025
|
+
description: 'ID of the acs_system the encoder belongs to.',
|
|
9026
|
+
format: 'uuid',
|
|
9027
|
+
type: 'string',
|
|
9028
|
+
},
|
|
9029
|
+
device_id: {
|
|
9030
|
+
description: 'ID of the encoder to use for the scan.',
|
|
9031
|
+
format: 'uuid',
|
|
9032
|
+
type: 'string',
|
|
9033
|
+
},
|
|
9018
9034
|
},
|
|
9019
9035
|
required: ['acs_system_id', 'device_id'],
|
|
9020
9036
|
type: 'object',
|
|
@@ -9048,10 +9064,10 @@ export default {
|
|
|
9048
9064
|
{ console_session: [] },
|
|
9049
9065
|
{ api_key: [] },
|
|
9050
9066
|
],
|
|
9051
|
-
summary: '/acs/encoders/
|
|
9067
|
+
summary: '/acs/encoders/scan_credential',
|
|
9052
9068
|
tags: ['/acs'],
|
|
9053
9069
|
'x-fern-sdk-group-name': ['acs', 'encoders'],
|
|
9054
|
-
'x-fern-sdk-method-name': '
|
|
9070
|
+
'x-fern-sdk-method-name': 'scan_credential',
|
|
9055
9071
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
9056
9072
|
'x-response-key': 'action_attempt',
|
|
9057
9073
|
'x-undocumented': 'Reading a card is currently unimplemented.',
|
|
@@ -14885,6 +14901,7 @@ export default {
|
|
|
14885
14901
|
},
|
|
14886
14902
|
'/thermostats/cool': {
|
|
14887
14903
|
post: {
|
|
14904
|
+
description: 'Sets a thermostat to cooling mode. You must include a cooling set point in Celsius or Fahrenheit. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
|
|
14888
14905
|
operationId: 'thermostatsCoolPost',
|
|
14889
14906
|
requestBody: {
|
|
14890
14907
|
content: {
|
|
@@ -14892,14 +14909,20 @@ export default {
|
|
|
14892
14909
|
schema: {
|
|
14893
14910
|
properties: {
|
|
14894
14911
|
cooling_set_point_celsius: {
|
|
14912
|
+
description: 'Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters.',
|
|
14895
14913
|
format: 'float',
|
|
14896
14914
|
type: 'number',
|
|
14897
14915
|
},
|
|
14898
14916
|
cooling_set_point_fahrenheit: {
|
|
14917
|
+
description: 'Temperature to which the HVAC system connected to the thermostat should cool (in °F). You must set one of the `cooling_set_point` parameters.',
|
|
14899
14918
|
format: 'float',
|
|
14900
14919
|
type: 'number',
|
|
14901
14920
|
},
|
|
14902
|
-
device_id: {
|
|
14921
|
+
device_id: {
|
|
14922
|
+
description: 'ID of the thermostat device.',
|
|
14923
|
+
format: 'uuid',
|
|
14924
|
+
type: 'string',
|
|
14925
|
+
},
|
|
14903
14926
|
sync: { default: false, type: 'boolean' },
|
|
14904
14927
|
},
|
|
14905
14928
|
required: ['device_id'],
|
|
@@ -14941,6 +14964,7 @@ export default {
|
|
|
14941
14964
|
'x-fern-sdk-method-name': 'cool',
|
|
14942
14965
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
14943
14966
|
'x-response-key': 'action_attempt',
|
|
14967
|
+
'x-title': 'Set to Cool Mode',
|
|
14944
14968
|
},
|
|
14945
14969
|
},
|
|
14946
14970
|
'/thermostats/create_climate_preset': {
|
|
@@ -15065,14 +15089,22 @@ export default {
|
|
|
15065
15089
|
},
|
|
15066
15090
|
'/thermostats/get': {
|
|
15067
15091
|
post: {
|
|
15092
|
+
description: 'Returns a specific thermostat.',
|
|
15068
15093
|
operationId: 'thermostatsGetPost',
|
|
15069
15094
|
requestBody: {
|
|
15070
15095
|
content: {
|
|
15071
15096
|
'application/json': {
|
|
15072
15097
|
schema: {
|
|
15073
15098
|
properties: {
|
|
15074
|
-
device_id: {
|
|
15075
|
-
|
|
15099
|
+
device_id: {
|
|
15100
|
+
description: 'ID of the thermostat device.',
|
|
15101
|
+
format: 'uuid',
|
|
15102
|
+
type: 'string',
|
|
15103
|
+
},
|
|
15104
|
+
name: {
|
|
15105
|
+
description: 'Name of the thermostat.',
|
|
15106
|
+
type: 'string',
|
|
15107
|
+
},
|
|
15076
15108
|
},
|
|
15077
15109
|
type: 'object',
|
|
15078
15110
|
},
|
|
@@ -15111,22 +15143,30 @@ export default {
|
|
|
15111
15143
|
'x-fern-sdk-method-name': 'get',
|
|
15112
15144
|
'x-fern-sdk-return-value': 'thermostat',
|
|
15113
15145
|
'x-response-key': 'thermostat',
|
|
15146
|
+
'x-title': 'Get a Thermostat',
|
|
15114
15147
|
},
|
|
15115
15148
|
},
|
|
15116
15149
|
'/thermostats/heat': {
|
|
15117
15150
|
post: {
|
|
15151
|
+
description: 'Sets a thermostat to heating mode. You must include a heating set point in Celsius or Fahrenheit. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
|
|
15118
15152
|
operationId: 'thermostatsHeatPost',
|
|
15119
15153
|
requestBody: {
|
|
15120
15154
|
content: {
|
|
15121
15155
|
'application/json': {
|
|
15122
15156
|
schema: {
|
|
15123
15157
|
properties: {
|
|
15124
|
-
device_id: {
|
|
15158
|
+
device_id: {
|
|
15159
|
+
description: 'ID of the thermostat device.',
|
|
15160
|
+
format: 'uuid',
|
|
15161
|
+
type: 'string',
|
|
15162
|
+
},
|
|
15125
15163
|
heating_set_point_celsius: {
|
|
15164
|
+
description: 'Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters.',
|
|
15126
15165
|
format: 'float',
|
|
15127
15166
|
type: 'number',
|
|
15128
15167
|
},
|
|
15129
15168
|
heating_set_point_fahrenheit: {
|
|
15169
|
+
description: 'Temperature to which the HVAC system connected to the thermostat should heat (in °F). You must set one of the `heating_set_point` parameters.',
|
|
15130
15170
|
format: 'float',
|
|
15131
15171
|
type: 'number',
|
|
15132
15172
|
},
|
|
@@ -15171,10 +15211,12 @@ export default {
|
|
|
15171
15211
|
'x-fern-sdk-method-name': 'heat',
|
|
15172
15212
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
15173
15213
|
'x-response-key': 'action_attempt',
|
|
15214
|
+
'x-title': 'Set to Heat Mode',
|
|
15174
15215
|
},
|
|
15175
15216
|
},
|
|
15176
15217
|
'/thermostats/heat_cool': {
|
|
15177
15218
|
post: {
|
|
15219
|
+
description: 'Set a thermostat to heat-cool mode, also known as "auto" mode. To do so, you must include both cooling and heating set points in the payload, either in Celsius or Fahrenheit. For information about verifying the heating and cooling availability of the thermostat and validating the correct set points, see [HVAC Mode Constraints](https://docs.seam.co/latest/capability-guides/thermostats/hvac-mode#hvac-mode-constraints) and [Set Point Constraints](https://docs.seam.co/latest/capability-guides/thermostats/set-points#set-point-constraints).',
|
|
15178
15220
|
operationId: 'thermostatsHeatCoolPost',
|
|
15179
15221
|
requestBody: {
|
|
15180
15222
|
content: {
|
|
@@ -15182,19 +15224,27 @@ export default {
|
|
|
15182
15224
|
schema: {
|
|
15183
15225
|
properties: {
|
|
15184
15226
|
cooling_set_point_celsius: {
|
|
15227
|
+
description: 'Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters.',
|
|
15185
15228
|
format: 'float',
|
|
15186
15229
|
type: 'number',
|
|
15187
15230
|
},
|
|
15188
15231
|
cooling_set_point_fahrenheit: {
|
|
15232
|
+
description: 'Temperature the thermostat should cool to (in °F). You must set one of the cooling_set_point parameters.',
|
|
15189
15233
|
format: 'float',
|
|
15190
15234
|
type: 'number',
|
|
15191
15235
|
},
|
|
15192
|
-
device_id: {
|
|
15236
|
+
device_id: {
|
|
15237
|
+
description: 'ID of the thermostat device.',
|
|
15238
|
+
format: 'uuid',
|
|
15239
|
+
type: 'string',
|
|
15240
|
+
},
|
|
15193
15241
|
heating_set_point_celsius: {
|
|
15242
|
+
description: 'Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters.',
|
|
15194
15243
|
format: 'float',
|
|
15195
15244
|
type: 'number',
|
|
15196
15245
|
},
|
|
15197
15246
|
heating_set_point_fahrenheit: {
|
|
15247
|
+
description: 'Temperature the thermostat should heat to (in °F). You must set one of the heating_set_point parameters.',
|
|
15198
15248
|
format: 'float',
|
|
15199
15249
|
type: 'number',
|
|
15200
15250
|
},
|
|
@@ -15239,10 +15289,12 @@ export default {
|
|
|
15239
15289
|
'x-fern-sdk-method-name': 'heat_cool',
|
|
15240
15290
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
15241
15291
|
'x-response-key': 'action_attempt',
|
|
15292
|
+
'x-title': 'Set to Heat-Cool (Auto) Mode',
|
|
15242
15293
|
},
|
|
15243
15294
|
},
|
|
15244
15295
|
'/thermostats/list': {
|
|
15245
15296
|
post: {
|
|
15297
|
+
description: 'Returns a list of thermostats connected to your workspace. If no thermostats are connected, the list will be empty.',
|
|
15246
15298
|
operationId: 'thermostatsListPost',
|
|
15247
15299
|
requestBody: {
|
|
15248
15300
|
content: {
|
|
@@ -15512,17 +15564,23 @@ export default {
|
|
|
15512
15564
|
'x-fern-sdk-method-name': 'list',
|
|
15513
15565
|
'x-fern-sdk-return-value': 'devices',
|
|
15514
15566
|
'x-response-key': 'devices',
|
|
15567
|
+
'x-title': 'List Thermostats',
|
|
15515
15568
|
},
|
|
15516
15569
|
},
|
|
15517
15570
|
'/thermostats/off': {
|
|
15518
15571
|
post: {
|
|
15572
|
+
description: 'Sets a thermostat to "off" mode. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
|
|
15519
15573
|
operationId: 'thermostatsOffPost',
|
|
15520
15574
|
requestBody: {
|
|
15521
15575
|
content: {
|
|
15522
15576
|
'application/json': {
|
|
15523
15577
|
schema: {
|
|
15524
15578
|
properties: {
|
|
15525
|
-
device_id: {
|
|
15579
|
+
device_id: {
|
|
15580
|
+
description: 'ID of the thermostat device.',
|
|
15581
|
+
format: 'uuid',
|
|
15582
|
+
type: 'string',
|
|
15583
|
+
},
|
|
15526
15584
|
sync: { default: false, type: 'boolean' },
|
|
15527
15585
|
},
|
|
15528
15586
|
required: ['device_id'],
|
|
@@ -15564,6 +15622,7 @@ export default {
|
|
|
15564
15622
|
'x-fern-sdk-method-name': 'off',
|
|
15565
15623
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
15566
15624
|
'x-response-key': 'action_attempt',
|
|
15625
|
+
'x-title': 'Set to Off Mode',
|
|
15567
15626
|
},
|
|
15568
15627
|
},
|
|
15569
15628
|
'/thermostats/schedules/create': {
|
|
@@ -15926,20 +15985,26 @@ export default {
|
|
|
15926
15985
|
},
|
|
15927
15986
|
'/thermostats/set_fan_mode': {
|
|
15928
15987
|
post: {
|
|
15988
|
+
description: 'Sets the fan mode setting for a thermostat. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) and [Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings).',
|
|
15929
15989
|
operationId: 'thermostatsSetFanModePost',
|
|
15930
15990
|
requestBody: {
|
|
15931
15991
|
content: {
|
|
15932
15992
|
'application/json': {
|
|
15933
15993
|
schema: {
|
|
15934
15994
|
properties: {
|
|
15935
|
-
device_id: {
|
|
15995
|
+
device_id: {
|
|
15996
|
+
description: 'ID of the thermostat device.',
|
|
15997
|
+
format: 'uuid',
|
|
15998
|
+
type: 'string',
|
|
15999
|
+
},
|
|
15936
16000
|
fan_mode: {
|
|
15937
16001
|
deprecated: true,
|
|
15938
16002
|
enum: ['auto', 'on', 'circulate'],
|
|
15939
16003
|
type: 'string',
|
|
15940
|
-
'x-deprecated': '
|
|
16004
|
+
'x-deprecated': 'Use `fan_mode_setting` instead.',
|
|
15941
16005
|
},
|
|
15942
16006
|
fan_mode_setting: {
|
|
16007
|
+
description: 'Fan mode setting of the thermostat. See also [Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings).',
|
|
15943
16008
|
enum: ['auto', 'on', 'circulate'],
|
|
15944
16009
|
type: 'string',
|
|
15945
16010
|
},
|
|
@@ -15984,6 +16049,7 @@ export default {
|
|
|
15984
16049
|
'x-fern-sdk-method-name': 'set_fan_mode',
|
|
15985
16050
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
15986
16051
|
'x-response-key': 'action_attempt',
|
|
16052
|
+
'x-title': 'Set Fan Mode Setting',
|
|
15987
16053
|
},
|
|
15988
16054
|
},
|
|
15989
16055
|
'/thermostats/set_temperature_threshold': {
|