@seamapi/types 1.340.1 → 1.342.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.
- package/dist/connect.cjs +241 -16
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +454 -58
- package/lib/seam/connect/models/acs/acs-credential.js +2 -10
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/events/devices.d.ts +66 -0
- package/lib/seam/connect/models/events/devices.js +15 -0
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +33 -1
- package/lib/seam/connect/openapi.d.ts +314 -0
- package/lib/seam/connect/openapi.js +223 -7
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +108 -58
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-credential.ts +2 -12
- package/src/lib/seam/connect/models/events/devices.ts +22 -0
- package/src/lib/seam/connect/openapi.ts +228 -7
- package/src/lib/seam/connect/route-types.ts +114 -56
|
@@ -948,7 +948,7 @@ export default {
|
|
|
948
948
|
'x-route-path': '/acs/access_groups',
|
|
949
949
|
},
|
|
950
950
|
acs_credential: {
|
|
951
|
-
description: 'Means by which a user gains access at an entrance
|
|
951
|
+
description: 'Means by which a user gains access at an entrance. The `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.',
|
|
952
952
|
properties: {
|
|
953
953
|
access_method: {
|
|
954
954
|
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
@@ -2396,7 +2396,7 @@ export default {
|
|
|
2396
2396
|
nullable: true,
|
|
2397
2397
|
oneOf: [
|
|
2398
2398
|
{
|
|
2399
|
-
description: 'Means by which a user gains access at an entrance
|
|
2399
|
+
description: 'Means by which a user gains access at an entrance. The `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.',
|
|
2400
2400
|
properties: {
|
|
2401
2401
|
access_method: {
|
|
2402
2402
|
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
@@ -2732,7 +2732,7 @@ export default {
|
|
|
2732
2732
|
'x-route-path': '/acs/credentials',
|
|
2733
2733
|
},
|
|
2734
2734
|
{
|
|
2735
|
-
description: 'Means by which a user gains access at an entrance
|
|
2735
|
+
description: 'Means by which a user gains access at an entrance. The `unmanaged_acs_credential` object, which is not managed by Seam, 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.',
|
|
2736
2736
|
properties: {
|
|
2737
2737
|
access_method: {
|
|
2738
2738
|
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
@@ -3197,10 +3197,10 @@ export default {
|
|
|
3197
3197
|
action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
|
|
3198
3198
|
error: { nullable: true },
|
|
3199
3199
|
result: {
|
|
3200
|
-
description: 'Means by which a user gains access at an entrance
|
|
3200
|
+
description: 'Means by which a user gains access at an entrance. The `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.',
|
|
3201
3201
|
oneOf: [
|
|
3202
3202
|
{
|
|
3203
|
-
description: 'Means by which a user gains access at an entrance
|
|
3203
|
+
description: 'Means by which a user gains access at an entrance. The `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.',
|
|
3204
3204
|
properties: {
|
|
3205
3205
|
access_method: {
|
|
3206
3206
|
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
@@ -3534,7 +3534,7 @@ export default {
|
|
|
3534
3534
|
'x-route-path': '/acs/credentials',
|
|
3535
3535
|
},
|
|
3536
3536
|
{
|
|
3537
|
-
description: 'Means by which a user gains access at an entrance
|
|
3537
|
+
description: 'Means by which a user gains access at an entrance. The `unmanaged_acs_credential` object, which is not managed by Seam, 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.',
|
|
3538
3538
|
properties: {
|
|
3539
3539
|
access_method: {
|
|
3540
3540
|
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
@@ -10854,6 +10854,68 @@ export default {
|
|
|
10854
10854
|
type: 'object',
|
|
10855
10855
|
'x-route-path': '/thermostats',
|
|
10856
10856
|
},
|
|
10857
|
+
{
|
|
10858
|
+
description: "A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) reported temperature changed by at least 1 °C.",
|
|
10859
|
+
properties: {
|
|
10860
|
+
connected_account_id: {
|
|
10861
|
+
description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
|
|
10862
|
+
format: 'uuid',
|
|
10863
|
+
type: 'string',
|
|
10864
|
+
},
|
|
10865
|
+
created_at: {
|
|
10866
|
+
description: 'Date and time at which the event was created.',
|
|
10867
|
+
format: 'date-time',
|
|
10868
|
+
type: 'string',
|
|
10869
|
+
},
|
|
10870
|
+
device_id: {
|
|
10871
|
+
description: 'ID of the device.',
|
|
10872
|
+
format: 'uuid',
|
|
10873
|
+
type: 'string',
|
|
10874
|
+
},
|
|
10875
|
+
event_id: {
|
|
10876
|
+
description: 'ID of the event.',
|
|
10877
|
+
format: 'uuid',
|
|
10878
|
+
type: 'string',
|
|
10879
|
+
},
|
|
10880
|
+
event_type: {
|
|
10881
|
+
enum: ['thermostat.temperature_changed_event'],
|
|
10882
|
+
type: 'string',
|
|
10883
|
+
},
|
|
10884
|
+
occurred_at: {
|
|
10885
|
+
description: 'Date and time at which the event occurred.',
|
|
10886
|
+
format: 'date-time',
|
|
10887
|
+
type: 'string',
|
|
10888
|
+
},
|
|
10889
|
+
temperature_celsius: {
|
|
10890
|
+
description: 'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
|
|
10891
|
+
format: 'float',
|
|
10892
|
+
type: 'number',
|
|
10893
|
+
},
|
|
10894
|
+
temperature_fahrenheit: {
|
|
10895
|
+
description: 'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
|
|
10896
|
+
format: 'float',
|
|
10897
|
+
type: 'number',
|
|
10898
|
+
},
|
|
10899
|
+
workspace_id: {
|
|
10900
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
|
|
10901
|
+
format: 'uuid',
|
|
10902
|
+
type: 'string',
|
|
10903
|
+
},
|
|
10904
|
+
},
|
|
10905
|
+
required: [
|
|
10906
|
+
'event_id',
|
|
10907
|
+
'workspace_id',
|
|
10908
|
+
'created_at',
|
|
10909
|
+
'occurred_at',
|
|
10910
|
+
'device_id',
|
|
10911
|
+
'connected_account_id',
|
|
10912
|
+
'event_type',
|
|
10913
|
+
'temperature_celsius',
|
|
10914
|
+
'temperature_fahrenheit',
|
|
10915
|
+
],
|
|
10916
|
+
type: 'object',
|
|
10917
|
+
'x-route-path': '/thermostats',
|
|
10918
|
+
},
|
|
10857
10919
|
{
|
|
10858
10920
|
description: 'An [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) was deleted.',
|
|
10859
10921
|
properties: {
|
|
@@ -12531,7 +12593,7 @@ export default {
|
|
|
12531
12593
|
'x-route-path': '/acs/access_groups/unmanaged',
|
|
12532
12594
|
},
|
|
12533
12595
|
unmanaged_acs_credential: {
|
|
12534
|
-
description: 'Means by which a user gains access at an entrance
|
|
12596
|
+
description: 'Means by which a user gains access at an entrance. The `unmanaged_acs_credential` object, which is not managed by Seam, 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.',
|
|
12535
12597
|
properties: {
|
|
12536
12598
|
access_method: {
|
|
12537
12599
|
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
@@ -21076,6 +21138,7 @@ export default {
|
|
|
21076
21138
|
'thermostat.temperature_threshold_exceeded',
|
|
21077
21139
|
'thermostat.temperature_threshold_no_longer_exceeded',
|
|
21078
21140
|
'thermostat.temperature_reached_set_point',
|
|
21141
|
+
'thermostat.temperature_changed_event',
|
|
21079
21142
|
'enrollment_automation.deleted',
|
|
21080
21143
|
'phone.deactivated',
|
|
21081
21144
|
],
|
|
@@ -21156,6 +21219,7 @@ export default {
|
|
|
21156
21219
|
'thermostat.temperature_threshold_exceeded',
|
|
21157
21220
|
'thermostat.temperature_threshold_no_longer_exceeded',
|
|
21158
21221
|
'thermostat.temperature_reached_set_point',
|
|
21222
|
+
'thermostat.temperature_changed_event',
|
|
21159
21223
|
'enrollment_automation.deleted',
|
|
21160
21224
|
'phone.deactivated',
|
|
21161
21225
|
],
|
|
@@ -24308,6 +24372,158 @@ export default {
|
|
|
24308
24372
|
'x-title': 'Set a Temperature Threshold',
|
|
24309
24373
|
},
|
|
24310
24374
|
},
|
|
24375
|
+
'/thermostats/simulate/hvac_mode_adjusted': {
|
|
24376
|
+
post: {
|
|
24377
|
+
operationId: 'thermostatsSimulateHvacModeAdjustedPost',
|
|
24378
|
+
requestBody: {
|
|
24379
|
+
content: {
|
|
24380
|
+
'application/json': {
|
|
24381
|
+
schema: {
|
|
24382
|
+
discriminator: { propertyName: 'hvac_mode' },
|
|
24383
|
+
oneOf: [
|
|
24384
|
+
{
|
|
24385
|
+
properties: {
|
|
24386
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
24387
|
+
hvac_mode: { enum: ['off'], type: 'string' },
|
|
24388
|
+
},
|
|
24389
|
+
required: ['hvac_mode', 'device_id'],
|
|
24390
|
+
type: 'object',
|
|
24391
|
+
},
|
|
24392
|
+
{
|
|
24393
|
+
properties: {
|
|
24394
|
+
cooling_set_point_celsius: {
|
|
24395
|
+
format: 'float',
|
|
24396
|
+
type: 'number',
|
|
24397
|
+
},
|
|
24398
|
+
cooling_set_point_fahrenheit: {
|
|
24399
|
+
format: 'float',
|
|
24400
|
+
type: 'number',
|
|
24401
|
+
},
|
|
24402
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
24403
|
+
hvac_mode: { enum: ['cool'], type: 'string' },
|
|
24404
|
+
},
|
|
24405
|
+
required: ['hvac_mode', 'device_id'],
|
|
24406
|
+
type: 'object',
|
|
24407
|
+
},
|
|
24408
|
+
{
|
|
24409
|
+
properties: {
|
|
24410
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
24411
|
+
heating_set_point_celsius: {
|
|
24412
|
+
format: 'float',
|
|
24413
|
+
type: 'number',
|
|
24414
|
+
},
|
|
24415
|
+
heating_set_point_fahrenheit: {
|
|
24416
|
+
format: 'float',
|
|
24417
|
+
type: 'number',
|
|
24418
|
+
},
|
|
24419
|
+
hvac_mode: { enum: ['heat'], type: 'string' },
|
|
24420
|
+
},
|
|
24421
|
+
required: ['hvac_mode', 'device_id'],
|
|
24422
|
+
type: 'object',
|
|
24423
|
+
},
|
|
24424
|
+
{
|
|
24425
|
+
properties: {
|
|
24426
|
+
cooling_set_point_celsius: {
|
|
24427
|
+
format: 'float',
|
|
24428
|
+
type: 'number',
|
|
24429
|
+
},
|
|
24430
|
+
cooling_set_point_fahrenheit: {
|
|
24431
|
+
format: 'float',
|
|
24432
|
+
type: 'number',
|
|
24433
|
+
},
|
|
24434
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
24435
|
+
heating_set_point_celsius: {
|
|
24436
|
+
format: 'float',
|
|
24437
|
+
type: 'number',
|
|
24438
|
+
},
|
|
24439
|
+
heating_set_point_fahrenheit: {
|
|
24440
|
+
format: 'float',
|
|
24441
|
+
type: 'number',
|
|
24442
|
+
},
|
|
24443
|
+
hvac_mode: { enum: ['heat_cool'], type: 'string' },
|
|
24444
|
+
},
|
|
24445
|
+
required: ['hvac_mode', 'device_id'],
|
|
24446
|
+
type: 'object',
|
|
24447
|
+
},
|
|
24448
|
+
],
|
|
24449
|
+
},
|
|
24450
|
+
},
|
|
24451
|
+
},
|
|
24452
|
+
},
|
|
24453
|
+
responses: {
|
|
24454
|
+
200: {
|
|
24455
|
+
content: {
|
|
24456
|
+
'application/json': {
|
|
24457
|
+
schema: {
|
|
24458
|
+
properties: { ok: { type: 'boolean' } },
|
|
24459
|
+
required: ['ok'],
|
|
24460
|
+
type: 'object',
|
|
24461
|
+
},
|
|
24462
|
+
},
|
|
24463
|
+
},
|
|
24464
|
+
description: 'OK',
|
|
24465
|
+
},
|
|
24466
|
+
400: { description: 'Bad Request' },
|
|
24467
|
+
401: { description: 'Unauthorized' },
|
|
24468
|
+
},
|
|
24469
|
+
security: [
|
|
24470
|
+
{ api_key: [] },
|
|
24471
|
+
{ pat_with_workspace: [] },
|
|
24472
|
+
{ console_session_with_workspace: [] },
|
|
24473
|
+
],
|
|
24474
|
+
summary: '/thermostats/simulate/hvac_mode_adjusted',
|
|
24475
|
+
tags: ['/thermostats'],
|
|
24476
|
+
'x-fern-sdk-group-name': ['thermostats', 'simulate'],
|
|
24477
|
+
'x-fern-sdk-method-name': 'hvac_mode_adjusted',
|
|
24478
|
+
'x-response-key': null,
|
|
24479
|
+
},
|
|
24480
|
+
},
|
|
24481
|
+
'/thermostats/simulate/temperature_reached': {
|
|
24482
|
+
post: {
|
|
24483
|
+
operationId: 'thermostatsSimulateTemperatureReachedPost',
|
|
24484
|
+
requestBody: {
|
|
24485
|
+
content: {
|
|
24486
|
+
'application/json': {
|
|
24487
|
+
schema: {
|
|
24488
|
+
properties: {
|
|
24489
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
24490
|
+
temperature_celsius: { format: 'float', type: 'number' },
|
|
24491
|
+
temperature_fahrenheit: { format: 'float', type: 'number' },
|
|
24492
|
+
},
|
|
24493
|
+
required: ['device_id'],
|
|
24494
|
+
type: 'object',
|
|
24495
|
+
},
|
|
24496
|
+
},
|
|
24497
|
+
},
|
|
24498
|
+
},
|
|
24499
|
+
responses: {
|
|
24500
|
+
200: {
|
|
24501
|
+
content: {
|
|
24502
|
+
'application/json': {
|
|
24503
|
+
schema: {
|
|
24504
|
+
properties: { ok: { type: 'boolean' } },
|
|
24505
|
+
required: ['ok'],
|
|
24506
|
+
type: 'object',
|
|
24507
|
+
},
|
|
24508
|
+
},
|
|
24509
|
+
},
|
|
24510
|
+
description: 'OK',
|
|
24511
|
+
},
|
|
24512
|
+
400: { description: 'Bad Request' },
|
|
24513
|
+
401: { description: 'Unauthorized' },
|
|
24514
|
+
},
|
|
24515
|
+
security: [
|
|
24516
|
+
{ api_key: [] },
|
|
24517
|
+
{ pat_with_workspace: [] },
|
|
24518
|
+
{ console_session_with_workspace: [] },
|
|
24519
|
+
],
|
|
24520
|
+
summary: '/thermostats/simulate/temperature_reached',
|
|
24521
|
+
tags: ['/thermostats'],
|
|
24522
|
+
'x-fern-sdk-group-name': ['thermostats', 'simulate'],
|
|
24523
|
+
'x-fern-sdk-method-name': 'temperature_reached',
|
|
24524
|
+
'x-response-key': null,
|
|
24525
|
+
},
|
|
24526
|
+
},
|
|
24311
24527
|
'/thermostats/update_climate_preset': {
|
|
24312
24528
|
patch: {
|
|
24313
24529
|
description: 'Updates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
|