@seamapi/types 1.867.0 → 1.868.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 CHANGED
@@ -1313,7 +1313,14 @@ var common_device_error = zod.z.object({
1313
1313
  var error_code_description2 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
1314
1314
  var device_offline = common_device_error.extend({
1315
1315
  error_code: zod.z.literal("device_offline").describe(error_code_description2)
1316
- }).describe("Indicates that the device is offline.");
1316
+ }).describe(
1317
+ `
1318
+ ---
1319
+ deprecated: Use \`device_disconnected\` instead.
1320
+ ---
1321
+ Indicates that the device is offline.
1322
+ `
1323
+ );
1317
1324
  var device_removed = common_device_error.extend({
1318
1325
  error_code: zod.z.literal("device_removed").describe(error_code_description2)
1319
1326
  }).describe("Indicates that the device has been removed.");
@@ -1350,6 +1357,7 @@ var august_lock_missing_bridge = common_device_error.extend({
1350
1357
  error_code: zod.z.literal("august_lock_missing_bridge").describe(error_code_description2)
1351
1358
  }).describe(`
1352
1359
  ---
1360
+ deprecated: Use \`hub_disconnected\` instead.
1353
1361
  variant_group_key: locks
1354
1362
  ---
1355
1363
  Indicates that the lock is not connected to a bridge.
@@ -1369,6 +1377,9 @@ var salto_ks_subscription_limit_exceeded2 = common_device_error.extend({
1369
1377
  var ttlock_lock_not_paired_to_gateway = common_device_error.extend({
1370
1378
  error_code: zod.z.literal("ttlock_lock_not_paired_to_gateway").describe(error_code_description2)
1371
1379
  }).describe(`
1380
+ ---
1381
+ deprecated: Use \`hub_disconnected\` instead.
1382
+ ---
1372
1383
  Indicates that the lock is not paired with a gateway.
1373
1384
  `);
1374
1385
  var missing_device_credentials = common_device_error.extend({
@@ -1388,6 +1399,9 @@ var subscription_required = common_device_error.extend({
1388
1399
  var lockly_missing_wifi_bridge = common_device_error.extend({
1389
1400
  error_code: zod.z.literal("lockly_missing_wifi_bridge").describe(error_code_description2)
1390
1401
  }).describe(`
1402
+ ---
1403
+ deprecated: Use \`hub_disconnected\` instead.
1404
+ ---
1391
1405
  Indicates that the Lockly lock is not connected to a Wi-Fi bridge.
1392
1406
  `);
1393
1407
  var device_error = zod.z.discriminatedUnion("error_code", [
@@ -1477,6 +1491,9 @@ var salto_ks_lock_access_code_support_removed = common_device_warning.extend({
1477
1491
  var wyze_device_missing_gateway = common_device_warning.extend({
1478
1492
  warning_code: zod.z.literal("wyze_device_missing_gateway").describe(warning_code_description2)
1479
1493
  }).describe(`
1494
+ ---
1495
+ deprecated: Use \`hub_disconnected\` device error instead.
1496
+ ---
1480
1497
  Indicates that the Wyze Lock is not connected to a gateway.
1481
1498
  `);
1482
1499
  var third_party_integration_detected = common_device_warning.extend({
@@ -7755,6 +7772,7 @@ var openapi = {
7755
7772
  "x-variant-group-key": "locks"
7756
7773
  },
7757
7774
  {
7775
+ deprecated: true,
7758
7776
  description: "Indicates that the device is offline.",
7759
7777
  properties: {
7760
7778
  created_at: {
@@ -7783,7 +7801,8 @@ var openapi = {
7783
7801
  "created_at",
7784
7802
  "error_code"
7785
7803
  ],
7786
- type: "object"
7804
+ type: "object",
7805
+ "x-deprecated": "Use `device_disconnected` instead."
7787
7806
  },
7788
7807
  {
7789
7808
  description: "Indicates that the device has been removed.",
@@ -7943,6 +7962,7 @@ var openapi = {
7943
7962
  "x-variant-group-key": "locks"
7944
7963
  },
7945
7964
  {
7965
+ deprecated: true,
7946
7966
  description: "Indicates that the lock is not connected to a bridge.",
7947
7967
  properties: {
7948
7968
  created_at: {
@@ -7972,10 +7992,12 @@ var openapi = {
7972
7992
  "error_code"
7973
7993
  ],
7974
7994
  type: "object",
7995
+ "x-deprecated": "Use `hub_disconnected` instead.",
7975
7996
  "x-variant-group-key": "locks"
7976
7997
  },
7977
7998
  {
7978
- description: "\n Indicates that the lock is not paired with a gateway.\n ",
7999
+ deprecated: true,
8000
+ description: "Indicates that the lock is not paired with a gateway.",
7979
8001
  properties: {
7980
8002
  created_at: {
7981
8003
  description: "Date and time at which Seam created the error.",
@@ -8003,7 +8025,8 @@ var openapi = {
8003
8025
  "created_at",
8004
8026
  "error_code"
8005
8027
  ],
8006
- type: "object"
8028
+ type: "object",
8029
+ "x-deprecated": "Use `hub_disconnected` instead."
8007
8030
  },
8008
8031
  {
8009
8032
  description: "Indicates that device credentials are missing.",
@@ -8100,7 +8123,8 @@ var openapi = {
8100
8123
  type: "object"
8101
8124
  },
8102
8125
  {
8103
- description: "\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ",
8126
+ deprecated: true,
8127
+ description: "Indicates that the Lockly lock is not connected to a Wi-Fi bridge.",
8104
8128
  properties: {
8105
8129
  created_at: {
8106
8130
  description: "Date and time at which Seam created the error.",
@@ -8128,7 +8152,8 @@ var openapi = {
8128
8152
  "created_at",
8129
8153
  "error_code"
8130
8154
  ],
8131
- type: "object"
8155
+ type: "object",
8156
+ "x-deprecated": "Use `hub_disconnected` instead."
8132
8157
  },
8133
8158
  {
8134
8159
  description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
@@ -18157,6 +18182,7 @@ var openapi = {
18157
18182
  "x-variant-group-key": "locks"
18158
18183
  },
18159
18184
  {
18185
+ deprecated: true,
18160
18186
  description: "Indicates that the device is offline.",
18161
18187
  properties: {
18162
18188
  created_at: {
@@ -18185,7 +18211,8 @@ var openapi = {
18185
18211
  "created_at",
18186
18212
  "error_code"
18187
18213
  ],
18188
- type: "object"
18214
+ type: "object",
18215
+ "x-deprecated": "Use `device_disconnected` instead."
18189
18216
  },
18190
18217
  {
18191
18218
  description: "Indicates that the device has been removed.",
@@ -18345,6 +18372,7 @@ var openapi = {
18345
18372
  "x-variant-group-key": "locks"
18346
18373
  },
18347
18374
  {
18375
+ deprecated: true,
18348
18376
  description: "Indicates that the lock is not connected to a bridge.",
18349
18377
  properties: {
18350
18378
  created_at: {
@@ -18374,10 +18402,12 @@ var openapi = {
18374
18402
  "error_code"
18375
18403
  ],
18376
18404
  type: "object",
18405
+ "x-deprecated": "Use `hub_disconnected` instead.",
18377
18406
  "x-variant-group-key": "locks"
18378
18407
  },
18379
18408
  {
18380
- description: "\n Indicates that the lock is not paired with a gateway.\n ",
18409
+ deprecated: true,
18410
+ description: "Indicates that the lock is not paired with a gateway.",
18381
18411
  properties: {
18382
18412
  created_at: {
18383
18413
  description: "Date and time at which Seam created the error.",
@@ -18405,7 +18435,8 @@ var openapi = {
18405
18435
  "created_at",
18406
18436
  "error_code"
18407
18437
  ],
18408
- type: "object"
18438
+ type: "object",
18439
+ "x-deprecated": "Use `hub_disconnected` instead."
18409
18440
  },
18410
18441
  {
18411
18442
  description: "Indicates that device credentials are missing.",
@@ -18502,7 +18533,8 @@ var openapi = {
18502
18533
  type: "object"
18503
18534
  },
18504
18535
  {
18505
- description: "\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ",
18536
+ deprecated: true,
18537
+ description: "Indicates that the Lockly lock is not connected to a Wi-Fi bridge.",
18506
18538
  properties: {
18507
18539
  created_at: {
18508
18540
  description: "Date and time at which Seam created the error.",
@@ -18530,7 +18562,8 @@ var openapi = {
18530
18562
  "created_at",
18531
18563
  "error_code"
18532
18564
  ],
18533
- type: "object"
18565
+ type: "object",
18566
+ "x-deprecated": "Use `hub_disconnected` instead."
18534
18567
  },
18535
18568
  {
18536
18569
  description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
@@ -21072,7 +21105,8 @@ var openapi = {
21072
21105
  "x-variant-group-key": "access_codes"
21073
21106
  },
21074
21107
  {
21075
- description: "\n Indicates that the Wyze Lock is not connected to a gateway.\n ",
21108
+ deprecated: true,
21109
+ description: "Indicates that the Wyze Lock is not connected to a gateway.",
21076
21110
  properties: {
21077
21111
  created_at: {
21078
21112
  description: "Date and time at which Seam created the warning.",
@@ -21090,7 +21124,8 @@ var openapi = {
21090
21124
  }
21091
21125
  },
21092
21126
  required: ["message", "created_at", "warning_code"],
21093
- type: "object"
21127
+ type: "object",
21128
+ "x-deprecated": "Use `hub_disconnected` device error instead."
21094
21129
  },
21095
21130
  {
21096
21131
  description: "Indicates that a third-party integration has been detected.",
@@ -32180,6 +32215,7 @@ var openapi = {
32180
32215
  "x-variant-group-key": "locks"
32181
32216
  },
32182
32217
  {
32218
+ deprecated: true,
32183
32219
  description: "Indicates that the device is offline.",
32184
32220
  properties: {
32185
32221
  created_at: {
@@ -32208,7 +32244,8 @@ var openapi = {
32208
32244
  "created_at",
32209
32245
  "error_code"
32210
32246
  ],
32211
- type: "object"
32247
+ type: "object",
32248
+ "x-deprecated": "Use `device_disconnected` instead."
32212
32249
  },
32213
32250
  {
32214
32251
  description: "Indicates that the device has been removed.",
@@ -32368,6 +32405,7 @@ var openapi = {
32368
32405
  "x-variant-group-key": "locks"
32369
32406
  },
32370
32407
  {
32408
+ deprecated: true,
32371
32409
  description: "Indicates that the lock is not connected to a bridge.",
32372
32410
  properties: {
32373
32411
  created_at: {
@@ -32397,10 +32435,12 @@ var openapi = {
32397
32435
  "error_code"
32398
32436
  ],
32399
32437
  type: "object",
32438
+ "x-deprecated": "Use `hub_disconnected` instead.",
32400
32439
  "x-variant-group-key": "locks"
32401
32440
  },
32402
32441
  {
32403
- description: "\n Indicates that the lock is not paired with a gateway.\n ",
32442
+ deprecated: true,
32443
+ description: "Indicates that the lock is not paired with a gateway.",
32404
32444
  properties: {
32405
32445
  created_at: {
32406
32446
  description: "Date and time at which Seam created the error.",
@@ -32428,7 +32468,8 @@ var openapi = {
32428
32468
  "created_at",
32429
32469
  "error_code"
32430
32470
  ],
32431
- type: "object"
32471
+ type: "object",
32472
+ "x-deprecated": "Use `hub_disconnected` instead."
32432
32473
  },
32433
32474
  {
32434
32475
  description: "Indicates that device credentials are missing.",
@@ -32525,7 +32566,8 @@ var openapi = {
32525
32566
  type: "object"
32526
32567
  },
32527
32568
  {
32528
- description: "\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ",
32569
+ deprecated: true,
32570
+ description: "Indicates that the Lockly lock is not connected to a Wi-Fi bridge.",
32529
32571
  properties: {
32530
32572
  created_at: {
32531
32573
  description: "Date and time at which Seam created the error.",
@@ -32553,7 +32595,8 @@ var openapi = {
32553
32595
  "created_at",
32554
32596
  "error_code"
32555
32597
  ],
32556
- type: "object"
32598
+ type: "object",
32599
+ "x-deprecated": "Use `hub_disconnected` instead."
32557
32600
  },
32558
32601
  {
32559
32602
  description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
@@ -34842,6 +34885,7 @@ var openapi = {
34842
34885
  "x-variant-group-key": "locks"
34843
34886
  },
34844
34887
  {
34888
+ deprecated: true,
34845
34889
  description: "Indicates that the device is offline.",
34846
34890
  properties: {
34847
34891
  created_at: {
@@ -34870,7 +34914,8 @@ var openapi = {
34870
34914
  "created_at",
34871
34915
  "error_code"
34872
34916
  ],
34873
- type: "object"
34917
+ type: "object",
34918
+ "x-deprecated": "Use `device_disconnected` instead."
34874
34919
  },
34875
34920
  {
34876
34921
  description: "Indicates that the device has been removed.",
@@ -35030,6 +35075,7 @@ var openapi = {
35030
35075
  "x-variant-group-key": "locks"
35031
35076
  },
35032
35077
  {
35078
+ deprecated: true,
35033
35079
  description: "Indicates that the lock is not connected to a bridge.",
35034
35080
  properties: {
35035
35081
  created_at: {
@@ -35059,10 +35105,12 @@ var openapi = {
35059
35105
  "error_code"
35060
35106
  ],
35061
35107
  type: "object",
35108
+ "x-deprecated": "Use `hub_disconnected` instead.",
35062
35109
  "x-variant-group-key": "locks"
35063
35110
  },
35064
35111
  {
35065
- description: "\n Indicates that the lock is not paired with a gateway.\n ",
35112
+ deprecated: true,
35113
+ description: "Indicates that the lock is not paired with a gateway.",
35066
35114
  properties: {
35067
35115
  created_at: {
35068
35116
  description: "Date and time at which Seam created the error.",
@@ -35090,7 +35138,8 @@ var openapi = {
35090
35138
  "created_at",
35091
35139
  "error_code"
35092
35140
  ],
35093
- type: "object"
35141
+ type: "object",
35142
+ "x-deprecated": "Use `hub_disconnected` instead."
35094
35143
  },
35095
35144
  {
35096
35145
  description: "Indicates that device credentials are missing.",
@@ -35187,7 +35236,8 @@ var openapi = {
35187
35236
  type: "object"
35188
35237
  },
35189
35238
  {
35190
- description: "\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ",
35239
+ deprecated: true,
35240
+ description: "Indicates that the Lockly lock is not connected to a Wi-Fi bridge.",
35191
35241
  properties: {
35192
35242
  created_at: {
35193
35243
  description: "Date and time at which Seam created the error.",
@@ -35215,7 +35265,8 @@ var openapi = {
35215
35265
  "created_at",
35216
35266
  "error_code"
35217
35267
  ],
35218
- type: "object"
35268
+ type: "object",
35269
+ "x-deprecated": "Use `hub_disconnected` instead."
35219
35270
  },
35220
35271
  {
35221
35272
  description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
@@ -35478,7 +35529,8 @@ var openapi = {
35478
35529
  "x-variant-group-key": "access_codes"
35479
35530
  },
35480
35531
  {
35481
- description: "\n Indicates that the Wyze Lock is not connected to a gateway.\n ",
35532
+ deprecated: true,
35533
+ description: "Indicates that the Wyze Lock is not connected to a gateway.",
35482
35534
  properties: {
35483
35535
  created_at: {
35484
35536
  description: "Date and time at which Seam created the warning.",
@@ -35496,7 +35548,8 @@ var openapi = {
35496
35548
  }
35497
35549
  },
35498
35550
  required: ["message", "created_at", "warning_code"],
35499
- type: "object"
35551
+ type: "object",
35552
+ "x-deprecated": "Use `hub_disconnected` device error instead."
35500
35553
  },
35501
35554
  {
35502
35555
  description: "Indicates that a third-party integration has been detected.",
@@ -59031,7 +59084,7 @@ var openapi = {
59031
59084
  },
59032
59085
  "/devices/simulate/connect_to_hub": {
59033
59086
  post: {
59034
- description: "Simulates bringing the Wi\u2011Fi hub (bridge) back online for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August and TTLock locks.\nThis will clear the corresponding `hub_disconnected` or\n`ttlock_lock_not_paired_to_gateway` error on the device.",
59087
+ description: "Simulates bringing the Wi\u2011Fi hub (bridge) back online for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August and TTLock locks.\nThis will clear the `hub_disconnected` error on the device.",
59035
59088
  operationId: "devicesSimulateConnectToHubPost",
59036
59089
  requestBody: {
59037
59090
  content: {
@@ -59133,7 +59186,7 @@ var openapi = {
59133
59186
  },
59134
59187
  "/devices/simulate/disconnect_from_hub": {
59135
59188
  post: {
59136
- description: "Simulates taking the Wi\u2011Fi hub (bridge) offline for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August, TTLock, and IglooHome devices.\nThis will set the corresponding `hub_disconnected` or\n`ttlock_lock_not_paired_to_gateway` error on the device, or mark the\nIglooHome bridge offline in sandbox.",
59189
+ description: "Simulates taking the Wi\u2011Fi hub (bridge) offline for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August, TTLock, and IglooHome devices.\nThis will set the `hub_disconnected` error on the device, or mark the\nIglooHome bridge offline in sandbox.",
59137
59190
  operationId: "devicesSimulateDisconnectFromHubPost",
59138
59191
  requestBody: {
59139
59192
  content: {