@seamapi/types 1.229.1 → 1.231.0

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

@@ -2327,7 +2327,7 @@ export interface Routes {
                 display_name: string;
                 code?: (string | undefined) | null;
                 access_method: 'code' | 'card' | 'mobile_key';
-                external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card') | undefined;
+                external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
                 external_type_display_name?: string | undefined;
                 created_at: string;
                 workspace_id: string;
@@ -2389,7 +2389,7 @@ export interface Routes {
                 display_name: string;
                 code?: (string | undefined) | null;
                 access_method: 'code' | 'card' | 'mobile_key';
-                external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card') | undefined;
+                external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
                 external_type_display_name?: string | undefined;
                 created_at: string;
                 workspace_id: string;
@@ -2445,7 +2445,7 @@ export interface Routes {
                 display_name: string;
                 code?: (string | undefined) | null;
                 access_method: 'code' | 'card' | 'mobile_key';
-                external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card') | undefined;
+                external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
                 external_type_display_name?: string | undefined;
                 created_at: string;
                 workspace_id: string;
@@ -2501,7 +2501,7 @@ export interface Routes {
                 display_name: string;
                 code?: (string | undefined) | null;
                 access_method: 'code' | 'card' | 'mobile_key';
-                external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card') | undefined;
+                external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
                 external_type_display_name?: string | undefined;
                 created_at: string;
                 workspace_id: string;
@@ -2583,7 +2583,7 @@ export interface Routes {
                 display_name: string;
                 code?: (string | undefined) | null;
                 access_method: 'code' | 'card' | 'mobile_key';
-                external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card') | undefined;
+                external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
                 external_type_display_name?: string | undefined;
                 created_at: string;
                 workspace_id: string;
@@ -2630,7 +2630,7 @@ export interface Routes {
                 display_name: string;
                 code?: (string | undefined) | null;
                 access_method: 'code' | 'card' | 'mobile_key';
-                external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card') | undefined;
+                external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
                 external_type_display_name?: string | undefined;
                 created_at: string;
                 workspace_id: string;
@@ -2761,7 +2761,7 @@ export interface Routes {
                 display_name: string;
                 code?: (string | undefined) | null;
                 access_method: 'code' | 'card' | 'mobile_key';
-                external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card') | undefined;
+                external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
                 external_type_display_name?: string | undefined;
                 created_at: string;
                 workspace_id: string;
@@ -2849,7 +2849,7 @@ export interface Routes {
                     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. */
+                    /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
                     error_code: 'salto_site_user_limit_reached';
                 }>;
                 /** Warnings associated with the `acs_system`. */
@@ -2933,7 +2933,7 @@ export interface Routes {
                     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. */
+                    /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
                     error_code: 'salto_site_user_limit_reached';
                 }>;
                 /** Warnings associated with the `acs_system`. */
@@ -3017,7 +3017,7 @@ export interface Routes {
                     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. */
+                    /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
                     error_code: 'salto_site_user_limit_reached';
                 }>;
                 /** Warnings associated with the `acs_system`. */
@@ -3282,6 +3282,50 @@ export interface Routes {
         formData: {};
         jsonResponse: {};
     };
+    '/acs/users/unmanaged/get': {
+        route: '/acs/users/unmanaged/get';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            acs_user_id: string;
+        };
+        formData: {};
+        jsonResponse: {
+            acs_user: {
+                acs_user_id: string;
+                acs_system_id: string;
+                hid_acs_system_id?: string | undefined;
+                workspace_id: string;
+                created_at: string;
+                display_name: string;
+                external_type?: ('pti_user' | 'brivo_user' | 'hid_credential_manager_user' | 'salto_site_user' | 'latch_user') | undefined;
+                external_type_display_name?: string | undefined;
+                is_suspended: boolean;
+                access_schedule?: {
+                    starts_at: string;
+                    ends_at: string;
+                } | undefined;
+                user_identity_id?: string | undefined;
+                user_identity_full_name?: (string | null) | undefined;
+                user_identity_email_address?: (string | null) | undefined;
+                user_identity_phone_number?: (string | null) | undefined;
+                latest_desired_state_synced_with_provider_at?: string | undefined;
+                is_latest_desired_state_synced_with_provider?: boolean | undefined;
+                warnings: Array<{
+                    created_at: string;
+                    message: string;
+                    warning_code: 'being_deleted';
+                }>;
+                full_name?: string | undefined;
+                /**
+                 * @deprecated use email_address. */
+                email?: string | undefined;
+                email_address?: string | undefined;
+                phone_number?: string | undefined;
+            };
+        };
+    };
     '/acs/users/unsuspend': {
         route: '/acs/users/unsuspend';
         method: 'POST';
@@ -14128,7 +14172,7 @@ export interface Routes {
                     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. */
+                    /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
                     error_code: 'salto_site_user_limit_reached';
                 }>;
                 /** Warnings associated with the `acs_system`. */

package/package.json

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

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

@@ -8,6 +8,7 @@ export const acs_credential_external_type = z.enum([
   'brivo_credential',
   'hid_credential',
   'visionline_card',
+  'salto_ks_credential',
 ])
 
 export const acs_credential_access_method_type = z.enum([

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

@@ -77,7 +77,7 @@ 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.',
+      'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
     ),
 })
 

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

@@ -265,6 +265,7 @@ export default {
               'brivo_credential',
               'hid_credential',
               'visionline_card',
+              'salto_ks_credential',
             ],
             type: 'string',
           },
@@ -543,7 +544,7 @@ export default {
                     },
                     error_code: {
                       description:
-                        'You have reached the maximum number of users allowed for your site; Please contact Salto support to increase your user limit.',
+                        'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
                       enum: ['salto_site_user_limit_reached'],
                       type: 'string',
                     },
@@ -7030,6 +7031,51 @@ export default {
         'x-fern-sdk-method-name': 'suspend',
       },
     },
+    '/acs/users/unmanaged/get': {
+      post: {
+        operationId: 'acsUsersUnmanagedGetPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: { acs_user_id: { format: 'uuid', type: 'string' } },
+                required: ['acs_user_id'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    acs_user: { $ref: '#/components/schemas/acs_user' },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['acs_user', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session: [] },
+          { api_key: [] },
+        ],
+        summary: '/acs/users/unmanaged/get',
+        tags: ['/acs'],
+        'x-fern-sdk-group-name': ['acs', 'users', 'unmanaged'],
+        'x-fern-sdk-method-name': 'get',
+        'x-fern-sdk-return-value': 'acs_user',
+      },
+    },
     '/acs/users/unsuspend': {
       post: {
         operationId: 'acsUsersUnsuspendPost',

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

@@ -2582,6 +2582,7 @@ export interface Routes {
               | 'brivo_credential'
               | 'hid_credential'
               | 'visionline_card'
+              | 'salto_ks_credential'
             )
           | undefined
         external_type_display_name?: string | undefined
@@ -2657,6 +2658,7 @@ export interface Routes {
               | 'brivo_credential'
               | 'hid_credential'
               | 'visionline_card'
+              | 'salto_ks_credential'
             )
           | undefined
         external_type_display_name?: string | undefined
@@ -2722,6 +2724,7 @@ export interface Routes {
               | 'brivo_credential'
               | 'hid_credential'
               | 'visionline_card'
+              | 'salto_ks_credential'
             )
           | undefined
         external_type_display_name?: string | undefined
@@ -2792,6 +2795,7 @@ export interface Routes {
               | 'brivo_credential'
               | 'hid_credential'
               | 'visionline_card'
+              | 'salto_ks_credential'
             )
           | undefined
         external_type_display_name?: string | undefined
@@ -2894,6 +2898,7 @@ export interface Routes {
               | 'brivo_credential'
               | 'hid_credential'
               | 'visionline_card'
+              | 'salto_ks_credential'
             )
           | undefined
         external_type_display_name?: string | undefined
@@ -2950,6 +2955,7 @@ export interface Routes {
               | 'brivo_credential'
               | 'hid_credential'
               | 'visionline_card'
+              | 'salto_ks_credential'
             )
           | undefined
         external_type_display_name?: string | undefined
@@ -3112,6 +3118,7 @@ export interface Routes {
               | 'brivo_credential'
               | 'hid_credential'
               | 'visionline_card'
+              | 'salto_ks_credential'
             )
           | undefined
         external_type_display_name?: string | undefined
@@ -3230,7 +3237,7 @@ export interface Routes {
               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. */
+              /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
               error_code: 'salto_site_user_limit_reached'
             }
         >
@@ -3342,7 +3349,7 @@ export interface Routes {
               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. */
+              /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
               error_code: 'salto_site_user_limit_reached'
             }
         >
@@ -3454,7 +3461,7 @@ export interface Routes {
               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. */
+              /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
               error_code: 'salto_site_user_limit_reached'
             }
         >
@@ -3763,6 +3770,60 @@ export interface Routes {
     formData: {}
     jsonResponse: {}
   }
+  '/acs/users/unmanaged/get': {
+    route: '/acs/users/unmanaged/get'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      acs_user_id: string
+    }
+    formData: {}
+    jsonResponse: {
+      acs_user: {
+        acs_user_id: string
+        acs_system_id: string
+        hid_acs_system_id?: string | undefined
+        workspace_id: string
+        created_at: string
+        display_name: string
+        external_type?:
+          | (
+              | 'pti_user'
+              | 'brivo_user'
+              | 'hid_credential_manager_user'
+              | 'salto_site_user'
+              | 'latch_user'
+            )
+          | undefined
+        external_type_display_name?: string | undefined
+        is_suspended: boolean
+        access_schedule?:
+          | {
+              starts_at: string
+              ends_at: string
+            }
+          | undefined
+        user_identity_id?: string | undefined
+        user_identity_full_name?: (string | null) | undefined
+        user_identity_email_address?: (string | null) | undefined
+        user_identity_phone_number?: (string | null) | undefined
+        latest_desired_state_synced_with_provider_at?: string | undefined
+        is_latest_desired_state_synced_with_provider?: boolean | undefined
+        warnings: Array<{
+          created_at: string
+          message: string
+          warning_code: 'being_deleted'
+        }>
+        full_name?: string | undefined
+        /**
+         * @deprecated use email_address. */
+        email?: string | undefined
+        email_address?: string | undefined
+        phone_number?: string | undefined
+      }
+    }
+  }
   '/acs/users/unsuspend': {
     route: '/acs/users/unsuspend'
     method: 'POST'
@@ -18015,7 +18076,7 @@ export interface Routes {
               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. */
+              /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
               error_code: 'salto_site_user_limit_reached'
             }
         >