@seamapi/types 1.241.0 → 1.242.0

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

@@ -2342,24 +2342,22 @@ export interface Routes {
                     message: string;
                     warning_code: 'being_deleted';
                 } | {
+                    /** 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;
                     warning_code: 'failed_to_update_on_acs_system';
                 } | {
                     created_at: string;
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
-                } | {
-                    created_at: string;
-                    message: string;
-                    warning_code: 'salto_site_user_suspended';
                 }>;
                 errors: Array<{
                     /** 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;
-                    error_code: 'user_deleted_externally';
+                    error_code: 'deleted_externally';
                 } | {
                     /** Date and time at which Seam created the error. */
                     created_at: string;
@@ -2371,7 +2369,19 @@ export interface Routes {
                     created_at: string;
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
-                    error_code: 'salto_site_user_limit_reached';
+                    warning_code: 'failed_to_create_on_acs_system';
+                } | {
+                    /** 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;
+                    warning_code: 'failed_to_update_on_acs_system';
+                } | {
+                    /** 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;
+                    warning_code: 'failed_to_delete_on_acs_system';
                 }>;
                 full_name?: string | undefined;
                 /**
@@ -3444,24 +3454,22 @@ export interface Routes {
                     message: string;
                     warning_code: 'being_deleted';
                 } | {
+                    /** 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;
                     warning_code: 'failed_to_update_on_acs_system';
                 } | {
                     created_at: string;
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
-                } | {
-                    created_at: string;
-                    message: string;
-                    warning_code: 'salto_site_user_suspended';
                 }>;
                 errors: Array<{
                     /** 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;
-                    error_code: 'user_deleted_externally';
+                    error_code: 'deleted_externally';
                 } | {
                     /** Date and time at which Seam created the error. */
                     created_at: string;
@@ -3473,7 +3481,19 @@ export interface Routes {
                     created_at: string;
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
-                    error_code: 'salto_site_user_limit_reached';
+                    warning_code: 'failed_to_create_on_acs_system';
+                } | {
+                    /** 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;
+                    warning_code: 'failed_to_update_on_acs_system';
+                } | {
+                    /** 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;
+                    warning_code: 'failed_to_delete_on_acs_system';
                 }>;
                 full_name?: string | undefined;
                 /**
@@ -3531,24 +3551,22 @@ export interface Routes {
                     message: string;
                     warning_code: 'being_deleted';
                 } | {
+                    /** 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;
                     warning_code: 'failed_to_update_on_acs_system';
                 } | {
                     created_at: string;
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
-                } | {
-                    created_at: string;
-                    message: string;
-                    warning_code: 'salto_site_user_suspended';
                 }>;
                 errors: Array<{
                     /** 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;
-                    error_code: 'user_deleted_externally';
+                    error_code: 'deleted_externally';
                 } | {
                     /** Date and time at which Seam created the error. */
                     created_at: string;
@@ -3560,7 +3578,19 @@ export interface Routes {
                     created_at: string;
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
-                    error_code: 'salto_site_user_limit_reached';
+                    warning_code: 'failed_to_create_on_acs_system';
+                } | {
+                    /** 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;
+                    warning_code: 'failed_to_update_on_acs_system';
+                } | {
+                    /** 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;
+                    warning_code: 'failed_to_delete_on_acs_system';
                 }>;
                 full_name?: string | undefined;
                 /**
@@ -3612,24 +3642,22 @@ export interface Routes {
                     message: string;
                     warning_code: 'being_deleted';
                 } | {
+                    /** 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;
                     warning_code: 'failed_to_update_on_acs_system';
                 } | {
                     created_at: string;
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
-                } | {
-                    created_at: string;
-                    message: string;
-                    warning_code: 'salto_site_user_suspended';
                 }>;
                 errors: Array<{
                     /** 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;
-                    error_code: 'user_deleted_externally';
+                    error_code: 'deleted_externally';
                 } | {
                     /** Date and time at which Seam created the error. */
                     created_at: string;
@@ -3641,7 +3669,19 @@ export interface Routes {
                     created_at: string;
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
-                    error_code: 'salto_site_user_limit_reached';
+                    warning_code: 'failed_to_create_on_acs_system';
+                } | {
+                    /** 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;
+                    warning_code: 'failed_to_update_on_acs_system';
+                } | {
+                    /** 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;
+                    warning_code: 'failed_to_delete_on_acs_system';
                 }>;
                 full_name?: string | undefined;
                 /**
@@ -3758,24 +3798,22 @@ export interface Routes {
                     message: string;
                     warning_code: 'being_deleted';
                 } | {
+                    /** 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;
                     warning_code: 'failed_to_update_on_acs_system';
                 } | {
                     created_at: string;
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
-                } | {
-                    created_at: string;
-                    message: string;
-                    warning_code: 'salto_site_user_suspended';
                 }>;
                 errors: Array<{
                     /** 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;
-                    error_code: 'user_deleted_externally';
+                    error_code: 'deleted_externally';
                 } | {
                     /** Date and time at which Seam created the error. */
                     created_at: string;
@@ -3787,7 +3825,19 @@ export interface Routes {
                     created_at: string;
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
-                    error_code: 'salto_site_user_limit_reached';
+                    warning_code: 'failed_to_create_on_acs_system';
+                } | {
+                    /** 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;
+                    warning_code: 'failed_to_update_on_acs_system';
+                } | {
+                    /** 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;
+                    warning_code: 'failed_to_delete_on_acs_system';
                 }>;
                 full_name?: string | undefined;
                 /**
@@ -3838,24 +3888,22 @@ export interface Routes {
                     message: string;
                     warning_code: 'being_deleted';
                 } | {
+                    /** 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;
                     warning_code: 'failed_to_update_on_acs_system';
                 } | {
                     created_at: string;
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
-                } | {
-                    created_at: string;
-                    message: string;
-                    warning_code: 'salto_site_user_suspended';
                 }>;
                 errors: Array<{
                     /** 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;
-                    error_code: 'user_deleted_externally';
+                    error_code: 'deleted_externally';
                 } | {
                     /** Date and time at which Seam created the error. */
                     created_at: string;
@@ -3867,7 +3915,19 @@ export interface Routes {
                     created_at: string;
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
-                    error_code: 'salto_site_user_limit_reached';
+                    warning_code: 'failed_to_create_on_acs_system';
+                } | {
+                    /** 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;
+                    warning_code: 'failed_to_update_on_acs_system';
+                } | {
+                    /** 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;
+                    warning_code: 'failed_to_delete_on_acs_system';
                 }>;
                 full_name?: string | undefined;
                 /**
@@ -15890,24 +15950,22 @@ export interface Routes {
                     message: string;
                     warning_code: 'being_deleted';
                 } | {
+                    /** 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;
                     warning_code: 'failed_to_update_on_acs_system';
                 } | {
                     created_at: string;
                     message: string;
                     warning_code: 'salto_ks_user_not_subscribed';
-                } | {
-                    created_at: string;
-                    message: string;
-                    warning_code: 'salto_site_user_suspended';
                 }>;
                 errors: Array<{
                     /** 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;
-                    error_code: 'user_deleted_externally';
+                    error_code: 'deleted_externally';
                 } | {
                     /** Date and time at which Seam created the error. */
                     created_at: string;
@@ -15919,7 +15977,19 @@ export interface Routes {
                     created_at: string;
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
-                    error_code: 'salto_site_user_limit_reached';
+                    warning_code: 'failed_to_create_on_acs_system';
+                } | {
+                    /** 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;
+                    warning_code: 'failed_to_update_on_acs_system';
+                } | {
+                    /** 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;
+                    warning_code: 'failed_to_delete_on_acs_system';
                 }>;
                 full_name?: string | undefined;
                 /**

package/package.json

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

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

@@ -25,12 +25,12 @@ const common_acs_user_error = z.object({
     ),
 })
 
-const acs_users_user_deleted_externally = common_acs_user_error
+const acs_users_deleted_externally = common_acs_user_error
   .extend({
-    error_code: z.literal('user_deleted_externally'),
+    error_code: z.literal('deleted_externally'),
   })
   .describe(
-    `Indicates that the user was deleted from the ACS system outside of Seam.`,
+    `Indicates that the ACS user was deleted from the ACS system outside of Seam.`,
   )
 
 const acs_users_salto_ks_subscription_limit_exceeded = common_acs_user_error
@@ -41,37 +41,63 @@ const acs_users_salto_ks_subscription_limit_exceeded = common_acs_user_error
     `Indicates that the user could not be subscribed on Salto KS because the subscription limit has been exceeded.`,
   )
 
-const acs_users_salto_site_user_limit_reached = common_acs_user_error.extend({
-  error_code: z.literal('salto_site_user_limit_reached'),
-})
+const acs_users_failed_to_create_on_acs_system = common_acs_user_error
+  .extend({
+    warning_code: z.literal('failed_to_create_on_acs_system'),
+  })
+  .describe(
+    `Indicates that the user was not created on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.`,
+  )
+
+const acs_users_failed_to_update_on_acs_system = common_acs_user_error
+  .extend({
+    warning_code: z.literal('failed_to_update_on_acs_system'),
+  })
+  .describe(
+    `Indicates that the user was not updated on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.`,
+  )
+
+const acs_users_failed_to_delete_on_acs_system = common_acs_user_error
+  .extend({
+    warning_code: z.literal('failed_to_delete_on_acs_system'),
+  })
+  .describe(
+    `Indicates that the user was not deleted on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.`,
+  )
 
 const acs_user_errors = z
   .union([
-    acs_users_user_deleted_externally,
+    acs_users_deleted_externally,
     acs_users_salto_ks_subscription_limit_exceeded,
-    acs_users_salto_site_user_limit_reached,
+    acs_users_failed_to_create_on_acs_system,
+    acs_users_failed_to_update_on_acs_system,
+    acs_users_failed_to_delete_on_acs_system,
   ])
   .describe('Error associated with the `acs_user`.')
 
 export const acs_users_error_map = z.object({
-  user_deleted_externally: acs_users_user_deleted_externally
-    .optional()
-    .nullable(),
+  deleted_externally: acs_users_deleted_externally.optional().nullable(),
   salto_ks_subscription_limit_exceeded:
     acs_users_salto_ks_subscription_limit_exceeded.optional().nullable(),
-  salto_site_user_limit_reached: acs_users_salto_site_user_limit_reached
+  failed_to_create_on_acs_system: acs_users_failed_to_create_on_acs_system
+    .optional()
+    .nullable(),
+  failed_to_update_on_acs_system: acs_users_failed_to_update_on_acs_system
+    .optional()
+    .nullable(),
+  failed_to_delete_on_acs_system: acs_users_failed_to_delete_on_acs_system
     .optional()
     .nullable(),
 })
 
 export type AcsUsersErrorMap = z.infer<typeof acs_users_error_map>
 
-const common_acs_users_warning = z.object({
+const common_acs_user_warning = z.object({
   created_at: z.string().datetime(),
   message: z.string(),
 })
 
-const acs_users_being_deleted = common_acs_users_warning
+const acs_users_being_deleted = common_acs_user_warning
   .extend({
     warning_code: z.literal('being_deleted'),
   })
@@ -79,7 +105,7 @@ const acs_users_being_deleted = common_acs_users_warning
     `Indicates that the user is being deleted from the ACS system. This is a temporary state, and the user will be deleted shortly.`,
   )
 
-const acs_users_salto_ks_user_not_subscribed = common_acs_users_warning
+const acs_users_salto_ks_user_not_subscribed = common_acs_user_warning
   .extend({
     warning_code: z.literal('salto_ks_user_not_subscribed'),
   })
@@ -87,30 +113,11 @@ const acs_users_salto_ks_user_not_subscribed = common_acs_users_warning
     `Indicates that the user is not subscribed on the Salto KS, so they cannot unlock doors or perform any actions. This occur when the their access schedule hasn’t started yet, or if their access schedule has ended, or if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.`,
   )
 
-const acs_users_failed_to_update_on_acs_system = common_acs_users_warning
-  .extend({
-    warning_code: z.literal('failed_to_update_on_acs_system'),
-  })
-  .describe(
-    `Indicates that the user was not updated on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.`,
-  )
-
-// TODO: Some acs_users already have this warning, so we need to keep it here until we migrate
-const acs_users_salto_site_user_suspended = common_acs_users_warning.extend({
-  warning_code: z.literal('salto_site_user_suspended'),
-})
-
 export const acs_users_warning_map = z.object({
   being_deleted: acs_users_being_deleted.optional().nullable(),
-  failed_to_update_on_acs_system: acs_users_failed_to_update_on_acs_system
-    .optional()
-    .nullable(),
   salto_ks_user_not_subscribed: acs_users_salto_ks_user_not_subscribed
     .optional()
     .nullable(),
-  salto_site_user_suspended: acs_users_salto_site_user_suspended
-    .optional()
-    .nullable(),
 })
 
 export const acs_users_warnings = z
@@ -118,7 +125,6 @@ export const acs_users_warnings = z
     acs_users_being_deleted,
     acs_users_failed_to_update_on_acs_system,
     acs_users_salto_ks_user_not_subscribed,
-    acs_users_salto_site_user_suspended,
   ])
   .describe('Warning associated with the `acs_user`.')