@seamapi/types 1.51.0 → 1.52.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 +225 -32
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +526 -49
- package/lib/seam/connect/openapi.d.ts +199 -12
- package/lib/seam/connect/openapi.js +224 -31
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +327 -37
- package/lib/seam/connect/unstable/models/devices/managed-device.js +83 -33
- package/lib/seam/connect/unstable/models/devices/managed-device.js.map +1 -1
- package/lib/seam/connect/unstable/models/user-identity.d.ts +6 -0
- package/lib/seam/connect/unstable/models/user-identity.js +2 -0
- package/lib/seam/connect/unstable/models/user-identity.js.map +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +244 -31
- package/src/lib/seam/connect/route-types.ts +327 -36
- package/src/lib/seam/connect/unstable/models/devices/managed-device.ts +111 -41
- package/src/lib/seam/connect/unstable/models/user-identity.ts +2 -0
|
@@ -473,6 +473,7 @@ export default {
|
|
|
473
473
|
device: {
|
|
474
474
|
properties: {
|
|
475
475
|
capabilities_supported: {
|
|
476
|
+
description: 'Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.',
|
|
476
477
|
items: {
|
|
477
478
|
enum: [
|
|
478
479
|
'access_code',
|
|
@@ -485,10 +486,23 @@ export default {
|
|
|
485
486
|
},
|
|
486
487
|
type: 'array',
|
|
487
488
|
},
|
|
488
|
-
connected_account_id: {
|
|
489
|
-
|
|
490
|
-
|
|
489
|
+
connected_account_id: {
|
|
490
|
+
description: 'Unique identifier for the account associated with the device.',
|
|
491
|
+
format: 'uuid',
|
|
492
|
+
type: 'string',
|
|
493
|
+
},
|
|
494
|
+
created_at: {
|
|
495
|
+
description: 'Date and time at which the device object was created.',
|
|
496
|
+
format: 'date-time',
|
|
497
|
+
type: 'string',
|
|
498
|
+
},
|
|
499
|
+
device_id: {
|
|
500
|
+
description: 'Unique identifier for the device.',
|
|
501
|
+
format: 'uuid',
|
|
502
|
+
type: 'string',
|
|
503
|
+
},
|
|
491
504
|
device_type: {
|
|
505
|
+
description: 'Type of the device.',
|
|
492
506
|
oneOf: [
|
|
493
507
|
{
|
|
494
508
|
enum: [
|
|
@@ -531,6 +545,7 @@ export default {
|
|
|
531
545
|
],
|
|
532
546
|
},
|
|
533
547
|
errors: {
|
|
548
|
+
description: 'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
|
|
534
549
|
items: {
|
|
535
550
|
properties: {
|
|
536
551
|
error_code: { type: 'string' },
|
|
@@ -541,12 +556,23 @@ export default {
|
|
|
541
556
|
},
|
|
542
557
|
type: 'array',
|
|
543
558
|
},
|
|
544
|
-
is_managed: {
|
|
559
|
+
is_managed: {
|
|
560
|
+
description: 'Indicates whether Seam manages the device.',
|
|
561
|
+
enum: [true],
|
|
562
|
+
type: 'boolean',
|
|
563
|
+
},
|
|
545
564
|
location: {
|
|
565
|
+
description: 'Location information for the device.',
|
|
546
566
|
nullable: true,
|
|
547
567
|
properties: {
|
|
548
|
-
location_name: {
|
|
549
|
-
|
|
568
|
+
location_name: {
|
|
569
|
+
description: 'Name of the device location.',
|
|
570
|
+
type: 'string',
|
|
571
|
+
},
|
|
572
|
+
timezone: {
|
|
573
|
+
description: 'Time zone of the device location.',
|
|
574
|
+
type: 'string',
|
|
575
|
+
},
|
|
550
576
|
},
|
|
551
577
|
type: 'object',
|
|
552
578
|
},
|
|
@@ -557,6 +583,7 @@ export default {
|
|
|
557
583
|
{
|
|
558
584
|
properties: {
|
|
559
585
|
battery: {
|
|
586
|
+
description: 'Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.',
|
|
560
587
|
properties: {
|
|
561
588
|
level: { maximum: 1, minimum: 0, type: 'number' },
|
|
562
589
|
status: {
|
|
@@ -567,39 +594,81 @@ export default {
|
|
|
567
594
|
required: ['level', 'status'],
|
|
568
595
|
type: 'object',
|
|
569
596
|
},
|
|
570
|
-
battery_level: {
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
597
|
+
battery_level: {
|
|
598
|
+
description: 'Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.',
|
|
599
|
+
maximum: 1,
|
|
600
|
+
minimum: 0,
|
|
601
|
+
type: 'number',
|
|
602
|
+
},
|
|
603
|
+
has_direct_power: {
|
|
604
|
+
description: 'Indicates whether the device has direct power.',
|
|
605
|
+
type: 'boolean',
|
|
606
|
+
},
|
|
607
|
+
image_alt_text: {
|
|
608
|
+
description: 'Alt text for the device image.',
|
|
609
|
+
type: 'string',
|
|
610
|
+
},
|
|
611
|
+
image_url: {
|
|
612
|
+
description: 'Image URL for the device.',
|
|
613
|
+
format: 'uri',
|
|
614
|
+
type: 'string',
|
|
615
|
+
},
|
|
616
|
+
manufacturer: {
|
|
617
|
+
description: 'Manufacturer of the device.',
|
|
618
|
+
type: 'string',
|
|
619
|
+
},
|
|
575
620
|
model: {
|
|
576
621
|
properties: {
|
|
577
|
-
accessory_keypad_supported: {
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
622
|
+
accessory_keypad_supported: {
|
|
623
|
+
description: 'Indicates whether the device supports an accessory keypad.',
|
|
624
|
+
type: 'boolean',
|
|
625
|
+
},
|
|
626
|
+
display_name: {
|
|
627
|
+
description: 'Display name of the device model.',
|
|
628
|
+
type: 'string',
|
|
629
|
+
},
|
|
630
|
+
manufacturer_display_name: {
|
|
631
|
+
description: 'Display name that corresponds to the manufacturer-specific terminology for the device.',
|
|
632
|
+
type: 'string',
|
|
633
|
+
},
|
|
634
|
+
offline_access_codes_supported: {
|
|
635
|
+
description: 'Indicates whether the device supports offline access codes.',
|
|
636
|
+
type: 'boolean',
|
|
637
|
+
},
|
|
638
|
+
online_access_codes_supported: {
|
|
639
|
+
description: 'Indicates whether the device supports online access codes.',
|
|
640
|
+
type: 'boolean',
|
|
641
|
+
},
|
|
582
642
|
},
|
|
583
643
|
required: ['display_name', 'manufacturer_display_name'],
|
|
584
644
|
type: 'object',
|
|
585
645
|
},
|
|
586
|
-
name: {
|
|
646
|
+
name: {
|
|
647
|
+
description: 'Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
|
|
648
|
+
type: 'string',
|
|
649
|
+
},
|
|
587
650
|
offline_access_codes_enabled: {
|
|
588
|
-
description: '
|
|
651
|
+
description: 'Indicates whether it is currently possible to use offline access codes for the device.',
|
|
652
|
+
type: 'boolean',
|
|
653
|
+
},
|
|
654
|
+
online: {
|
|
655
|
+
description: 'Indicates whether the device is online.',
|
|
589
656
|
type: 'boolean',
|
|
590
657
|
},
|
|
591
|
-
online: { type: 'boolean' },
|
|
592
658
|
online_access_codes_enabled: {
|
|
593
|
-
description: '
|
|
659
|
+
description: 'Indicates whether it is currently possible to use online access codes for the device.',
|
|
594
660
|
type: 'boolean',
|
|
595
661
|
},
|
|
596
|
-
serial_number: {
|
|
662
|
+
serial_number: {
|
|
663
|
+
description: 'Serial number of the device.',
|
|
664
|
+
type: 'string',
|
|
665
|
+
},
|
|
597
666
|
supports_accessory_keypad: {
|
|
598
|
-
description: 'Deprecated:
|
|
667
|
+
description: 'Deprecated: Use model.offline_access_codes_enabled.',
|
|
599
668
|
type: 'boolean',
|
|
600
669
|
},
|
|
601
670
|
supports_offline_access_codes: {
|
|
602
|
-
description: 'Deprecated:
|
|
671
|
+
description: 'Deprecated: Use model.accessory_keypad_supported.',
|
|
603
672
|
type: 'boolean',
|
|
604
673
|
},
|
|
605
674
|
},
|
|
@@ -1412,8 +1481,10 @@ export default {
|
|
|
1412
1481
|
],
|
|
1413
1482
|
},
|
|
1414
1483
|
],
|
|
1484
|
+
description: 'Properties of the device.',
|
|
1415
1485
|
},
|
|
1416
1486
|
warnings: {
|
|
1487
|
+
description: 'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
|
|
1417
1488
|
items: {
|
|
1418
1489
|
properties: {
|
|
1419
1490
|
message: { type: 'string' },
|
|
@@ -1424,7 +1495,11 @@ export default {
|
|
|
1424
1495
|
},
|
|
1425
1496
|
type: 'array',
|
|
1426
1497
|
},
|
|
1427
|
-
workspace_id: {
|
|
1498
|
+
workspace_id: {
|
|
1499
|
+
description: 'Unique identifier for the Seam workspace associated with the device.',
|
|
1500
|
+
format: 'uuid',
|
|
1501
|
+
type: 'string',
|
|
1502
|
+
},
|
|
1428
1503
|
},
|
|
1429
1504
|
required: [
|
|
1430
1505
|
'device_id',
|
|
@@ -1576,6 +1651,7 @@ export default {
|
|
|
1576
1651
|
unmanaged_device: {
|
|
1577
1652
|
properties: {
|
|
1578
1653
|
capabilities_supported: {
|
|
1654
|
+
description: 'Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.',
|
|
1579
1655
|
items: {
|
|
1580
1656
|
enum: [
|
|
1581
1657
|
'access_code',
|
|
@@ -1588,10 +1664,23 @@ export default {
|
|
|
1588
1664
|
},
|
|
1589
1665
|
type: 'array',
|
|
1590
1666
|
},
|
|
1591
|
-
connected_account_id: {
|
|
1592
|
-
|
|
1593
|
-
|
|
1667
|
+
connected_account_id: {
|
|
1668
|
+
description: 'Unique identifier for the account associated with the device.',
|
|
1669
|
+
format: 'uuid',
|
|
1670
|
+
type: 'string',
|
|
1671
|
+
},
|
|
1672
|
+
created_at: {
|
|
1673
|
+
description: 'Date and time at which the device object was created.',
|
|
1674
|
+
format: 'date-time',
|
|
1675
|
+
type: 'string',
|
|
1676
|
+
},
|
|
1677
|
+
device_id: {
|
|
1678
|
+
description: 'Unique identifier for the device.',
|
|
1679
|
+
format: 'uuid',
|
|
1680
|
+
type: 'string',
|
|
1681
|
+
},
|
|
1594
1682
|
device_type: {
|
|
1683
|
+
description: 'Type of the device.',
|
|
1595
1684
|
oneOf: [
|
|
1596
1685
|
{
|
|
1597
1686
|
enum: [
|
|
@@ -1634,6 +1723,7 @@ export default {
|
|
|
1634
1723
|
],
|
|
1635
1724
|
},
|
|
1636
1725
|
errors: {
|
|
1726
|
+
description: 'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
|
|
1637
1727
|
items: {
|
|
1638
1728
|
properties: {
|
|
1639
1729
|
error_code: { type: 'string' },
|
|
@@ -1665,6 +1755,7 @@ export default {
|
|
|
1665
1755
|
type: 'object',
|
|
1666
1756
|
},
|
|
1667
1757
|
warnings: {
|
|
1758
|
+
description: 'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
|
|
1668
1759
|
items: {
|
|
1669
1760
|
properties: {
|
|
1670
1761
|
message: { type: 'string' },
|
|
@@ -1675,7 +1766,11 @@ export default {
|
|
|
1675
1766
|
},
|
|
1676
1767
|
type: 'array',
|
|
1677
1768
|
},
|
|
1678
|
-
workspace_id: {
|
|
1769
|
+
workspace_id: {
|
|
1770
|
+
description: 'Unique identifier for the Seam workspace associated with the device.',
|
|
1771
|
+
format: 'uuid',
|
|
1772
|
+
type: 'string',
|
|
1773
|
+
},
|
|
1679
1774
|
},
|
|
1680
1775
|
required: [
|
|
1681
1776
|
'device_id',
|
|
@@ -1734,6 +1829,16 @@ export default {
|
|
|
1734
1829
|
name: 'client-session-token',
|
|
1735
1830
|
type: 'apiKey',
|
|
1736
1831
|
},
|
|
1832
|
+
console_session: {
|
|
1833
|
+
bearerFormat: 'Console Session Token',
|
|
1834
|
+
scheme: 'bearer',
|
|
1835
|
+
type: 'http',
|
|
1836
|
+
},
|
|
1837
|
+
pat_with_workspace: {
|
|
1838
|
+
bearerFormat: 'API Token',
|
|
1839
|
+
scheme: 'bearer',
|
|
1840
|
+
type: 'http',
|
|
1841
|
+
},
|
|
1737
1842
|
seam_client_session_token: {
|
|
1738
1843
|
in: 'header',
|
|
1739
1844
|
name: 'seam-client-session-token',
|
|
@@ -3905,6 +4010,86 @@ export default {
|
|
|
3905
4010
|
'x-fern-sdk-method-name': 'unassign',
|
|
3906
4011
|
},
|
|
3907
4012
|
},
|
|
4013
|
+
'/acs/credentials/update': {
|
|
4014
|
+
post: {
|
|
4015
|
+
operationId: 'acsCredentialsUpdatePost',
|
|
4016
|
+
requestBody: {
|
|
4017
|
+
content: {
|
|
4018
|
+
'application/json': {
|
|
4019
|
+
schema: {
|
|
4020
|
+
properties: {
|
|
4021
|
+
code: { pattern: '^\\d+$', type: 'string' },
|
|
4022
|
+
name: { maxLength: 10, type: 'string' },
|
|
4023
|
+
},
|
|
4024
|
+
type: 'object',
|
|
4025
|
+
},
|
|
4026
|
+
},
|
|
4027
|
+
},
|
|
4028
|
+
},
|
|
4029
|
+
responses: {
|
|
4030
|
+
200: {
|
|
4031
|
+
content: {
|
|
4032
|
+
'application/json': {
|
|
4033
|
+
schema: {
|
|
4034
|
+
properties: {
|
|
4035
|
+
acs_credential: {
|
|
4036
|
+
properties: {
|
|
4037
|
+
acs_credential_id: { format: 'uuid', type: 'string' },
|
|
4038
|
+
acs_credential_pool_id: {
|
|
4039
|
+
format: 'uuid',
|
|
4040
|
+
type: 'string',
|
|
4041
|
+
},
|
|
4042
|
+
acs_system_id: { format: 'uuid', type: 'string' },
|
|
4043
|
+
acs_user_id: { format: 'uuid', type: 'string' },
|
|
4044
|
+
code: { nullable: true, type: 'string' },
|
|
4045
|
+
created_at: { format: 'date-time', type: 'string' },
|
|
4046
|
+
display_name: { minLength: 1, type: 'string' },
|
|
4047
|
+
external_type: {
|
|
4048
|
+
enum: [
|
|
4049
|
+
'pti_card',
|
|
4050
|
+
'brivo_credential',
|
|
4051
|
+
'hid_credential',
|
|
4052
|
+
],
|
|
4053
|
+
type: 'string',
|
|
4054
|
+
},
|
|
4055
|
+
external_type_display_name: { type: 'string' },
|
|
4056
|
+
workspace_id: { format: 'uuid', type: 'string' },
|
|
4057
|
+
},
|
|
4058
|
+
required: [
|
|
4059
|
+
'acs_credential_id',
|
|
4060
|
+
'acs_system_id',
|
|
4061
|
+
'display_name',
|
|
4062
|
+
'code',
|
|
4063
|
+
'external_type',
|
|
4064
|
+
'external_type_display_name',
|
|
4065
|
+
'created_at',
|
|
4066
|
+
'workspace_id',
|
|
4067
|
+
],
|
|
4068
|
+
type: 'object',
|
|
4069
|
+
},
|
|
4070
|
+
ok: { type: 'boolean' },
|
|
4071
|
+
},
|
|
4072
|
+
required: ['acs_credential', 'ok'],
|
|
4073
|
+
type: 'object',
|
|
4074
|
+
},
|
|
4075
|
+
},
|
|
4076
|
+
},
|
|
4077
|
+
description: 'OK',
|
|
4078
|
+
},
|
|
4079
|
+
400: { description: 'Bad Request' },
|
|
4080
|
+
401: { description: 'Unauthorized' },
|
|
4081
|
+
},
|
|
4082
|
+
security: [
|
|
4083
|
+
{ access_token: [], seam_workspace: [] },
|
|
4084
|
+
{ seam_client_session_token: [] },
|
|
4085
|
+
{ client_session_token: [] },
|
|
4086
|
+
],
|
|
4087
|
+
summary: '/acs/credentials/update',
|
|
4088
|
+
tags: [],
|
|
4089
|
+
'x-fern-sdk-group-name': ['acs', 'credentials'],
|
|
4090
|
+
'x-fern-sdk-method-name': 'update',
|
|
4091
|
+
},
|
|
4092
|
+
},
|
|
3908
4093
|
'/acs/entrances/get': {
|
|
3909
4094
|
post: {
|
|
3910
4095
|
operationId: 'acsEntrancesGetPost',
|
|
@@ -4892,9 +5077,10 @@ export default {
|
|
|
4892
5077
|
401: { description: 'Unauthorized' },
|
|
4893
5078
|
},
|
|
4894
5079
|
security: [
|
|
4895
|
-
{
|
|
4896
|
-
{
|
|
4897
|
-
{
|
|
5080
|
+
{ client_session: [] },
|
|
5081
|
+
{ pat_with_workspace: [] },
|
|
5082
|
+
{ console_session: [] },
|
|
5083
|
+
{ api_key: [] },
|
|
4898
5084
|
],
|
|
4899
5085
|
summary: '/client_sessions/get',
|
|
4900
5086
|
tags: ['/client_sessions'],
|
|
@@ -5273,6 +5459,7 @@ export default {
|
|
|
5273
5459
|
'pti',
|
|
5274
5460
|
'wyze',
|
|
5275
5461
|
'seam_passport',
|
|
5462
|
+
'visionline',
|
|
5276
5463
|
'yale_access',
|
|
5277
5464
|
'hid_cm',
|
|
5278
5465
|
],
|
|
@@ -8725,6 +8912,8 @@ export default {
|
|
|
8725
8912
|
nullable: true,
|
|
8726
8913
|
type: 'string',
|
|
8727
8914
|
},
|
|
8915
|
+
first_name: { nullable: true, type: 'string' },
|
|
8916
|
+
last_name: { nullable: true, type: 'string' },
|
|
8728
8917
|
user_identity_key: { nullable: true, type: 'string' },
|
|
8729
8918
|
},
|
|
8730
8919
|
type: 'object',
|
|
@@ -8747,6 +8936,8 @@ export default {
|
|
|
8747
8936
|
nullable: true,
|
|
8748
8937
|
type: 'string',
|
|
8749
8938
|
},
|
|
8939
|
+
first_name: { nullable: true, type: 'string' },
|
|
8940
|
+
last_name: { nullable: true, type: 'string' },
|
|
8750
8941
|
user_identity_id: { format: 'uuid', type: 'string' },
|
|
8751
8942
|
user_identity_key: { nullable: true, type: 'string' },
|
|
8752
8943
|
workspace_id: { format: 'uuid', type: 'string' },
|
|
@@ -8820,6 +9011,8 @@ export default {
|
|
|
8820
9011
|
nullable: true,
|
|
8821
9012
|
type: 'string',
|
|
8822
9013
|
},
|
|
9014
|
+
first_name: { nullable: true, type: 'string' },
|
|
9015
|
+
last_name: { nullable: true, type: 'string' },
|
|
8823
9016
|
user_identity_id: { format: 'uuid', type: 'string' },
|
|
8824
9017
|
user_identity_key: { nullable: true, type: 'string' },
|
|
8825
9018
|
workspace_id: { format: 'uuid', type: 'string' },
|