@seamapi/types 1.867.0 → 1.869.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.867.0",
+  "version": "1.869.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/access-codes/managed-access-code.ts

@@ -169,7 +169,14 @@ const wyze_duplicate_code_name = common_access_code_error
       .literal('wyze_duplicate_code_name')
       .describe(error_code_description),
   })
-  .describe('Duplicate access code name detected.')
+  .describe(
+    `
+    ---
+    deprecated: Use \`duplicate_code_on_device\` instead.
+    ---
+    Duplicate access code name detected.
+    `,
+  )
 
 const wyze_potential_duplicate_code = common_access_code_error
   .extend({
@@ -177,7 +184,14 @@ const wyze_potential_duplicate_code = common_access_code_error
       .literal('wyze_potential_duplicate_code')
       .describe(error_code_description),
   })
-  .describe('Potential duplicate access code detected.')
+  .describe(
+    `
+    ---
+    deprecated: Use \`duplicate_code_on_device\` instead.
+    ---
+    Potential duplicate access code detected.
+    `,
+  )
 
 const dormakaba_oracode_invalid_time_range = common_access_code_error
   .extend({
@@ -340,7 +354,14 @@ const schlage_detected_duplicate = common_access_code_warning
       .literal('schlage_detected_duplicate')
       .describe(warning_code_description),
   })
-  .describe('Duplicate access code detected.')
+  .describe(
+    `
+    ---
+    deprecated: Use \`duplicate_code_on_device\` error instead.
+    ---
+    Duplicate access code detected.
+    `,
+  )
 
 const schlage_creation_outage = common_access_code_warning
   .extend({

package/src/lib/seam/connect/models/devices/device.ts

@@ -61,7 +61,14 @@ const device_offline = common_device_error
   .extend({
     error_code: z.literal('device_offline').describe(error_code_description),
   })
-  .describe('Indicates that the device is offline.')
+  .describe(
+    `
+    ---
+    deprecated: Use \`device_disconnected\` instead.
+    ---
+    Indicates that the device is offline.
+    `,
+  )
 
 const device_removed = common_device_error
   .extend({
@@ -127,6 +134,7 @@ const august_lock_missing_bridge = common_device_error.extend({
     .describe(error_code_description),
 }).describe(`
     ---
+    deprecated: Use \`hub_disconnected\` instead.
     variant_group_key: locks
     ---
     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({
     .literal('ttlock_lock_not_paired_to_gateway')
     .describe(error_code_description),
 }).describe(`
+    ---
+    deprecated: Use \`hub_disconnected\` instead.
+    ---
     Indicates that the lock is not paired with a gateway.
     `)
 
@@ -191,6 +202,9 @@ const lockly_missing_wifi_bridge = common_device_error.extend({
     .literal('lockly_missing_wifi_bridge')
     .describe(error_code_description),
 }).describe(`
+    ---
+    deprecated: Use \`hub_disconnected\` instead.
+    ---
     Indicates that the Lockly lock is not connected to a Wi-Fi bridge.
     `)
 
@@ -325,6 +339,9 @@ const wyze_device_missing_gateway = common_device_warning.extend({
     .literal('wyze_device_missing_gateway')
     .describe(warning_code_description),
 }).describe(`
+    ---
+    deprecated: Use \`hub_disconnected\` device error instead.
+    ---
     Indicates that the Wyze Lock is not connected to a gateway.
     `)
 

package/src/lib/seam/connect/openapi.ts

@@ -543,6 +543,7 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                 },
                 {
+                  deprecated: true,
                   description: 'Duplicate access code name detected.',
                   properties: {
                     created_at: {
@@ -571,8 +572,10 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `duplicate_code_on_device` instead.',
                 },
                 {
+                  deprecated: true,
                   description: 'Potential duplicate access code detected.',
                   properties: {
                     created_at: {
@@ -601,6 +604,7 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `duplicate_code_on_device` instead.',
                 },
                 {
                   description:
@@ -812,6 +816,7 @@ const openapi: OpenAPISpec = {
                   'x-variant-group-key': 'locks',
                 },
                 {
+                  deprecated: true,
                   description: 'Indicates that the device is offline.',
                   properties: {
                     created_at: {
@@ -845,6 +850,7 @@ const openapi: OpenAPISpec = {
                     'error_code',
                   ],
                   type: 'object',
+                  'x-deprecated': 'Use `device_disconnected` instead.',
                 },
                 {
                   description: 'Indicates that the device has been removed.',
@@ -1026,6 +1032,7 @@ const openapi: OpenAPISpec = {
                   'x-variant-group-key': 'locks',
                 },
                 {
+                  deprecated: true,
                   description:
                     'Indicates that the lock is not connected to a bridge.',
                   properties: {
@@ -1060,11 +1067,13 @@ const openapi: OpenAPISpec = {
                     'error_code',
                   ],
                   type: 'object',
+                  'x-deprecated': 'Use `hub_disconnected` instead.',
                   'x-variant-group-key': 'locks',
                 },
                 {
+                  deprecated: true,
                   description:
-                    '\n    Indicates that the lock is not paired with a gateway.\n    ',
+                    'Indicates that the lock is not paired with a gateway.',
                   properties: {
                     created_at: {
                       description:
@@ -1097,6 +1106,7 @@ const openapi: OpenAPISpec = {
                     'error_code',
                   ],
                   type: 'object',
+                  'x-deprecated': 'Use `hub_disconnected` instead.',
                 },
                 {
                   description: 'Indicates that device credentials are missing.',
@@ -1206,8 +1216,9 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                 },
                 {
+                  deprecated: true,
                   description:
-                    '\n    Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n    ',
+                    'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
                   properties: {
                     created_at: {
                       description:
@@ -1240,6 +1251,7 @@ const openapi: OpenAPISpec = {
                     'error_code',
                   ],
                   type: 'object',
+                  'x-deprecated': 'Use `hub_disconnected` instead.',
                 },
                 {
                   description:
@@ -1663,6 +1675,7 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                 },
                 {
+                  deprecated: true,
                   description: 'Duplicate access code detected.',
                   properties: {
                     created_at: {
@@ -1685,6 +1698,8 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'warning_code'],
                   type: 'object',
+                  'x-deprecated':
+                    'Use `duplicate_code_on_device` error instead.',
                 },
                 {
                   description:
@@ -12520,6 +12535,7 @@ const openapi: OpenAPISpec = {
                   'x-variant-group-key': 'locks',
                 },
                 {
+                  deprecated: true,
                   description: 'Indicates that the device is offline.',
                   properties: {
                     created_at: {
@@ -12553,6 +12569,7 @@ const openapi: OpenAPISpec = {
                     'error_code',
                   ],
                   type: 'object',
+                  'x-deprecated': 'Use `device_disconnected` instead.',
                 },
                 {
                   description: 'Indicates that the device has been removed.',
@@ -12734,6 +12751,7 @@ const openapi: OpenAPISpec = {
                   'x-variant-group-key': 'locks',
                 },
                 {
+                  deprecated: true,
                   description:
                     'Indicates that the lock is not connected to a bridge.',
                   properties: {
@@ -12768,11 +12786,13 @@ const openapi: OpenAPISpec = {
                     'error_code',
                   ],
                   type: 'object',
+                  'x-deprecated': 'Use `hub_disconnected` instead.',
                   'x-variant-group-key': 'locks',
                 },
                 {
+                  deprecated: true,
                   description:
-                    '\n    Indicates that the lock is not paired with a gateway.\n    ',
+                    'Indicates that the lock is not paired with a gateway.',
                   properties: {
                     created_at: {
                       description:
@@ -12805,6 +12825,7 @@ const openapi: OpenAPISpec = {
                     'error_code',
                   ],
                   type: 'object',
+                  'x-deprecated': 'Use `hub_disconnected` instead.',
                 },
                 {
                   description: 'Indicates that device credentials are missing.',
@@ -12914,8 +12935,9 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                 },
                 {
+                  deprecated: true,
                   description:
-                    '\n    Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n    ',
+                    'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
                   properties: {
                     created_at: {
                       description:
@@ -12948,6 +12970,7 @@ const openapi: OpenAPISpec = {
                     'error_code',
                   ],
                   type: 'object',
+                  'x-deprecated': 'Use `hub_disconnected` instead.',
                 },
                 {
                   description:
@@ -15784,8 +15807,9 @@ const openapi: OpenAPISpec = {
                   'x-variant-group-key': 'access_codes',
                 },
                 {
+                  deprecated: true,
                   description:
-                    '\n    Indicates that the Wyze Lock is not connected to a gateway.\n    ',
+                    'Indicates that the Wyze Lock is not connected to a gateway.',
                   properties: {
                     created_at: {
                       description:
@@ -15807,6 +15831,8 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'created_at', 'warning_code'],
                   type: 'object',
+                  'x-deprecated':
+                    'Use `hub_disconnected` device error instead.',
                 },
                 {
                   description:
@@ -27762,6 +27788,7 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                 },
                 {
+                  deprecated: true,
                   description: 'Duplicate access code name detected.',
                   properties: {
                     created_at: {
@@ -27790,8 +27817,10 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `duplicate_code_on_device` instead.',
                 },
                 {
+                  deprecated: true,
                   description: 'Potential duplicate access code detected.',
                   properties: {
                     created_at: {
@@ -27820,6 +27849,7 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
+                  'x-deprecated': 'Use `duplicate_code_on_device` instead.',
                 },
                 {
                   description:
@@ -28031,6 +28061,7 @@ const openapi: OpenAPISpec = {
                   'x-variant-group-key': 'locks',
                 },
                 {
+                  deprecated: true,
                   description: 'Indicates that the device is offline.',
                   properties: {
                     created_at: {
@@ -28064,6 +28095,7 @@ const openapi: OpenAPISpec = {
                     'error_code',
                   ],
                   type: 'object',
+                  'x-deprecated': 'Use `device_disconnected` instead.',
                 },
                 {
                   description: 'Indicates that the device has been removed.',
@@ -28245,6 +28277,7 @@ const openapi: OpenAPISpec = {
                   'x-variant-group-key': 'locks',
                 },
                 {
+                  deprecated: true,
                   description:
                     'Indicates that the lock is not connected to a bridge.',
                   properties: {
@@ -28279,11 +28312,13 @@ const openapi: OpenAPISpec = {
                     'error_code',
                   ],
                   type: 'object',
+                  'x-deprecated': 'Use `hub_disconnected` instead.',
                   'x-variant-group-key': 'locks',
                 },
                 {
+                  deprecated: true,
                   description:
-                    '\n    Indicates that the lock is not paired with a gateway.\n    ',
+                    'Indicates that the lock is not paired with a gateway.',
                   properties: {
                     created_at: {
                       description:
@@ -28316,6 +28351,7 @@ const openapi: OpenAPISpec = {
                     'error_code',
                   ],
                   type: 'object',
+                  'x-deprecated': 'Use `hub_disconnected` instead.',
                 },
                 {
                   description: 'Indicates that device credentials are missing.',
@@ -28425,8 +28461,9 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                 },
                 {
+                  deprecated: true,
                   description:
-                    '\n    Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n    ',
+                    'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
                   properties: {
                     created_at: {
                       description:
@@ -28459,6 +28496,7 @@ const openapi: OpenAPISpec = {
                     'error_code',
                   ],
                   type: 'object',
+                  'x-deprecated': 'Use `hub_disconnected` instead.',
                 },
                 {
                   description:
@@ -28571,6 +28609,7 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                 },
                 {
+                  deprecated: true,
                   description: 'Duplicate access code detected.',
                   properties: {
                     created_at: {
@@ -28593,6 +28632,8 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'warning_code'],
                   type: 'object',
+                  'x-deprecated':
+                    'Use `duplicate_code_on_device` error instead.',
                 },
                 {
                   description:
@@ -31031,6 +31072,7 @@ const openapi: OpenAPISpec = {
                   'x-variant-group-key': 'locks',
                 },
                 {
+                  deprecated: true,
                   description: 'Indicates that the device is offline.',
                   properties: {
                     created_at: {
@@ -31064,6 +31106,7 @@ const openapi: OpenAPISpec = {
                     'error_code',
                   ],
                   type: 'object',
+                  'x-deprecated': 'Use `device_disconnected` instead.',
                 },
                 {
                   description: 'Indicates that the device has been removed.',
@@ -31245,6 +31288,7 @@ const openapi: OpenAPISpec = {
                   'x-variant-group-key': 'locks',
                 },
                 {
+                  deprecated: true,
                   description:
                     'Indicates that the lock is not connected to a bridge.',
                   properties: {
@@ -31279,11 +31323,13 @@ const openapi: OpenAPISpec = {
                     'error_code',
                   ],
                   type: 'object',
+                  'x-deprecated': 'Use `hub_disconnected` instead.',
                   'x-variant-group-key': 'locks',
                 },
                 {
+                  deprecated: true,
                   description:
-                    '\n    Indicates that the lock is not paired with a gateway.\n    ',
+                    'Indicates that the lock is not paired with a gateway.',
                   properties: {
                     created_at: {
                       description:
@@ -31316,6 +31362,7 @@ const openapi: OpenAPISpec = {
                     'error_code',
                   ],
                   type: 'object',
+                  'x-deprecated': 'Use `hub_disconnected` instead.',
                 },
                 {
                   description: 'Indicates that device credentials are missing.',
@@ -31425,8 +31472,9 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                 },
                 {
+                  deprecated: true,
                   description:
-                    '\n    Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n    ',
+                    'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
                   properties: {
                     created_at: {
                       description:
@@ -31459,6 +31507,7 @@ const openapi: OpenAPISpec = {
                     'error_code',
                   ],
                   type: 'object',
+                  'x-deprecated': 'Use `hub_disconnected` instead.',
                 },
                 {
                   description:
@@ -31751,8 +31800,9 @@ const openapi: OpenAPISpec = {
                   'x-variant-group-key': 'access_codes',
                 },
                 {
+                  deprecated: true,
                   description:
-                    '\n    Indicates that the Wyze Lock is not connected to a gateway.\n    ',
+                    'Indicates that the Wyze Lock is not connected to a gateway.',
                   properties: {
                     created_at: {
                       description:
@@ -31774,6 +31824,8 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'created_at', 'warning_code'],
                   type: 'object',
+                  'x-deprecated':
+                    'Use `hub_disconnected` device error instead.',
                 },
                 {
                   description:
@@ -57109,7 +57161,7 @@ const openapi: OpenAPISpec = {
     '/devices/simulate/connect_to_hub': {
       post: {
         description:
-          '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.',
+          '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.',
         operationId: 'devicesSimulateConnectToHubPost',
         requestBody: {
           content: {
@@ -57215,7 +57267,7 @@ const openapi: OpenAPISpec = {
     '/devices/simulate/disconnect_from_hub': {
       post: {
         description:
-          '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.',
+          '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.',
         operationId: 'devicesSimulateDisconnectFromHubPost',
         requestBody: {
           content: {