@seamapi/types 1.406.4 → 1.406.5

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.
Files changed (10) hide show
  1. package/dist/connect.cjs +86 -36
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +44 -12
  4. package/lib/seam/connect/openapi.d.ts +23 -0
  5. package/lib/seam/connect/openapi.js +80 -30
  6. package/lib/seam/connect/openapi.js.map +1 -1
  7. package/lib/seam/connect/route-types.d.ts +21 -12
  8. package/package.json +1 -1
  9. package/src/lib/seam/connect/openapi.ts +91 -30
  10. package/src/lib/seam/connect/route-types.ts +21 -12
package/lib/seam/connect/openapi.js CHANGED
@@ -18737,7 +18737,7 @@ export default {
18737
18737
  schema: {
18738
18738
  properties: {
18739
18739
  allow_external_modification: {
18740
- description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
18740
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
18741
18741
  type: 'boolean',
18742
18742
  },
18743
18743
  attempt_for_offline_device: {
@@ -18765,7 +18765,7 @@ export default {
18765
18765
  type: 'string',
18766
18766
  },
18767
18767
  is_external_modification_allowed: {
18768
- description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
18768
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
18769
18769
  type: 'boolean',
18770
18770
  },
18771
18771
  is_offline_access_code: {
@@ -18805,7 +18805,7 @@ export default {
18805
18805
  'x-undocumented': 'Only used internally.',
18806
18806
  },
18807
18807
  use_backup_access_code_pool: {
18808
- description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).',
18808
+ description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
18809
18809
  type: 'boolean',
18810
18810
  },
18811
18811
  use_offline_access_code: { type: 'boolean' },
@@ -18864,7 +18864,7 @@ export default {
18864
18864
  schema: {
18865
18865
  properties: {
18866
18866
  allow_external_modification: {
18867
- description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
18867
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
18868
18868
  type: 'boolean',
18869
18869
  },
18870
18870
  attempt_for_offline_device: {
@@ -18894,7 +18894,7 @@ export default {
18894
18894
  type: 'string',
18895
18895
  },
18896
18896
  is_external_modification_allowed: {
18897
- description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
18897
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
18898
18898
  type: 'boolean',
18899
18899
  },
18900
18900
  is_offline_access_code: {
@@ -18929,7 +18929,7 @@ export default {
18929
18929
  type: 'string',
18930
18930
  },
18931
18931
  use_backup_access_code_pool: {
18932
- description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).',
18932
+ description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
18933
18933
  type: 'boolean',
18934
18934
  },
18935
18935
  use_offline_access_code: { type: 'boolean' },
@@ -18985,7 +18985,7 @@ export default {
18985
18985
  schema: {
18986
18986
  properties: {
18987
18987
  allow_external_modification: {
18988
- description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
18988
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
18989
18989
  type: 'boolean',
18990
18990
  },
18991
18991
  attempt_for_offline_device: {
@@ -19015,7 +19015,7 @@ export default {
19015
19015
  type: 'string',
19016
19016
  },
19017
19017
  is_external_modification_allowed: {
19018
- description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
19018
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
19019
19019
  type: 'boolean',
19020
19020
  },
19021
19021
  is_offline_access_code: {
@@ -19050,7 +19050,7 @@ export default {
19050
19050
  type: 'string',
19051
19051
  },
19052
19052
  use_backup_access_code_pool: {
19053
- description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).',
19053
+ description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
19054
19054
  type: 'boolean',
19055
19055
  },
19056
19056
  use_offline_access_code: { type: 'boolean' },
@@ -20022,7 +20022,7 @@ export default {
20022
20022
  type: 'string',
20023
20023
  },
20024
20024
  allow_external_modification: {
20025
- description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
20025
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
20026
20026
  type: 'boolean',
20027
20027
  },
20028
20028
  attempt_for_offline_device: {
@@ -20046,7 +20046,7 @@ export default {
20046
20046
  type: 'string',
20047
20047
  },
20048
20048
  is_external_modification_allowed: {
20049
- description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
20049
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
20050
20050
  type: 'boolean',
20051
20051
  },
20052
20052
  is_managed: {
@@ -20095,7 +20095,7 @@ export default {
20095
20095
  type: 'string',
20096
20096
  },
20097
20097
  use_backup_access_code_pool: {
20098
- description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).',
20098
+ description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
20099
20099
  type: 'boolean',
20100
20100
  },
20101
20101
  use_offline_access_code: { type: 'boolean' },
@@ -20154,7 +20154,7 @@ export default {
20154
20154
  type: 'string',
20155
20155
  },
20156
20156
  allow_external_modification: {
20157
- description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
20157
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
20158
20158
  type: 'boolean',
20159
20159
  },
20160
20160
  attempt_for_offline_device: {
@@ -20178,7 +20178,7 @@ export default {
20178
20178
  type: 'string',
20179
20179
  },
20180
20180
  is_external_modification_allowed: {
20181
- description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
20181
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
20182
20182
  type: 'boolean',
20183
20183
  },
20184
20184
  is_managed: {
@@ -20227,7 +20227,7 @@ export default {
20227
20227
  type: 'string',
20228
20228
  },
20229
20229
  use_backup_access_code_pool: {
20230
- description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).',
20230
+ description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
20231
20231
  type: 'boolean',
20232
20232
  },
20233
20233
  use_offline_access_code: { type: 'boolean' },
@@ -20287,7 +20287,7 @@ export default {
20287
20287
  type: 'string',
20288
20288
  },
20289
20289
  allow_external_modification: {
20290
- description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
20290
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
20291
20291
  type: 'boolean',
20292
20292
  },
20293
20293
  attempt_for_offline_device: {
@@ -20311,7 +20311,7 @@ export default {
20311
20311
  type: 'string',
20312
20312
  },
20313
20313
  is_external_modification_allowed: {
20314
- description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
20314
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
20315
20315
  type: 'boolean',
20316
20316
  },
20317
20317
  is_managed: {
@@ -20360,7 +20360,7 @@ export default {
20360
20360
  type: 'string',
20361
20361
  },
20362
20362
  use_backup_access_code_pool: {
20363
- description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).',
20363
+ description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
20364
20364
  type: 'boolean',
20365
20365
  },
20366
20366
  use_offline_access_code: { type: 'boolean' },
@@ -27578,14 +27578,22 @@ export default {
27578
27578
  },
27579
27579
  '/locks/get': {
27580
27580
  post: {
27581
+ description: 'Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks). **Use `/devices/get` instead.**',
27581
27582
  operationId: 'locksGetPost',
27582
27583
  requestBody: {
27583
27584
  content: {
27584
27585
  'application/json': {
27585
27586
  schema: {
27586
27587
  properties: {
27587
- device_id: { format: 'uuid', type: 'string' },
27588
- name: { type: 'string' },
27588
+ device_id: {
27589
+ description: 'ID of the lock that you want to get.',
27590
+ format: 'uuid',
27591
+ type: 'string',
27592
+ },
27593
+ name: {
27594
+ description: 'Name of the lock that you want to get.',
27595
+ type: 'string',
27596
+ },
27589
27597
  },
27590
27598
  type: 'object',
27591
27599
  },
@@ -27625,10 +27633,12 @@ export default {
27625
27633
  'x-fern-sdk-method-name': 'get',
27626
27634
  'x-fern-sdk-return-value': 'device',
27627
27635
  'x-response-key': 'device',
27636
+ 'x-title': 'Get a Lock',
27628
27637
  },
27629
27638
  },
27630
27639
  '/locks/list': {
27631
27640
  post: {
27641
+ description: 'Returns a list of all [locks](https://docs.seam.co/latest/capability-guides/smart-locks).',
27632
27642
  operationId: 'locksListPost',
27633
27643
  requestBody: {
27634
27644
  content: {
@@ -27672,7 +27682,7 @@ export default {
27672
27682
  type: 'array',
27673
27683
  },
27674
27684
  device_type: {
27675
- description: 'Device type by which to filter devices.',
27685
+ description: 'Device type of the locks that you want to list.',
27676
27686
  enum: [
27677
27687
  'akuvox_lock',
27678
27688
  'august_lock',
@@ -27705,7 +27715,7 @@ export default {
27705
27715
  type: 'string',
27706
27716
  },
27707
27717
  device_types: {
27708
- description: 'Array of device types by which to filter devices.',
27718
+ description: 'Device types of the locks that you want to list.',
27709
27719
  items: {
27710
27720
  description: 'Device type for smartlocks.\n ',
27711
27721
  enum: [
@@ -27788,7 +27798,7 @@ export default {
27788
27798
  type: 'number',
27789
27799
  },
27790
27800
  manufacturer: {
27791
- description: 'Manufacturer by which to filter devices.',
27801
+ description: 'Manufacturer of the locks that you want to list.',
27792
27802
  enum: [
27793
27803
  'akuvox',
27794
27804
  'august',
@@ -27881,18 +27891,28 @@ export default {
27881
27891
  'x-fern-sdk-method-name': 'list',
27882
27892
  'x-fern-sdk-return-value': 'devices',
27883
27893
  'x-response-key': 'devices',
27894
+ 'x-title': 'List Locks',
27884
27895
  },
27885
27896
  },
27886
27897
  '/locks/lock_door': {
27887
27898
  post: {
27899
+ description: 'Locks a [lock](https://docs.seam.co/latest/capability-guides/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock).',
27888
27900
  operationId: 'locksLockDoorPost',
27889
27901
  requestBody: {
27890
27902
  content: {
27891
27903
  'application/json': {
27892
27904
  schema: {
27893
27905
  properties: {
27894
- device_id: { format: 'uuid', type: 'string' },
27895
- sync: { default: false, type: 'boolean' },
27906
+ device_id: {
27907
+ description: 'ID of the lock that you want to lock.',
27908
+ format: 'uuid',
27909
+ type: 'string',
27910
+ },
27911
+ sync: {
27912
+ default: false,
27913
+ type: 'boolean',
27914
+ 'x-undocumented': 'Only used internally.',
27915
+ },
27896
27916
  },
27897
27917
  required: ['device_id'],
27898
27918
  type: 'object',
@@ -27934,18 +27954,27 @@ export default {
27934
27954
  'x-fern-sdk-method-name': 'lock_door',
27935
27955
  'x-fern-sdk-return-value': 'action_attempt',
27936
27956
  'x-response-key': 'action_attempt',
27957
+ 'x-title': 'Lock a Lock',
27937
27958
  },
27938
27959
  },
27939
27960
  '/locks/simulate/keypad_code_entry': {
27940
27961
  post: {
27962
+ description: 'Simulates the entry of a code on a keypad. You can only perform this action for [August](https://docs.seam.co/latest/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
27941
27963
  operationId: 'locksSimulateKeypadCodeEntryPost',
27942
27964
  requestBody: {
27943
27965
  content: {
27944
27966
  'application/json': {
27945
27967
  schema: {
27946
27968
  properties: {
27947
- code: { type: 'string' },
27948
- device_id: { format: 'uuid', type: 'string' },
27969
+ code: {
27970
+ description: 'Code that you want to simulate entering on a keypad.',
27971
+ type: 'string',
27972
+ },
27973
+ device_id: {
27974
+ description: 'ID of the device for which you want to simulate a keypad code entry.',
27975
+ format: 'uuid',
27976
+ type: 'string',
27977
+ },
27949
27978
  },
27950
27979
  required: ['device_id', 'code'],
27951
27980
  type: 'object',
@@ -27991,12 +28020,19 @@ export default {
27991
28020
  },
27992
28021
  '/locks/simulate/manual_lock_via_keypad': {
27993
28022
  post: {
28023
+ description: 'Simulates a manual lock action using a keypad. You can only perform this action for [August](https://docs.seam.co/latest/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
27994
28024
  operationId: 'locksSimulateManualLockViaKeypadPost',
27995
28025
  requestBody: {
27996
28026
  content: {
27997
28027
  'application/json': {
27998
28028
  schema: {
27999
- properties: { device_id: { format: 'uuid', type: 'string' } },
28029
+ properties: {
28030
+ device_id: {
28031
+ description: 'ID of the device for which you want to simulate a manual lock action using a keypad.',
28032
+ format: 'uuid',
28033
+ type: 'string',
28034
+ },
28035
+ },
28000
28036
  required: ['device_id'],
28001
28037
  type: 'object',
28002
28038
  },
@@ -28041,14 +28077,23 @@ export default {
28041
28077
  },
28042
28078
  '/locks/unlock_door': {
28043
28079
  post: {
28080
+ description: 'Unlocks a [lock](https://docs.seam.co/latest/capability-guides/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock).',
28044
28081
  operationId: 'locksUnlockDoorPost',
28045
28082
  requestBody: {
28046
28083
  content: {
28047
28084
  'application/json': {
28048
28085
  schema: {
28049
28086
  properties: {
28050
- device_id: { format: 'uuid', type: 'string' },
28051
- sync: { default: false, type: 'boolean' },
28087
+ device_id: {
28088
+ description: 'ID of the lock that you want to unlock.',
28089
+ format: 'uuid',
28090
+ type: 'string',
28091
+ },
28092
+ sync: {
28093
+ default: false,
28094
+ type: 'boolean',
28095
+ 'x-undocumented': 'Only used internally.',
28096
+ },
28052
28097
  },
28053
28098
  required: ['device_id'],
28054
28099
  type: 'object',
@@ -28090,6 +28135,7 @@ export default {
28090
28135
  'x-fern-sdk-method-name': 'unlock_door',
28091
28136
  'x-fern-sdk-return-value': 'action_attempt',
28092
28137
  'x-response-key': 'action_attempt',
28138
+ 'x-title': 'Unlock a Lock',
28093
28139
  },
28094
28140
  },
28095
28141
  '/networks/get': {
@@ -28132,10 +28178,12 @@ export default {
28132
28178
  ],
28133
28179
  summary: '/networks/get',
28134
28180
  tags: ['/networks'],
28181
+ 'x-deprecated': 'Will be removed.',
28135
28182
  'x-fern-sdk-group-name': ['networks'],
28136
28183
  'x-fern-sdk-method-name': 'get',
28137
28184
  'x-fern-sdk-return-value': 'network',
28138
28185
  'x-response-key': 'network',
28186
+ 'x-undocumented': 'Deprecated.',
28139
28187
  },
28140
28188
  },
28141
28189
  '/networks/list': {
@@ -28175,10 +28223,12 @@ export default {
28175
28223
  ],
28176
28224
  summary: '/networks/list',
28177
28225
  tags: ['/networks'],
28226
+ 'x-deprecated': 'Will be removed.',
28178
28227
  'x-fern-sdk-group-name': ['networks'],
28179
28228
  'x-fern-sdk-method-name': 'list',
28180
28229
  'x-fern-sdk-return-value': 'networks',
28181
28230
  'x-response-key': 'networks',
28231
+ 'x-undocumented': 'Deprecated.',
28182
28232
  },
28183
28233
  },
28184
28234
  '/noise_sensors/list': {