@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.
Files changed (11) hide show
  1. package/dist/connect.cjs +80 -27
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/index.cjs +80 -27
  4. package/dist/index.cjs.map +1 -1
  5. package/lib/seam/connect/models/devices/device.js +16 -1
  6. package/lib/seam/connect/models/devices/device.js.map +1 -1
  7. package/lib/seam/connect/openapi.js +48 -12
  8. package/lib/seam/connect/openapi.js.map +1 -1
  9. package/package.json +1 -1
  10. package/src/lib/seam/connect/models/devices/device.ts +18 -1
  11. package/src/lib/seam/connect/openapi.ts +50 -12
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.867.0",
3
+ "version": "1.868.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
package/src/lib/seam/connect/models/devices/device.ts CHANGED
@@ -61,7 +61,14 @@ const device_offline = common_device_error
61
61
  .extend({
62
62
  error_code: z.literal('device_offline').describe(error_code_description),
63
63
  })
64
- .describe('Indicates that the device is offline.')
64
+ .describe(
65
+ `
66
+ ---
67
+ deprecated: Use \`device_disconnected\` instead.
68
+ ---
69
+ Indicates that the device is offline.
70
+ `,
71
+ )
65
72
 
66
73
  const device_removed = common_device_error
67
74
  .extend({
@@ -127,6 +134,7 @@ const august_lock_missing_bridge = common_device_error.extend({
127
134
  .describe(error_code_description),
128
135
  }).describe(`
129
136
  ---
137
+ deprecated: Use \`hub_disconnected\` instead.
130
138
  variant_group_key: locks
131
139
  ---
132
140
  Indicates that the lock is not connected to a bridge.
@@ -156,6 +164,9 @@ const ttlock_lock_not_paired_to_gateway = common_device_error.extend({
156
164
  .literal('ttlock_lock_not_paired_to_gateway')
157
165
  .describe(error_code_description),
158
166
  }).describe(`
167
+ ---
168
+ deprecated: Use \`hub_disconnected\` instead.
169
+ ---
159
170
  Indicates that the lock is not paired with a gateway.
160
171
  `)
161
172
 
@@ -191,6 +202,9 @@ const lockly_missing_wifi_bridge = common_device_error.extend({
191
202
  .literal('lockly_missing_wifi_bridge')
192
203
  .describe(error_code_description),
193
204
  }).describe(`
205
+ ---
206
+ deprecated: Use \`hub_disconnected\` instead.
207
+ ---
194
208
  Indicates that the Lockly lock is not connected to a Wi-Fi bridge.
195
209
  `)
196
210
 
@@ -325,6 +339,9 @@ const wyze_device_missing_gateway = common_device_warning.extend({
325
339
  .literal('wyze_device_missing_gateway')
326
340
  .describe(warning_code_description),
327
341
  }).describe(`
342
+ ---
343
+ deprecated: Use \`hub_disconnected\` device error instead.
344
+ ---
328
345
  Indicates that the Wyze Lock is not connected to a gateway.
329
346
  `)
330
347
 
package/src/lib/seam/connect/openapi.ts CHANGED
@@ -812,6 +812,7 @@ const openapi: OpenAPISpec = {
812
812
  'x-variant-group-key': 'locks',
813
813
  },
814
814
  {
815
+ deprecated: true,
815
816
  description: 'Indicates that the device is offline.',
816
817
  properties: {
817
818
  created_at: {
@@ -845,6 +846,7 @@ const openapi: OpenAPISpec = {
845
846
  'error_code',
846
847
  ],
847
848
  type: 'object',
849
+ 'x-deprecated': 'Use `device_disconnected` instead.',
848
850
  },
849
851
  {
850
852
  description: 'Indicates that the device has been removed.',
@@ -1026,6 +1028,7 @@ const openapi: OpenAPISpec = {
1026
1028
  'x-variant-group-key': 'locks',
1027
1029
  },
1028
1030
  {
1031
+ deprecated: true,
1029
1032
  description:
1030
1033
  'Indicates that the lock is not connected to a bridge.',
1031
1034
  properties: {
@@ -1060,11 +1063,13 @@ const openapi: OpenAPISpec = {
1060
1063
  'error_code',
1061
1064
  ],
1062
1065
  type: 'object',
1066
+ 'x-deprecated': 'Use `hub_disconnected` instead.',
1063
1067
  'x-variant-group-key': 'locks',
1064
1068
  },
1065
1069
  {
1070
+ deprecated: true,
1066
1071
  description:
1067
- '\n Indicates that the lock is not paired with a gateway.\n ',
1072
+ 'Indicates that the lock is not paired with a gateway.',
1068
1073
  properties: {
1069
1074
  created_at: {
1070
1075
  description:
@@ -1097,6 +1102,7 @@ const openapi: OpenAPISpec = {
1097
1102
  'error_code',
1098
1103
  ],
1099
1104
  type: 'object',
1105
+ 'x-deprecated': 'Use `hub_disconnected` instead.',
1100
1106
  },
1101
1107
  {
1102
1108
  description: 'Indicates that device credentials are missing.',
@@ -1206,8 +1212,9 @@ const openapi: OpenAPISpec = {
1206
1212
  type: 'object',
1207
1213
  },
1208
1214
  {
1215
+ deprecated: true,
1209
1216
  description:
1210
- '\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ',
1217
+ 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
1211
1218
  properties: {
1212
1219
  created_at: {
1213
1220
  description:
@@ -1240,6 +1247,7 @@ const openapi: OpenAPISpec = {
1240
1247
  'error_code',
1241
1248
  ],
1242
1249
  type: 'object',
1250
+ 'x-deprecated': 'Use `hub_disconnected` instead.',
1243
1251
  },
1244
1252
  {
1245
1253
  description:
@@ -12520,6 +12528,7 @@ const openapi: OpenAPISpec = {
12520
12528
  'x-variant-group-key': 'locks',
12521
12529
  },
12522
12530
  {
12531
+ deprecated: true,
12523
12532
  description: 'Indicates that the device is offline.',
12524
12533
  properties: {
12525
12534
  created_at: {
@@ -12553,6 +12562,7 @@ const openapi: OpenAPISpec = {
12553
12562
  'error_code',
12554
12563
  ],
12555
12564
  type: 'object',
12565
+ 'x-deprecated': 'Use `device_disconnected` instead.',
12556
12566
  },
12557
12567
  {
12558
12568
  description: 'Indicates that the device has been removed.',
@@ -12734,6 +12744,7 @@ const openapi: OpenAPISpec = {
12734
12744
  'x-variant-group-key': 'locks',
12735
12745
  },
12736
12746
  {
12747
+ deprecated: true,
12737
12748
  description:
12738
12749
  'Indicates that the lock is not connected to a bridge.',
12739
12750
  properties: {
@@ -12768,11 +12779,13 @@ const openapi: OpenAPISpec = {
12768
12779
  'error_code',
12769
12780
  ],
12770
12781
  type: 'object',
12782
+ 'x-deprecated': 'Use `hub_disconnected` instead.',
12771
12783
  'x-variant-group-key': 'locks',
12772
12784
  },
12773
12785
  {
12786
+ deprecated: true,
12774
12787
  description:
12775
- '\n Indicates that the lock is not paired with a gateway.\n ',
12788
+ 'Indicates that the lock is not paired with a gateway.',
12776
12789
  properties: {
12777
12790
  created_at: {
12778
12791
  description:
@@ -12805,6 +12818,7 @@ const openapi: OpenAPISpec = {
12805
12818
  'error_code',
12806
12819
  ],
12807
12820
  type: 'object',
12821
+ 'x-deprecated': 'Use `hub_disconnected` instead.',
12808
12822
  },
12809
12823
  {
12810
12824
  description: 'Indicates that device credentials are missing.',
@@ -12914,8 +12928,9 @@ const openapi: OpenAPISpec = {
12914
12928
  type: 'object',
12915
12929
  },
12916
12930
  {
12931
+ deprecated: true,
12917
12932
  description:
12918
- '\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ',
12933
+ 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
12919
12934
  properties: {
12920
12935
  created_at: {
12921
12936
  description:
@@ -12948,6 +12963,7 @@ const openapi: OpenAPISpec = {
12948
12963
  'error_code',
12949
12964
  ],
12950
12965
  type: 'object',
12966
+ 'x-deprecated': 'Use `hub_disconnected` instead.',
12951
12967
  },
12952
12968
  {
12953
12969
  description:
@@ -15784,8 +15800,9 @@ const openapi: OpenAPISpec = {
15784
15800
  'x-variant-group-key': 'access_codes',
15785
15801
  },
15786
15802
  {
15803
+ deprecated: true,
15787
15804
  description:
15788
- '\n Indicates that the Wyze Lock is not connected to a gateway.\n ',
15805
+ 'Indicates that the Wyze Lock is not connected to a gateway.',
15789
15806
  properties: {
15790
15807
  created_at: {
15791
15808
  description:
@@ -15807,6 +15824,8 @@ const openapi: OpenAPISpec = {
15807
15824
  },
15808
15825
  required: ['message', 'created_at', 'warning_code'],
15809
15826
  type: 'object',
15827
+ 'x-deprecated':
15828
+ 'Use `hub_disconnected` device error instead.',
15810
15829
  },
15811
15830
  {
15812
15831
  description:
@@ -28031,6 +28050,7 @@ const openapi: OpenAPISpec = {
28031
28050
  'x-variant-group-key': 'locks',
28032
28051
  },
28033
28052
  {
28053
+ deprecated: true,
28034
28054
  description: 'Indicates that the device is offline.',
28035
28055
  properties: {
28036
28056
  created_at: {
@@ -28064,6 +28084,7 @@ const openapi: OpenAPISpec = {
28064
28084
  'error_code',
28065
28085
  ],
28066
28086
  type: 'object',
28087
+ 'x-deprecated': 'Use `device_disconnected` instead.',
28067
28088
  },
28068
28089
  {
28069
28090
  description: 'Indicates that the device has been removed.',
@@ -28245,6 +28266,7 @@ const openapi: OpenAPISpec = {
28245
28266
  'x-variant-group-key': 'locks',
28246
28267
  },
28247
28268
  {
28269
+ deprecated: true,
28248
28270
  description:
28249
28271
  'Indicates that the lock is not connected to a bridge.',
28250
28272
  properties: {
@@ -28279,11 +28301,13 @@ const openapi: OpenAPISpec = {
28279
28301
  'error_code',
28280
28302
  ],
28281
28303
  type: 'object',
28304
+ 'x-deprecated': 'Use `hub_disconnected` instead.',
28282
28305
  'x-variant-group-key': 'locks',
28283
28306
  },
28284
28307
  {
28308
+ deprecated: true,
28285
28309
  description:
28286
- '\n Indicates that the lock is not paired with a gateway.\n ',
28310
+ 'Indicates that the lock is not paired with a gateway.',
28287
28311
  properties: {
28288
28312
  created_at: {
28289
28313
  description:
@@ -28316,6 +28340,7 @@ const openapi: OpenAPISpec = {
28316
28340
  'error_code',
28317
28341
  ],
28318
28342
  type: 'object',
28343
+ 'x-deprecated': 'Use `hub_disconnected` instead.',
28319
28344
  },
28320
28345
  {
28321
28346
  description: 'Indicates that device credentials are missing.',
@@ -28425,8 +28450,9 @@ const openapi: OpenAPISpec = {
28425
28450
  type: 'object',
28426
28451
  },
28427
28452
  {
28453
+ deprecated: true,
28428
28454
  description:
28429
- '\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ',
28455
+ 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
28430
28456
  properties: {
28431
28457
  created_at: {
28432
28458
  description:
@@ -28459,6 +28485,7 @@ const openapi: OpenAPISpec = {
28459
28485
  'error_code',
28460
28486
  ],
28461
28487
  type: 'object',
28488
+ 'x-deprecated': 'Use `hub_disconnected` instead.',
28462
28489
  },
28463
28490
  {
28464
28491
  description:
@@ -31031,6 +31058,7 @@ const openapi: OpenAPISpec = {
31031
31058
  'x-variant-group-key': 'locks',
31032
31059
  },
31033
31060
  {
31061
+ deprecated: true,
31034
31062
  description: 'Indicates that the device is offline.',
31035
31063
  properties: {
31036
31064
  created_at: {
@@ -31064,6 +31092,7 @@ const openapi: OpenAPISpec = {
31064
31092
  'error_code',
31065
31093
  ],
31066
31094
  type: 'object',
31095
+ 'x-deprecated': 'Use `device_disconnected` instead.',
31067
31096
  },
31068
31097
  {
31069
31098
  description: 'Indicates that the device has been removed.',
@@ -31245,6 +31274,7 @@ const openapi: OpenAPISpec = {
31245
31274
  'x-variant-group-key': 'locks',
31246
31275
  },
31247
31276
  {
31277
+ deprecated: true,
31248
31278
  description:
31249
31279
  'Indicates that the lock is not connected to a bridge.',
31250
31280
  properties: {
@@ -31279,11 +31309,13 @@ const openapi: OpenAPISpec = {
31279
31309
  'error_code',
31280
31310
  ],
31281
31311
  type: 'object',
31312
+ 'x-deprecated': 'Use `hub_disconnected` instead.',
31282
31313
  'x-variant-group-key': 'locks',
31283
31314
  },
31284
31315
  {
31316
+ deprecated: true,
31285
31317
  description:
31286
- '\n Indicates that the lock is not paired with a gateway.\n ',
31318
+ 'Indicates that the lock is not paired with a gateway.',
31287
31319
  properties: {
31288
31320
  created_at: {
31289
31321
  description:
@@ -31316,6 +31348,7 @@ const openapi: OpenAPISpec = {
31316
31348
  'error_code',
31317
31349
  ],
31318
31350
  type: 'object',
31351
+ 'x-deprecated': 'Use `hub_disconnected` instead.',
31319
31352
  },
31320
31353
  {
31321
31354
  description: 'Indicates that device credentials are missing.',
@@ -31425,8 +31458,9 @@ const openapi: OpenAPISpec = {
31425
31458
  type: 'object',
31426
31459
  },
31427
31460
  {
31461
+ deprecated: true,
31428
31462
  description:
31429
- '\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ',
31463
+ 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
31430
31464
  properties: {
31431
31465
  created_at: {
31432
31466
  description:
@@ -31459,6 +31493,7 @@ const openapi: OpenAPISpec = {
31459
31493
  'error_code',
31460
31494
  ],
31461
31495
  type: 'object',
31496
+ 'x-deprecated': 'Use `hub_disconnected` instead.',
31462
31497
  },
31463
31498
  {
31464
31499
  description:
@@ -31751,8 +31786,9 @@ const openapi: OpenAPISpec = {
31751
31786
  'x-variant-group-key': 'access_codes',
31752
31787
  },
31753
31788
  {
31789
+ deprecated: true,
31754
31790
  description:
31755
- '\n Indicates that the Wyze Lock is not connected to a gateway.\n ',
31791
+ 'Indicates that the Wyze Lock is not connected to a gateway.',
31756
31792
  properties: {
31757
31793
  created_at: {
31758
31794
  description:
@@ -31774,6 +31810,8 @@ const openapi: OpenAPISpec = {
31774
31810
  },
31775
31811
  required: ['message', 'created_at', 'warning_code'],
31776
31812
  type: 'object',
31813
+ 'x-deprecated':
31814
+ 'Use `hub_disconnected` device error instead.',
31777
31815
  },
31778
31816
  {
31779
31817
  description:
@@ -57109,7 +57147,7 @@ const openapi: OpenAPISpec = {
57109
57147
  '/devices/simulate/connect_to_hub': {
57110
57148
  post: {
57111
57149
  description:
57112
- 'Simulates bringing the Wi‑Fi 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.',
57150
+ 'Simulates bringing the Wi‑Fi 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.',
57113
57151
  operationId: 'devicesSimulateConnectToHubPost',
57114
57152
  requestBody: {
57115
57153
  content: {
@@ -57215,7 +57253,7 @@ const openapi: OpenAPISpec = {
57215
57253
  '/devices/simulate/disconnect_from_hub': {
57216
57254
  post: {
57217
57255
  description:
57218
- 'Simulates taking the Wi‑Fi 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.',
57256
+ 'Simulates taking the Wi‑Fi 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.',
57219
57257
  operationId: 'devicesSimulateDisconnectFromHubPost',
57220
57258
  requestBody: {
57221
57259
  content: {