@seamapi/types 1.412.0 → 1.414.0

package/dist/connect.cjs

@@ -3893,7 +3893,8 @@ var client_session = zod.z.object({
   customer_id: zod.z.string().uuid().optional(),
   connected_account_ids: zod.z.array(zod.z.string().uuid()),
   connect_webview_ids: zod.z.array(zod.z.string().uuid()),
-  user_identity_ids: zod.z.array(zod.z.string().uuid())
+  user_identity_ids: zod.z.array(zod.z.string().uuid()).describe("deprecated: Use `user_identity_id`."),
+  user_identity_id: zod.z.string().uuid().optional()
 }).describe(`
   ---
   route_path: /client_sessions
@@ -5108,6 +5109,28 @@ var magic_link = zod.z.object({
   route_path: /unstable_partner/building_blocks
   ---
   `);
+var common_user_identity_error = zod.z.object({
+  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error."),
+  message: zod.z.string().describe(
+    "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
+  )
+});
+var common_user_identity_warning = zod.z.object({
+  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
+  message: zod.z.string().describe(
+    "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
+  )
+});
+var user_identity_being_deleted = common_user_identity_warning.extend({
+  warning_code: zod.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.");
+zod.z.object({});
+var user_identity_warnings = zod.z.discriminatedUnion("warning_code", [user_identity_being_deleted]).describe("Warnings associated with the user identity.");
+zod.z.object({
+  user_identity_being_deleted: user_identity_being_deleted.optional().nullable()
+});
 var user_identity = zod.z.object({
   user_identity_id: zod.z.string().uuid().describe("ID of the user identity."),
   user_identity_key: zod.z.string().min(1).nullable().describe("Unique key for the user identity."),
@@ -5120,6 +5143,12 @@ var user_identity = zod.z.object({
   created_at: zod.z.string().datetime().describe("Date and time at which the user identity was created."),
   workspace_id: zod.z.string().uuid().describe(
     "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity."
+  ),
+  errors: zod.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: zod.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(`
   ---
@@ -11772,7 +11801,9 @@ var openapi_default = {
           expires_at: { format: "date-time", type: "string" },
           token: { type: "string" },
           user_identifier_key: { nullable: true, type: "string" },
+          user_identity_id: { format: "uuid", type: "string" },
           user_identity_ids: {
+            description: "deprecated: Use `user_identity_id`.",
             items: { format: "uuid", type: "string" },
             type: "array"
           },
@@ -20189,11 +20220,7 @@ var openapi_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"
@@ -20681,7 +20708,6 @@ var openapi_default = {
                       }
                     },
                     required: [
-                      "acs_credential_id",
                       "acs_system_id",
                       "display_name",
                       "access_method",
@@ -24114,6 +24140,25 @@ var openapi_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: "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).",
@@ -24131,6 +24176,37 @@ var openapi_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.",
             format: "uuid",
@@ -24145,7 +24221,9 @@ var openapi_default = {
           "display_name",
           "full_name",
           "created_at",
-          "workspace_id"
+          "workspace_id",
+          "errors",
+          "warnings"
         ],
         type: "object",
         "x-route-path": "/user_identities"
@@ -29132,6 +29210,16 @@ var openapi_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.",
                     format: "uuid",
@@ -30752,10 +30840,18 @@ var openapi_default = {
                     minLength: 1,
                     type: "string"
                   },
+                  user_identity_id: {
+                    description: "ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.",
+                    type: "string"
+                  },
                   user_identity_ids: {
-                    description: "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.",
+                    deprecated: true,
+                    description: "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.",
                     items: { type: "string" },
-                    type: "array"
+                    maxItems: 1,
+                    minItems: 1,
+                    type: "array",
+                    "x-deprecated": "Use `user_identity_id`."
                   }
                 },
                 type: "object"
@@ -30828,10 +30924,18 @@ var openapi_default = {
                     minLength: 1,
                     type: "string"
                   },
+                  user_identity_id: {
+                    description: "ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.",
+                    type: "string"
+                  },
                   user_identity_ids: {
-                    description: "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.",
+                    deprecated: true,
+                    description: "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.",
                     items: { type: "string" },
-                    type: "array"
+                    maxItems: 1,
+                    minItems: 1,
+                    type: "array",
+                    "x-deprecated": "Use `user_identity_id`."
                   }
                 },
                 type: "object"
@@ -31011,10 +31115,18 @@ var openapi_default = {
                     minLength: 1,
                     type: "string"
                   },
+                  user_identity_id: {
+                    description: "ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session).",
+                    type: "string"
+                  },
                   user_identity_ids: {
-                    description: "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session).",
+                    deprecated: true,
+                    description: "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.",
                     items: { type: "string" },
-                    type: "array"
+                    maxItems: 1,
+                    minItems: 1,
+                    type: "array",
+                    "x-deprecated": "Use `user_identity_id`."
                   }
                 },
                 type: "object"
@@ -31085,10 +31197,18 @@ var openapi_default = {
                     description: "Your user ID for the user that you want to associate with the client session.",
                     type: "string"
                   },
+                  user_identity_id: {
+                    description: "ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.",
+                    type: "string"
+                  },
                   user_identity_ids: {
+                    deprecated: true,
                     description: "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.",
                     items: { type: "string" },
-                    type: "array"
+                    maxItems: 1,
+                    minItems: 1,
+                    type: "array",
+                    "x-deprecated": "Use `user_identity_id`."
                   }
                 },
                 type: "object"
@@ -31154,10 +31274,18 @@ var openapi_default = {
                     description: "Your user ID for the user that you want to associate with the client session.",
                     type: "string"
                   },
+                  user_identity_id: {
+                    description: "ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.",
+                    type: "string"
+                  },
                   user_identity_ids: {
+                    deprecated: true,
                     description: "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.",
                     items: { type: "string" },
-                    type: "array"
+                    maxItems: 1,
+                    minItems: 1,
+                    type: "array",
+                    "x-deprecated": "Use `user_identity_id`."
                   }
                 },
                 type: "object"
@@ -42096,7 +42224,7 @@ var openapi_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.",
+        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). 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: {