@seamapi/types 1.57.0 → 1.58.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.
@@ -480,7 +480,7 @@ export default {
480
480
  device: {
481
481
  properties: {
482
482
  capabilities_supported: {
483
- description: 'Deprecated. Use enabled_capabilities.',
483
+ 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.',
484
484
  items: {
485
485
  enum: [
486
486
  'access_code',
@@ -551,20 +551,6 @@ export default {
551
551
  },
552
552
  ],
553
553
  },
554
- enabled_capabilities: {
555
- description: 'Collection of capabilities that the device has enabled, reflecting its present configuration. 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.',
556
- items: {
557
- enum: [
558
- 'access_code',
559
- 'lock',
560
- 'noise_detection',
561
- 'thermostat',
562
- 'battery',
563
- ],
564
- type: 'string',
565
- },
566
- type: 'array',
567
- },
568
554
  errors: {
569
555
  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.',
570
556
  items: {
@@ -1504,20 +1490,6 @@ export default {
1504
1490
  ],
1505
1491
  description: 'Properties of the device.',
1506
1492
  },
1507
- supported_capabilities: {
1508
- 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.',
1509
- items: {
1510
- enum: [
1511
- 'access_code',
1512
- 'lock',
1513
- 'noise_detection',
1514
- 'thermostat',
1515
- 'battery',
1516
- ],
1517
- type: 'string',
1518
- },
1519
- type: 'array',
1520
- },
1521
1493
  warnings: {
1522
1494
  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.',
1523
1495
  items: {
@@ -1540,8 +1512,6 @@ export default {
1540
1512
  'device_id',
1541
1513
  'device_type',
1542
1514
  'capabilities_supported',
1543
- 'enabled_capabilities',
1544
- 'supported_capabilities',
1545
1515
  'properties',
1546
1516
  'location',
1547
1517
  'connected_account_id',
@@ -1688,7 +1658,7 @@ export default {
1688
1658
  unmanaged_device: {
1689
1659
  properties: {
1690
1660
  capabilities_supported: {
1691
- description: 'Deprecated. Use enabled_capabilities.',
1661
+ 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.',
1692
1662
  items: {
1693
1663
  enum: [
1694
1664
  'access_code',
@@ -1759,20 +1729,6 @@ export default {
1759
1729
  },
1760
1730
  ],
1761
1731
  },
1762
- enabled_capabilities: {
1763
- description: 'Collection of capabilities that the device has enabled, reflecting its present configuration. 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.',
1764
- items: {
1765
- enum: [
1766
- 'access_code',
1767
- 'lock',
1768
- 'noise_detection',
1769
- 'thermostat',
1770
- 'battery',
1771
- ],
1772
- type: 'string',
1773
- },
1774
- type: 'array',
1775
- },
1776
1732
  errors: {
1777
1733
  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.',
1778
1734
  items: {
@@ -1838,7 +1794,6 @@ export default {
1838
1794
  'device_type',
1839
1795
  'connected_account_id',
1840
1796
  'capabilities_supported',
1841
- 'enabled_capabilities',
1842
1797
  'workspace_id',
1843
1798
  'errors',
1844
1799
  'warnings',
@@ -3503,7 +3458,6 @@ export default {
3503
3458
  'acs_credential_id',
3504
3459
  'acs_system_id',
3505
3460
  'display_name',
3506
- 'code',
3507
3461
  'external_type',
3508
3462
  'external_type_display_name',
3509
3463
  'created_at',
@@ -3581,7 +3535,6 @@ export default {
3581
3535
  'acs_credential_id',
3582
3536
  'acs_system_id',
3583
3537
  'display_name',
3584
- 'code',
3585
3538
  'external_type',
3586
3539
  'external_type_display_name',
3587
3540
  'created_at',
@@ -3662,7 +3615,6 @@ export default {
3662
3615
  'acs_credential_id',
3663
3616
  'acs_system_id',
3664
3617
  'display_name',
3665
- 'code',
3666
3618
  'external_type',
3667
3619
  'external_type_display_name',
3668
3620
  'created_at',
@@ -3785,7 +3737,6 @@ export default {
3785
3737
  'acs_credential_id',
3786
3738
  'acs_system_id',
3787
3739
  'display_name',
3788
- 'code',
3789
3740
  'external_type',
3790
3741
  'external_type_display_name',
3791
3742
  'created_at',
@@ -3885,7 +3836,6 @@ export default {
3885
3836
  'acs_credential_id',
3886
3837
  'acs_system_id',
3887
3838
  'display_name',
3888
- 'code',
3889
3839
  'external_type',
3890
3840
  'external_type_display_name',
3891
3841
  'created_at',
@@ -3969,7 +3919,6 @@ export default {
3969
3919
  'acs_credential_id',
3970
3920
  'acs_system_id',
3971
3921
  'display_name',
3972
- 'code',
3973
3922
  'external_type',
3974
3923
  'external_type_display_name',
3975
3924
  'created_at',
@@ -4047,7 +3996,6 @@ export default {
4047
3996
  'acs_credential_id',
4048
3997
  'acs_system_id',
4049
3998
  'display_name',
4050
- 'code',
4051
3999
  'external_type',
4052
4000
  'external_type_display_name',
4053
4001
  'created_at',
@@ -4079,6 +4027,83 @@ export default {
4079
4027
  },
4080
4028
  },
4081
4029
  '/acs/credentials/update': {
4030
+ patch: {
4031
+ operationId: 'acsCredentialsUpdatePatch',
4032
+ requestBody: {
4033
+ content: {
4034
+ 'application/json': {
4035
+ schema: {
4036
+ properties: {
4037
+ acs_credential_id: { type: 'string' },
4038
+ code: { pattern: '^\\d+$', type: 'string' },
4039
+ },
4040
+ required: ['acs_credential_id', 'code'],
4041
+ type: 'object',
4042
+ },
4043
+ },
4044
+ },
4045
+ },
4046
+ responses: {
4047
+ 200: {
4048
+ content: {
4049
+ 'application/json': {
4050
+ schema: {
4051
+ properties: {
4052
+ acs_credential: {
4053
+ properties: {
4054
+ acs_credential_id: { format: 'uuid', type: 'string' },
4055
+ acs_credential_pool_id: {
4056
+ format: 'uuid',
4057
+ type: 'string',
4058
+ },
4059
+ acs_system_id: { format: 'uuid', type: 'string' },
4060
+ acs_user_id: { format: 'uuid', type: 'string' },
4061
+ code: { nullable: true, type: 'string' },
4062
+ created_at: { format: 'date-time', type: 'string' },
4063
+ display_name: { minLength: 1, type: 'string' },
4064
+ external_type: {
4065
+ enum: [
4066
+ 'pti_card',
4067
+ 'brivo_credential',
4068
+ 'hid_credential',
4069
+ ],
4070
+ type: 'string',
4071
+ },
4072
+ external_type_display_name: { type: 'string' },
4073
+ workspace_id: { format: 'uuid', type: 'string' },
4074
+ },
4075
+ required: [
4076
+ 'acs_credential_id',
4077
+ 'acs_system_id',
4078
+ 'display_name',
4079
+ 'external_type',
4080
+ 'external_type_display_name',
4081
+ 'created_at',
4082
+ 'workspace_id',
4083
+ ],
4084
+ type: 'object',
4085
+ },
4086
+ ok: { type: 'boolean' },
4087
+ },
4088
+ required: ['acs_credential', 'ok'],
4089
+ type: 'object',
4090
+ },
4091
+ },
4092
+ },
4093
+ description: 'OK',
4094
+ },
4095
+ 400: { description: 'Bad Request' },
4096
+ 401: { description: 'Unauthorized' },
4097
+ },
4098
+ security: [
4099
+ { access_token: [], seam_workspace: [] },
4100
+ { seam_client_session_token: [] },
4101
+ { client_session_token: [] },
4102
+ ],
4103
+ summary: '/acs/credentials/update',
4104
+ tags: [],
4105
+ 'x-fern-ignore': true,
4106
+ },
4082
4107
  post: {
4083
4108
  operationId: 'acsCredentialsUpdatePost',
4084
4109
  requestBody: {
@@ -4086,9 +4111,10 @@ export default {
4086
4111
  'application/json': {
4087
4112
  schema: {
4088
4113
  properties: {
4114
+ acs_credential_id: { type: 'string' },
4089
4115
  code: { pattern: '^\\d+$', type: 'string' },
4090
- name: { maxLength: 10, type: 'string' },
4091
4116
  },
4117
+ required: ['acs_credential_id', 'code'],
4092
4118
  type: 'object',
4093
4119
  },
4094
4120
  },
@@ -4127,7 +4153,6 @@ export default {
4127
4153
  'acs_credential_id',
4128
4154
  'acs_system_id',
4129
4155
  'display_name',
4130
- 'code',
4131
4156
  'external_type',
4132
4157
  'external_type_display_name',
4133
4158
  'created_at',