@seamapi/types 1.222.0 → 1.223.0

package/lib/seam/connect/route-types.d.ts

@@ -2808,9 +2808,23 @@ export interface Routes {
                     message: string;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'visionline_instance_unreachable';
+                } | {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** You have reached the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
+                    error_code: 'salto_site_user_limit_reached';
+                }>;
+                /** Warnings associated with the `acs_system`. */
+                warnings: Array<{
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
+                    warning_code: 'salto_site_user_limit_almost_reached';
                 }>;
-                /**  */
-                warnings: Array<{}>;
                 /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
                 can_automate_enrollment?: boolean | undefined;
                 /** Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
@@ -2878,9 +2892,23 @@ export interface Routes {
                     message: string;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'visionline_instance_unreachable';
+                } | {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** You have reached the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
+                    error_code: 'salto_site_user_limit_reached';
+                }>;
+                /** Warnings associated with the `acs_system`. */
+                warnings: Array<{
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
+                    warning_code: 'salto_site_user_limit_almost_reached';
                 }>;
-                /**  */
-                warnings: Array<{}>;
                 /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
                 can_automate_enrollment?: boolean | undefined;
                 /** Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
@@ -2948,9 +2976,23 @@ export interface Routes {
                     message: string;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'visionline_instance_unreachable';
+                } | {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** You have reached the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
+                    error_code: 'salto_site_user_limit_reached';
+                }>;
+                /** Warnings associated with the `acs_system`. */
+                warnings: Array<{
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
+                    warning_code: 'salto_site_user_limit_almost_reached';
                 }>;
-                /**  */
-                warnings: Array<{}>;
                 /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
                 can_automate_enrollment?: boolean | undefined;
                 /** Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
@@ -15570,9 +15612,23 @@ export interface Routes {
                     message: string;
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'visionline_instance_unreachable';
+                } | {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** You have reached the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
+                    error_code: 'salto_site_user_limit_reached';
+                }>;
+                /** Warnings associated with the `acs_system`. */
+                warnings: Array<{
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string;
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
+                    warning_code: 'salto_site_user_limit_almost_reached';
                 }>;
-                /**  */
-                warnings: Array<{}>;
                 /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
                 can_automate_enrollment?: boolean | undefined;
                 /** Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.222.0",
+  "version": "1.223.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",
@@ -92,7 +92,7 @@
     "zod": "^3.21.4"
   },
   "devDependencies": {
-    "@seamapi/blueprint": "^0.12.0",
+    "@seamapi/blueprint": "^0.13.0",
     "@types/node": "^20.8.10",
     "concurrently": "^8.2.0",
     "del-cli": "^5.0.0",

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

@@ -73,8 +73,20 @@ const visionline_instance_unreachable = common_acs_system_error.extend({
   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).
   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).`)
 
+const salto_site_user_limit_reached = common_acs_system_error.extend({
+  error_code: z
+    .literal('salto_site_user_limit_reached')
+    .describe(
+      'You have reached the maximum number of users allowed for your site; Please contact Salto support to increase your user limit.',
+    ),
+})
+
 const acs_system_error = z
-  .union([seam_bridge_disconnected, visionline_instance_unreachable])
+  .union([
+    seam_bridge_disconnected,
+    visionline_instance_unreachable,
+    salto_site_user_limit_reached,
+  ])
   .describe('Error associated with the `acs_system`.')
 
 const acs_system_error_map = z.object({
@@ -82,13 +94,44 @@ const acs_system_error_map = z.object({
   visionline_instance_unreachable: visionline_instance_unreachable
     .optional()
     .nullable(),
+  salto_site_user_limit_reached: salto_site_user_limit_reached
+    .optional()
+    .nullable(),
 })
 
 export type AcsSystemErrorMap = z.infer<typeof acs_system_error_map>
 
-const acs_system_warning = z.object({})
+const common_acs_system_warning = z.object({
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which Seam created the warning.'),
+  message: z
+    .string()
+    .describe(
+      'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+    ),
+})
+
+const salto_site_user_limit_almost_reached = common_acs_system_warning.extend({
+  warning_code: z
+    .literal('salto_site_user_limit_almost_reached')
+    .describe(
+      'You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit.',
+    ),
+})
+
+const acs_system_warning =
+  // z.union([
+  salto_site_user_limit_almost_reached
+    // ])
+    .describe('Warning associated with the `acs_system`.')
 
-const acs_system_warning_map = z.object({})
+const acs_system_warning_map = z.object({
+  salto_site_user_limit_almost_reached: salto_site_user_limit_almost_reached
+    .optional()
+    .nullable(),
+})
 
 export type AcsSystemWarningMap = z.infer<typeof acs_system_warning_map>
 
@@ -150,13 +193,9 @@ export const acs_system = z
     errors: z
       .array(acs_system_error)
       .describe('Errors associated with the `acs_system`.'),
-    warnings: z.array(acs_system_warning).describe(
-      `
-          ---
-          undocumented: Currently, no warnings defined for \`acs_system\`s.
-          ---
-          `,
-    ),
+    warnings: z
+      .array(acs_system_warning)
+      .describe('Warnings associated with the `acs_system`.'),
   })
   .merge(acs_system_capability_flags)
   .describe(

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

@@ -533,6 +533,29 @@ export default {
                   required: ['created_at', 'message', 'error_code'],
                   type: 'object',
                 },
+                {
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the error.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    error_code: {
+                      description:
+                        'You have reached the maximum number of users allowed for your site; Please contact Salto support to increase your user limit.',
+                      enum: ['salto_site_user_limit_reached'],
+                      type: 'string',
+                    },
+                    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',
+                },
               ],
             },
             type: 'array',
@@ -596,10 +619,32 @@ export default {
             type: 'object',
           },
           warnings: {
-            items: { properties: {}, type: 'object' },
+            description: 'Warnings associated with the `acs_system`.',
+            items: {
+              description: 'Warning associated with the `acs_system`.',
+              properties: {
+                created_at: {
+                  description:
+                    'Date and time at which Seam created the warning.',
+                  format: 'date-time',
+                  type: 'string',
+                },
+                message: {
+                  description:
+                    'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+                  type: 'string',
+                },
+                warning_code: {
+                  description:
+                    'You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit.',
+                  enum: ['salto_site_user_limit_almost_reached'],
+                  type: 'string',
+                },
+              },
+              required: ['created_at', 'message', 'warning_code'],
+              type: 'object',
+            },
             type: 'array',
-            'x-undocumented':
-              'Currently, no warnings defined for `acs_system`s.',
           },
           workspace_id: {
             description:

package/src/lib/seam/connect/route-types.ts

@@ -3178,9 +3178,24 @@ export interface Routes {
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
               error_code: 'visionline_instance_unreachable'
             }
+          | {
+              /** Date and time at which Seam created the error. */
+              created_at: string
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** You have reached the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
+              error_code: 'salto_site_user_limit_reached'
+            }
         >
-        /**  */
-        warnings: Array<{}>
+        /** Warnings associated with the `acs_system`. */
+        warnings: Array<{
+          /** Date and time at which Seam created the warning. */
+          created_at: string
+          /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+          message: string
+          /** You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
+          warning_code: 'salto_site_user_limit_almost_reached'
+        }>
         /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
         can_automate_enrollment?: boolean | undefined
         /** Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
@@ -3275,9 +3290,24 @@ export interface Routes {
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
               error_code: 'visionline_instance_unreachable'
             }
+          | {
+              /** Date and time at which Seam created the error. */
+              created_at: string
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** You have reached the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
+              error_code: 'salto_site_user_limit_reached'
+            }
         >
-        /**  */
-        warnings: Array<{}>
+        /** Warnings associated with the `acs_system`. */
+        warnings: Array<{
+          /** Date and time at which Seam created the warning. */
+          created_at: string
+          /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+          message: string
+          /** You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
+          warning_code: 'salto_site_user_limit_almost_reached'
+        }>
         /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
         can_automate_enrollment?: boolean | undefined
         /** Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
@@ -3372,9 +3402,24 @@ export interface Routes {
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
               error_code: 'visionline_instance_unreachable'
             }
+          | {
+              /** Date and time at which Seam created the error. */
+              created_at: string
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** You have reached the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
+              error_code: 'salto_site_user_limit_reached'
+            }
         >
-        /**  */
-        warnings: Array<{}>
+        /** Warnings associated with the `acs_system`. */
+        warnings: Array<{
+          /** Date and time at which Seam created the warning. */
+          created_at: string
+          /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+          message: string
+          /** You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
+          warning_code: 'salto_site_user_limit_almost_reached'
+        }>
         /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
         can_automate_enrollment?: boolean | undefined
         /** Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
@@ -20331,9 +20376,24 @@ export interface Routes {
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
               error_code: 'visionline_instance_unreachable'
             }
+          | {
+              /** Date and time at which Seam created the error. */
+              created_at: string
+              /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** You have reached the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
+              error_code: 'salto_site_user_limit_reached'
+            }
         >
-        /**  */
-        warnings: Array<{}>
+        /** Warnings associated with the `acs_system`. */
+        warnings: Array<{
+          /** Date and time at which Seam created the warning. */
+          created_at: string
+          /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+          message: string
+          /** You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
+          warning_code: 'salto_site_user_limit_almost_reached'
+        }>
         /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
         can_automate_enrollment?: boolean | undefined
         /** Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */