@seamapi/types 1.374.0 → 1.375.0

package/package.json

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

package/src/lib/seam/connect/models/acs/acs-system.ts

@@ -79,7 +79,14 @@ const seam_bridge_disconnected = common_acs_system_error.extend({
 })
   .describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
   This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
-  See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`)
+  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).`)
+
+const bridge_disconnected = common_acs_system_error.extend({
+  error_code: z.literal('bridge_disconnected').describe(error_code_description),
+  is_bridge_error: z.boolean().optional(),
+})
+  .describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if 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).`)
 
 const visionline_instance_unreachable = common_acs_system_error.extend({
   error_code: z
@@ -132,6 +139,7 @@ const salto_ks_certification_expired = common_acs_system_error
 const acs_system_error = z
   .discriminatedUnion('error_code', [
     seam_bridge_disconnected,
+    bridge_disconnected,
     visionline_instance_unreachable,
     salto_ks_subscription_limit_exceeded,
     acs_system_disconnected,
@@ -144,6 +152,7 @@ const acs_system_error = z
 
 export const acs_system_error_map = z.object({
   seam_bridge_disconnected: seam_bridge_disconnected.optional().nullable(),
+  bridge_disconnected: bridge_disconnected.optional().nullable(),
   visionline_instance_unreachable: visionline_instance_unreachable
     .optional()
     .nullable(),

package/src/lib/seam/connect/models/connected-accounts/connected-account.ts

@@ -8,7 +8,8 @@ const common_connected_account_error = z.object({
     .datetime()
     .describe('Date and time at which Seam created the error.'),
   message: z.string(),
-  is_connected_account_error: z.literal(true),
+  is_connected_account_error: z.boolean().optional(),
+  is_bridge_error: z.boolean().optional(),
 })
 
 const error_code_description =
@@ -41,6 +42,12 @@ export const invalid_credentials = common_connected_account_error
   })
   .describe('Credentials provided were invalid.')
 
+export const bridge_disconnected = common_connected_account_error.extend({
+  error_code: z.literal('bridge_disconnected').describe(error_code_description),
+})
+  .describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if 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).`)
+
 export const salto_ks_subscription_limit_exceeded =
   common_connected_account_error
     .extend({
@@ -65,12 +72,14 @@ export const salto_ks_subscription_limit_exceeded =
 export const connected_account_error = z.discriminatedUnion('error_code', [
   account_disconnected,
   invalid_credentials,
+  bridge_disconnected,
   salto_ks_subscription_limit_exceeded,
 ])
 
 const connected_account_error_map = z.object({
   account_disconnected: account_disconnected.nullable().optional(),
   invalid_credentials: invalid_credentials.nullable().optional(),
+  bridge_disconnected: bridge_disconnected.nullable().optional(),
   salto_ks_subscription_limit_exceeded: salto_ks_subscription_limit_exceeded
     .nullable()
     .optional(),

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

@@ -737,18 +737,34 @@ export default {
                       enum: ['invalid_credentials'],
                       type: 'string',
                     },
-                    is_connected_account_error: {
-                      enum: [true],
-                      type: 'boolean',
+                    is_bridge_error: { type: 'boolean' },
+                    is_connected_account_error: { type: 'boolean' },
+                    message: { type: 'string' },
+                  },
+                  required: ['created_at', 'message', 'error_code'],
+                  type: 'object',
+                },
+                {
+                  description:
+                    'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n  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).',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
                     },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['bridge_disconnected'],
+                      type: 'string',
+                    },
+                    is_bridge_error: { type: 'boolean' },
+                    is_connected_account_error: { type: 'boolean' },
                     message: { type: 'string' },
                   },
-                  required: [
-                    'created_at',
-                    'message',
-                    'is_connected_account_error',
-                    'error_code',
-                  ],
+                  required: ['created_at', 'message', 'error_code'],
                   type: 'object',
                 },
               ],
@@ -1867,7 +1883,7 @@ export default {
               oneOf: [
                 {
                   description:
-                    'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n  This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n  See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
+                    'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n  This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n  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).',
                   properties: {
                     created_at: {
                       description:
@@ -1890,6 +1906,32 @@ export default {
                   required: ['created_at', 'message', 'error_code'],
                   type: 'object',
                 },
+                {
+                  description:
+                    'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n    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).',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['bridge_disconnected'],
+                      type: 'string',
+                    },
+                    is_bridge_error: { type: 'boolean' },
+                    message: {
+                      description:
+                        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                  },
+                  required: ['created_at', 'message', 'error_code'],
+                  type: 'object',
+                },
                 {
                   description:
                     'Indicates that [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).\n  For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n  See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).',
@@ -6093,18 +6135,11 @@ export default {
                       enum: ['account_disconnected'],
                       type: 'string',
                     },
-                    is_connected_account_error: {
-                      enum: [true],
-                      type: 'boolean',
-                    },
+                    is_bridge_error: { type: 'boolean' },
+                    is_connected_account_error: { type: 'boolean' },
                     message: { type: 'string' },
                   },
-                  required: [
-                    'created_at',
-                    'message',
-                    'is_connected_account_error',
-                    'error_code',
-                  ],
+                  required: ['created_at', 'message', 'error_code'],
                   type: 'object',
                 },
                 {
@@ -6122,18 +6157,34 @@ export default {
                       enum: ['invalid_credentials'],
                       type: 'string',
                     },
-                    is_connected_account_error: {
-                      enum: [true],
-                      type: 'boolean',
+                    is_bridge_error: { type: 'boolean' },
+                    is_connected_account_error: { type: 'boolean' },
+                    message: { type: 'string' },
+                  },
+                  required: ['created_at', 'message', 'error_code'],
+                  type: 'object',
+                },
+                {
+                  description:
+                    'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n  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).',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['bridge_disconnected'],
+                      type: 'string',
                     },
+                    is_bridge_error: { type: 'boolean' },
+                    is_connected_account_error: { type: 'boolean' },
                     message: { type: 'string' },
                   },
-                  required: [
-                    'created_at',
-                    'message',
-                    'is_connected_account_error',
-                    'error_code',
-                  ],
+                  required: ['created_at', 'message', 'error_code'],
                   type: 'object',
                 },
                 {
@@ -6152,10 +6203,8 @@ export default {
                       enum: ['salto_ks_subscription_limit_exceeded'],
                       type: 'string',
                     },
-                    is_connected_account_error: {
-                      enum: [true],
-                      type: 'boolean',
-                    },
+                    is_bridge_error: { type: 'boolean' },
+                    is_connected_account_error: { type: 'boolean' },
                     message: { type: 'string' },
                     salto_ks_metadata: {
                       properties: {
@@ -6191,7 +6240,6 @@ export default {
                   required: [
                     'created_at',
                     'message',
-                    'is_connected_account_error',
                     'error_code',
                     'salto_ks_metadata',
                   ],
@@ -6745,18 +6793,34 @@ export default {
                       enum: ['invalid_credentials'],
                       type: 'string',
                     },
-                    is_connected_account_error: {
-                      enum: [true],
-                      type: 'boolean',
+                    is_bridge_error: { type: 'boolean' },
+                    is_connected_account_error: { type: 'boolean' },
+                    message: { type: 'string' },
+                  },
+                  required: ['created_at', 'message', 'error_code'],
+                  type: 'object',
+                },
+                {
+                  description:
+                    'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n  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).',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
                     },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['bridge_disconnected'],
+                      type: 'string',
+                    },
+                    is_bridge_error: { type: 'boolean' },
+                    is_connected_account_error: { type: 'boolean' },
                     message: { type: 'string' },
                   },
-                  required: [
-                    'created_at',
-                    'message',
-                    'is_connected_account_error',
-                    'error_code',
-                  ],
+                  required: ['created_at', 'message', 'error_code'],
                   type: 'object',
                 },
               ],
@@ -14098,18 +14162,34 @@ export default {
                       enum: ['invalid_credentials'],
                       type: 'string',
                     },
-                    is_connected_account_error: {
-                      enum: [true],
-                      type: 'boolean',
+                    is_bridge_error: { type: 'boolean' },
+                    is_connected_account_error: { type: 'boolean' },
+                    message: { type: 'string' },
+                  },
+                  required: ['created_at', 'message', 'error_code'],
+                  type: 'object',
+                },
+                {
+                  description:
+                    'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n  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).',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
                     },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['bridge_disconnected'],
+                      type: 'string',
+                    },
+                    is_bridge_error: { type: 'boolean' },
+                    is_connected_account_error: { type: 'boolean' },
                     message: { type: 'string' },
                   },
-                  required: [
-                    'created_at',
-                    'message',
-                    'is_connected_account_error',
-                    'error_code',
-                  ],
+                  required: ['created_at', 'message', 'error_code'],
                   type: 'object',
                 },
               ],
@@ -15752,18 +15832,34 @@ export default {
                       enum: ['invalid_credentials'],
                       type: 'string',
                     },
-                    is_connected_account_error: {
-                      enum: [true],
-                      type: 'boolean',
+                    is_bridge_error: { type: 'boolean' },
+                    is_connected_account_error: { type: 'boolean' },
+                    message: { type: 'string' },
+                  },
+                  required: ['created_at', 'message', 'error_code'],
+                  type: 'object',
+                },
+                {
+                  description:
+                    'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n  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).',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+                      enum: ['bridge_disconnected'],
+                      type: 'string',
                     },
+                    is_bridge_error: { type: 'boolean' },
+                    is_connected_account_error: { type: 'boolean' },
                     message: { type: 'string' },
                   },
-                  required: [
-                    'created_at',
-                    'message',
-                    'is_connected_account_error',
-                    'error_code',
-                  ],
+                  required: ['created_at', 'message', 'error_code'],
                   type: 'object',
                 },
               ],