@seamapi/types 1.413.0 → 1.414.0

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

@@ -14732,6 +14732,10 @@ export interface Routes {
             location_id?: (string | null) | undefined;
             /** ID of the space for which you want to list entrances. */
             space_id?: string | undefined;
+            /** ID of the access grant for which you want to retrieve all entrances. */
+            access_grant_id?: string | undefined;
+            /** ID of the access method for which you want to retrieve all entrances. */
+            access_method_id?: string | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -41876,8 +41880,6 @@ export interface Routes {
                         is_being_activated: boolean;
                     };
                     acs_credentials: Array<{
-                        /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
-                        acs_credential_id: string;
                         /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
                         acs_user_id?: string | undefined;
                         acs_credential_pool_id?: string | undefined;
@@ -41987,6 +41989,7 @@ export interface Routes {
                             endpoint_id?: string | undefined;
                         } | undefined;
                         is_managed: true;
+                        acs_credential_id?: string | undefined;
                         acs_entrances: Array<{
                             /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                             acs_system_id: string;
@@ -57174,6 +57177,22 @@ export interface Routes {
                 created_at: string;
                 /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
                 workspace_id: string;
+                /** Array of errors associated with the user identity. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
+                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;
+                }>;
+                /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
+                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;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'being_deleted';
+                }>;
             };
         };
     };
@@ -57335,6 +57354,22 @@ export interface Routes {
                 created_at: string;
                 /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
                 workspace_id: string;
+                /** Array of errors associated with the user identity. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
+                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;
+                }>;
+                /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
+                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;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'being_deleted';
+                }>;
             };
         };
     };
@@ -57378,6 +57413,22 @@ export interface Routes {
                 created_at: string;
                 /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
                 workspace_id: string;
+                /** Array of errors associated with the user identity. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
+                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;
+                }>;
+                /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
+                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;
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'being_deleted';
+                }>;
             }>;
         };
     };

package/package.json

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

package/src/lib/seam/connect/models/phones/phone-session.ts

@@ -7,7 +7,11 @@ import { phone_registration } from './phone-registration.js'
 const phone_provider_session = z.object({
   phone_registration,
   acs_credentials: acs_credential
+    .omit({
+      acs_credential_id: true,
+    })
     .extend({
+      acs_credential_id: z.string().optional(),
       acs_entrances: acs_entrance.array(),
     })
     .array(),

package/src/lib/seam/connect/models/user-identities/user-identity.ts

@@ -2,6 +2,56 @@ import { z } from 'zod'
 
 import { phone_number } from '../phone-number.js'
 
+const common_user_identity_error = z.object({
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which Seam created the error.'),
+  message: z
+    .string()
+    .describe(
+      'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+    ),
+})
+
+const common_user_identity_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 user_identity_being_deleted = common_user_identity_warning
+  .extend({
+    warning_code: z
+      .literal('being_deleted')
+      .describe(
+        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+      ),
+  })
+  .describe('Indicates that the user identity is currently being deleted.')
+
+export const user_identity_error_map = z.object({})
+
+export type UserIdentityErrorMap = z.infer<typeof user_identity_error_map>
+
+const user_identity_warnings = z
+  .discriminatedUnion('warning_code', [user_identity_being_deleted])
+  .describe('Warnings associated with the user identity.')
+
+export const user_identity_warning_map = z.object({
+  user_identity_being_deleted: user_identity_being_deleted
+    .optional()
+    .nullable(),
+})
+
+export type UserIdentityWarningMap = z.infer<typeof user_identity_warning_map>
+
 export const user_identity = z.object({
   user_identity_id: z.string().uuid().describe('ID of the user identity.'),
   user_identity_key: z
@@ -31,6 +81,16 @@ export const user_identity = z.object({
     .describe(
       'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
     ),
+  errors: z
+    .array(common_user_identity_error)
+    .describe(
+      'Array of errors associated with the user identity. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
+    ),
+  warnings: z
+    .array(user_identity_warnings)
+    .describe(
+      'Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
+    ),
 }).describe(`
   ---
   route_path: /user_identities

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

@@ -16434,12 +16434,7 @@ export default {
                         enum: ['code', 'card', 'mobile_key'],
                         type: 'string',
                       },
-                      acs_credential_id: {
-                        description:
-                          'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
-                        format: 'uuid',
-                        type: 'string',
-                      },
+                      acs_credential_id: { type: 'string' },
                       acs_credential_pool_id: {
                         format: 'uuid',
                         type: 'string',
@@ -16988,7 +16983,6 @@ export default {
                       },
                     },
                     required: [
-                      'acs_credential_id',
                       'acs_system_id',
                       'display_name',
                       'access_method',
@@ -20821,6 +20815,27 @@ export default {
             nullable: true,
             type: 'string',
           },
+          errors: {
+            description:
+              'Array of errors associated with the user identity. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
+            items: {
+              properties: {
+                created_at: {
+                  description: 'Date and time at which Seam created the error.',
+                  format: 'date-time',
+                  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'],
+              type: 'object',
+            },
+            type: 'array',
+          },
           full_name: { minLength: 1, nullable: true, type: 'string' },
           phone_number: {
             description:
@@ -20839,6 +20854,42 @@ export default {
             nullable: true,
             type: 'string',
           },
+          warnings: {
+            description:
+              'Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
+            items: {
+              description: 'Warnings associated with the user identity.',
+              discriminator: { propertyName: 'warning_code' },
+              oneOf: [
+                {
+                  description:
+                    'Indicates that the user identity is currently being deleted.',
+                  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:
+                        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                      enum: ['being_deleted'],
+                      type: 'string',
+                    },
+                  },
+                  required: ['created_at', 'message', 'warning_code'],
+                  type: 'object',
+                },
+              ],
+            },
+            type: 'array',
+          },
           workspace_id: {
             description:
               'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
@@ -20855,6 +20906,8 @@ export default {
           'full_name',
           'created_at',
           'workspace_id',
+          'errors',
+          'warnings',
         ],
         type: 'object',
         'x-route-path': '/user_identities',
@@ -26156,6 +26209,18 @@ export default {
             'application/json': {
               schema: {
                 properties: {
+                  access_grant_id: {
+                    description:
+                      'ID of the access grant for which you want to retrieve all entrances.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  access_method_id: {
+                    description:
+                      'ID of the access method for which you want to retrieve all entrances.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
                   acs_credential_id: {
                     description:
                       'ID of the credential for which you want to retrieve all entrances.',
@@ -39879,7 +39944,7 @@ export default {
     '/user_identities/delete': {
       post: {
         description:
-          'Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.',
+          'Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials), [acs users](https://docs.seam.co/latest/api/access-control-systems/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).',
         operationId: 'userIdentitiesDeletePost',
         requestBody: {
           content: {

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

@@ -16969,6 +16969,10 @@ export interface Routes {
       location_id?: (string | null) | undefined
       /** ID of the space for which you want to list entrances. */
       space_id?: string | undefined
+      /** ID of the access grant for which you want to retrieve all entrances. */
+      access_grant_id?: string | undefined
+      /** ID of the access method for which you want to retrieve all entrances. */
+      access_method_id?: string | undefined
     }
     formData: {}
     jsonResponse: {
@@ -49326,8 +49330,6 @@ export interface Routes {
             is_being_activated: boolean
           }
           acs_credentials: Array<{
-            /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
-            acs_credential_id: string
             /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
             acs_user_id?: string | undefined
             acs_credential_pool_id?: string | undefined
@@ -49463,6 +49465,7 @@ export interface Routes {
                 }
               | undefined
             is_managed: true
+            acs_credential_id?: string | undefined
             acs_entrances: Array<{
               /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
               acs_system_id: string
@@ -67191,6 +67194,22 @@ export interface Routes {
         created_at: string
         /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
         workspace_id: string
+        /** Array of errors associated with the user identity. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
+        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
+        }>
+        /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
+        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
+          /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+          warning_code: 'being_deleted'
+        }>
       }
     }
   }
@@ -67354,6 +67373,22 @@ export interface Routes {
         created_at: string
         /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
         workspace_id: string
+        /** Array of errors associated with the user identity. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
+        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
+        }>
+        /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
+        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
+          /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+          warning_code: 'being_deleted'
+        }>
       }
     }
   }
@@ -67397,6 +67432,22 @@ export interface Routes {
         created_at: string
         /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
         workspace_id: string
+        /** Array of errors associated with the user identity. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
+        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
+        }>
+        /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
+        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
+          /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+          warning_code: 'being_deleted'
+        }>
       }>
     }
   }