@seamapi/types 1.714.0 → 1.716.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.
Files changed (27) hide show
  1. package/dist/connect.cjs +93 -76
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +536 -106
  4. package/dist/index.cjs +93 -76
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/batch.d.ts +118 -10
  7. package/lib/seam/connect/models/devices/device-metadata.d.ts +38 -0
  8. package/lib/seam/connect/models/devices/device-metadata.js +17 -0
  9. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  10. package/lib/seam/connect/models/devices/device-provider.d.ts +1 -0
  11. package/lib/seam/connect/models/devices/device-provider.js +1 -0
  12. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  13. package/lib/seam/connect/models/devices/device-type.d.ts +1 -0
  14. package/lib/seam/connect/models/devices/device-type.js +1 -0
  15. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  16. package/lib/seam/connect/models/devices/device.d.ts +57 -3
  17. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +41 -3
  18. package/lib/seam/connect/openapi.d.ts +31 -46
  19. package/lib/seam/connect/openapi.js +65 -58
  20. package/lib/seam/connect/openapi.js.map +1 -1
  21. package/lib/seam/connect/route-types.d.ts +288 -44
  22. package/package.json +1 -1
  23. package/src/lib/seam/connect/models/devices/device-metadata.ts +18 -0
  24. package/src/lib/seam/connect/models/devices/device-provider.ts +1 -0
  25. package/src/lib/seam/connect/models/devices/device-type.ts +1 -0
  26. package/src/lib/seam/connect/openapi.ts +67 -66
  27. package/src/lib/seam/connect/route-types.ts +326 -17
package/lib/seam/connect/openapi.js CHANGED
@@ -8651,6 +8651,7 @@ export default {
8651
8651
  'tedee_lock',
8652
8652
  'akiles_lock',
8653
8653
  'ultraloq_lock',
8654
+ 'korelock_lock',
8654
8655
  ],
8655
8656
  type: 'string',
8656
8657
  },
@@ -9966,6 +9967,37 @@ export default {
9966
9967
  },
9967
9968
  type: 'object',
9968
9969
  },
9970
+ korelock_metadata: {
9971
+ description: 'Metadata for a Korelock device.',
9972
+ properties: {
9973
+ device_id: {
9974
+ description: 'Device ID for a Korelock device.',
9975
+ type: 'string',
9976
+ },
9977
+ device_name: {
9978
+ description: 'Device name for a Korelock device.',
9979
+ type: 'string',
9980
+ },
9981
+ firmware_version: {
9982
+ description: 'Firmware version for a Korelock device.',
9983
+ type: 'string',
9984
+ },
9985
+ model_code: {
9986
+ description: 'Model code for a Korelock device.',
9987
+ type: 'string',
9988
+ },
9989
+ serial_number: {
9990
+ description: 'Serial number for a Korelock device.',
9991
+ type: 'string',
9992
+ },
9993
+ wifi_signal_strength: {
9994
+ description: 'WiFi signal strength (0-1) for a Korelock device.',
9995
+ format: 'float',
9996
+ type: 'number',
9997
+ },
9998
+ },
9999
+ type: 'object',
10000
+ },
9969
10001
  kwikset_metadata: {
9970
10002
  description: 'Metadata for a Kwikset device.',
9971
10003
  properties: {
@@ -12073,6 +12105,7 @@ export default {
12073
12105
  'sensi',
12074
12106
  'kwikset2',
12075
12107
  'keynest',
12108
+ 'korelock',
12076
12109
  'dormakaba_ambiance',
12077
12110
  'ultraloq',
12078
12111
  ],
@@ -22517,6 +22550,7 @@ export default {
22517
22550
  'tedee_lock',
22518
22551
  'akiles_lock',
22519
22552
  'ultraloq_lock',
22553
+ 'korelock_lock',
22520
22554
  ],
22521
22555
  type: 'string',
22522
22556
  },
@@ -24197,20 +24231,6 @@ export default {
24197
24231
  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`.',
24198
24232
  type: 'boolean',
24199
24233
  },
24200
- is_offline_access_code: {
24201
- description: 'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
24202
- type: 'boolean',
24203
- },
24204
- is_one_time_use: {
24205
- description: 'Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
24206
- type: 'boolean',
24207
- },
24208
- max_time_rounding: {
24209
- default: '1hour',
24210
- description: 'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
24211
- enum: ['1hour', '1day', '1h', '1d'],
24212
- type: 'string',
24213
- },
24214
24234
  name: {
24215
24235
  description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
24216
24236
  type: 'string',
@@ -24220,7 +24240,7 @@ export default {
24220
24240
  type: 'boolean',
24221
24241
  },
24222
24242
  preferred_code_length: {
24223
- description: 'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
24243
+ description: 'Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.',
24224
24244
  format: 'float',
24225
24245
  type: 'number',
24226
24246
  },
@@ -24228,15 +24248,6 @@ export default {
24228
24248
  description: 'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
24229
24249
  type: 'string',
24230
24250
  },
24231
- use_backup_access_code_pool: {
24232
- 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).',
24233
- type: 'boolean',
24234
- },
24235
- use_offline_access_code: {
24236
- deprecated: true,
24237
- type: 'boolean',
24238
- 'x-deprecated': 'Use `is_offline_access_code` instead.',
24239
- },
24240
24251
  },
24241
24252
  required: ['device_ids'],
24242
24253
  type: 'object',
@@ -24323,20 +24334,6 @@ export default {
24323
24334
  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`.',
24324
24335
  type: 'boolean',
24325
24336
  },
24326
- is_offline_access_code: {
24327
- description: 'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
24328
- type: 'boolean',
24329
- },
24330
- is_one_time_use: {
24331
- description: 'Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
24332
- type: 'boolean',
24333
- },
24334
- max_time_rounding: {
24335
- default: '1hour',
24336
- description: 'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
24337
- enum: ['1hour', '1day', '1h', '1d'],
24338
- type: 'string',
24339
- },
24340
24337
  name: {
24341
24338
  description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
24342
24339
  type: 'string',
@@ -24346,7 +24343,7 @@ export default {
24346
24343
  type: 'boolean',
24347
24344
  },
24348
24345
  preferred_code_length: {
24349
- description: 'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
24346
+ description: 'Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.',
24350
24347
  format: 'float',
24351
24348
  type: 'number',
24352
24349
  },
@@ -24354,15 +24351,6 @@ export default {
24354
24351
  description: 'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
24355
24352
  type: 'string',
24356
24353
  },
24357
- use_backup_access_code_pool: {
24358
- 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).',
24359
- type: 'boolean',
24360
- },
24361
- use_offline_access_code: {
24362
- deprecated: true,
24363
- type: 'boolean',
24364
- 'x-deprecated': 'Use `is_offline_access_code` instead.',
24365
- },
24366
24354
  },
24367
24355
  required: ['device_ids'],
24368
24356
  type: 'object',
@@ -37272,6 +37260,7 @@ export default {
37272
37260
  'sensi',
37273
37261
  'kwikset2',
37274
37262
  'keynest',
37263
+ 'korelock',
37275
37264
  'dormakaba_ambiance',
37276
37265
  'ultraloq',
37277
37266
  'yale_access',
@@ -40856,6 +40845,7 @@ export default {
40856
40845
  'tedee_lock',
40857
40846
  'akiles_lock',
40858
40847
  'ultraloq_lock',
40848
+ 'korelock_lock',
40859
40849
  ],
40860
40850
  type: 'string',
40861
40851
  },
@@ -40927,6 +40917,7 @@ export default {
40927
40917
  'tedee_lock',
40928
40918
  'akiles_lock',
40929
40919
  'ultraloq_lock',
40920
+ 'korelock_lock',
40930
40921
  ],
40931
40922
  type: 'string',
40932
40923
  },
@@ -41000,14 +40991,15 @@ export default {
41000
40991
  'akiles',
41001
40992
  'ecobee',
41002
40993
  'honeywell_resideo',
40994
+ 'keynest',
40995
+ 'korelock',
41003
40996
  'kwikset2',
41004
40997
  'minut',
41005
40998
  'nest',
41006
40999
  'noiseaware',
41007
- 'tado',
41008
41000
  'sensi',
41009
41001
  'smartthings',
41010
- 'keynest',
41002
+ 'tado',
41011
41003
  'ultraloq',
41012
41004
  ],
41013
41005
  type: 'string',
@@ -41279,6 +41271,7 @@ export default {
41279
41271
  'tedee_lock',
41280
41272
  'akiles_lock',
41281
41273
  'ultraloq_lock',
41274
+ 'korelock_lock',
41282
41275
  ],
41283
41276
  type: 'string',
41284
41277
  },
@@ -41346,6 +41339,7 @@ export default {
41346
41339
  'tedee_lock',
41347
41340
  'akiles_lock',
41348
41341
  'ultraloq_lock',
41342
+ 'korelock_lock',
41349
41343
  ],
41350
41344
  type: 'string',
41351
41345
  },
@@ -41477,14 +41471,15 @@ export default {
41477
41471
  'akiles',
41478
41472
  'ecobee',
41479
41473
  'honeywell_resideo',
41474
+ 'keynest',
41475
+ 'korelock',
41480
41476
  'kwikset2',
41481
41477
  'minut',
41482
41478
  'nest',
41483
41479
  'noiseaware',
41484
- 'tado',
41485
41480
  'sensi',
41486
41481
  'smartthings',
41487
- 'keynest',
41482
+ 'tado',
41488
41483
  'ultraloq',
41489
41484
  ],
41490
41485
  type: 'string',
@@ -42675,6 +42670,7 @@ export default {
42675
42670
  'tedee_lock',
42676
42671
  'akiles_lock',
42677
42672
  'ultraloq_lock',
42673
+ 'korelock_lock',
42678
42674
  ],
42679
42675
  type: 'string',
42680
42676
  },
@@ -42746,6 +42742,7 @@ export default {
42746
42742
  'tedee_lock',
42747
42743
  'akiles_lock',
42748
42744
  'ultraloq_lock',
42745
+ 'korelock_lock',
42749
42746
  ],
42750
42747
  type: 'string',
42751
42748
  },
@@ -42819,14 +42816,15 @@ export default {
42819
42816
  'akiles',
42820
42817
  'ecobee',
42821
42818
  'honeywell_resideo',
42819
+ 'keynest',
42820
+ 'korelock',
42822
42821
  'kwikset2',
42823
42822
  'minut',
42824
42823
  'nest',
42825
42824
  'noiseaware',
42826
- 'tado',
42827
42825
  'sensi',
42828
42826
  'smartthings',
42829
- 'keynest',
42827
+ 'tado',
42830
42828
  'ultraloq',
42831
42829
  ],
42832
42830
  type: 'string',
@@ -43097,6 +43095,7 @@ export default {
43097
43095
  'tedee_lock',
43098
43096
  'akiles_lock',
43099
43097
  'ultraloq_lock',
43098
+ 'korelock_lock',
43100
43099
  ],
43101
43100
  type: 'string',
43102
43101
  },
@@ -43164,6 +43163,7 @@ export default {
43164
43163
  'tedee_lock',
43165
43164
  'akiles_lock',
43166
43165
  'ultraloq_lock',
43166
+ 'korelock_lock',
43167
43167
  ],
43168
43168
  type: 'string',
43169
43169
  },
@@ -43295,14 +43295,15 @@ export default {
43295
43295
  'akiles',
43296
43296
  'ecobee',
43297
43297
  'honeywell_resideo',
43298
+ 'keynest',
43299
+ 'korelock',
43298
43300
  'kwikset2',
43299
43301
  'minut',
43300
43302
  'nest',
43301
43303
  'noiseaware',
43302
- 'tado',
43303
43304
  'sensi',
43304
43305
  'smartthings',
43305
- 'keynest',
43306
+ 'tado',
43306
43307
  'ultraloq',
43307
43308
  ],
43308
43309
  type: 'string',
@@ -45203,6 +45204,7 @@ export default {
45203
45204
  'tedee_lock',
45204
45205
  'akiles_lock',
45205
45206
  'ultraloq_lock',
45207
+ 'korelock_lock',
45206
45208
  ],
45207
45209
  type: 'string',
45208
45210
  },
@@ -45243,6 +45245,7 @@ export default {
45243
45245
  'tedee_lock',
45244
45246
  'akiles_lock',
45245
45247
  'ultraloq_lock',
45248
+ 'korelock_lock',
45246
45249
  ],
45247
45250
  type: 'string',
45248
45251
  },
@@ -45281,6 +45284,7 @@ export default {
45281
45284
  'dormakaba_oracode',
45282
45285
  'tedee',
45283
45286
  'akiles',
45287
+ 'korelock',
45284
45288
  'kwikset2',
45285
45289
  'smartthings',
45286
45290
  'ultraloq',
@@ -45553,6 +45557,7 @@ export default {
45553
45557
  'tedee_lock',
45554
45558
  'akiles_lock',
45555
45559
  'ultraloq_lock',
45560
+ 'korelock_lock',
45556
45561
  ],
45557
45562
  type: 'string',
45558
45563
  },
@@ -45589,6 +45594,7 @@ export default {
45589
45594
  'tedee_lock',
45590
45595
  'akiles_lock',
45591
45596
  'ultraloq_lock',
45597
+ 'korelock_lock',
45592
45598
  ],
45593
45599
  type: 'string',
45594
45600
  },
@@ -45685,6 +45691,7 @@ export default {
45685
45691
  'dormakaba_oracode',
45686
45692
  'tedee',
45687
45693
  'akiles',
45694
+ 'korelock',
45688
45695
  'kwikset2',
45689
45696
  'smartthings',
45690
45697
  'ultraloq',
@@ -58007,9 +58014,9 @@ export default {
58007
58014
  'ecobee',
58008
58015
  'honeywell_resideo',
58009
58016
  'nest',
58010
- 'tado',
58011
58017
  'sensi',
58012
58018
  'smartthings',
58019
+ 'tado',
58013
58020
  ],
58014
58021
  type: 'string',
58015
58022
  },
@@ -58344,9 +58351,9 @@ export default {
58344
58351
  'ecobee',
58345
58352
  'honeywell_resideo',
58346
58353
  'nest',
58347
- 'tado',
58348
58354
  'sensi',
58349
58355
  'smartthings',
58356
+ 'tado',
58350
58357
  ],
58351
58358
  type: 'string',
58352
58359
  },