@seamapi/types 1.293.1 → 1.294.1

package/dist/connect.cjs

@@ -2774,15 +2774,21 @@ var noise_threshold = zod.z.object({
   noise_threshold_decibels: zod.z.number()
 });
 var user_identity = zod.z.object({
-  user_identity_id: zod.z.string().uuid(),
-  user_identity_key: zod.z.string().min(1).nullable(),
-  email_address: zod.z.string().email().nullable(),
-  phone_number: phone_number.nullable(),
+  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."),
+  email_address: zod.z.string().email().nullable().describe("Unique email address for the user identity."),
+  phone_number: phone_number.nullable().describe(
+    "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100)."
+  ),
   display_name: zod.z.string().min(1),
   full_name: zod.z.string().min(1).nullable(),
-  created_at: zod.z.string().datetime(),
-  workspace_id: zod.z.string().uuid()
-});
+  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."
+  )
+}).describe(
+  "Represents a [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) associated with an application user account."
+);
 var webhook = zod.z.object({
   webhook_id: zod.z.string(),
   url: zod.z.string(),
@@ -7721,19 +7727,40 @@ var openapi_default = {
         type: "object"
       },
       enrollment_automation: {
+        description: "Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development).",
         properties: {
-          created_at: { format: "date-time", type: "string" },
-          credential_manager_acs_system_id: { format: "uuid", type: "string" },
-          enrollment_automation_id: { format: "uuid", type: "string" },
-          user_identity_id: { format: "uuid", type: "string" },
-          workspace_id: { format: "uuid", type: "string" }
+          created_at: {
+            description: "Date and time at which the enrollment automation was created.",
+            format: "date-time",
+            type: "string"
+          },
+          credential_manager_acs_system_id: {
+            description: "ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.",
+            format: "uuid",
+            type: "string"
+          },
+          enrollment_automation_id: {
+            description: "ID of the enrollment automation.",
+            format: "uuid",
+            type: "string"
+          },
+          user_identity_id: {
+            description: "ID of the associated [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).",
+            format: "uuid",
+            type: "string"
+          },
+          workspace_id: {
+            description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation.",
+            format: "uuid",
+            type: "string"
+          }
         },
         required: [
+          "enrollment_automation_id",
           "credential_manager_acs_system_id",
           "user_identity_id",
           "created_at",
-          "workspace_id",
-          "enrollment_automation_id"
+          "workspace_id"
         ],
         type: "object"
       },
@@ -8455,15 +8482,42 @@ var openapi_default = {
         type: "object"
       },
       user_identity: {
+        description: "Represents a [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) associated with an application user account.",
         properties: {
-          created_at: { format: "date-time", type: "string" },
+          created_at: {
+            description: "Date and time at which the user identity was created.",
+            format: "date-time",
+            type: "string"
+          },
           display_name: { minLength: 1, type: "string" },
-          email_address: { format: "email", nullable: true, type: "string" },
+          email_address: {
+            description: "Unique email address for the user identity.",
+            format: "email",
+            nullable: true,
+            type: "string"
+          },
           full_name: { minLength: 1, nullable: true, type: "string" },
-          phone_number: { nullable: true, type: "string" },
-          user_identity_id: { format: "uuid", type: "string" },
-          user_identity_key: { minLength: 1, nullable: true, type: "string" },
-          workspace_id: { format: "uuid", 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).",
+            nullable: true,
+            type: "string"
+          },
+          user_identity_id: {
+            description: "ID of the user identity.",
+            format: "uuid",
+            type: "string"
+          },
+          user_identity_key: {
+            description: "Unique key for the user identity.",
+            minLength: 1,
+            nullable: true,
+            type: "string"
+          },
+          workspace_id: {
+            description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.",
+            format: "uuid",
+            type: "string"
+          }
         },
         required: [
           "user_identity_id",
@@ -9752,7 +9806,8 @@ var openapi_default = {
         ],
         summary: "/access_codes/update_multiple",
         tags: ["/access_codes"],
-        "x-fern-ignore": true
+        "x-fern-ignore": true,
+        "x-response-key": null
       },
       post: {
         operationId: "accessCodesUpdateMultiplePost",
@@ -9797,7 +9852,8 @@ var openapi_default = {
         summary: "/access_codes/update_multiple",
         tags: ["/access_codes"],
         "x-fern-sdk-group-name": ["access_codes"],
-        "x-fern-sdk-method-name": "update_multiple"
+        "x-fern-sdk-method-name": "update_multiple",
+        "x-response-key": null
       }
     },
     "/acs/access_groups/add_user": {
@@ -19706,14 +19762,23 @@ var openapi_default = {
     },
     "/user_identities/add_acs_user": {
       post: {
+        description: "Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to 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).",
         operationId: "userIdentitiesAddAcsUserPost",
         requestBody: {
           content: {
             "application/json": {
               schema: {
                 properties: {
-                  acs_user_id: { format: "uuid", type: "string" },
-                  user_identity_id: { format: "uuid", type: "string" }
+                  acs_user_id: {
+                    description: "ID of the desired ACS user.",
+                    format: "uuid",
+                    type: "string"
+                  },
+                  user_identity_id: {
+                    description: "ID of the desired user identity.",
+                    format: "uuid",
+                    type: "string"
+                  }
                 },
                 required: ["user_identity_id", "acs_user_id"],
                 type: "object"
@@ -19746,17 +19811,27 @@ var openapi_default = {
         tags: ["/user_identities"],
         "x-fern-sdk-group-name": ["user_identities"],
         "x-fern-sdk-method-name": "add_acs_user",
-        "x-response-key": null
+        "x-response-key": null,
+        "x-title": "Add an ACS User to a User Identity"
       },
       put: {
+        description: "Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to 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).",
         operationId: "userIdentitiesAddAcsUserPut",
         requestBody: {
           content: {
             "application/json": {
               schema: {
                 properties: {
-                  acs_user_id: { format: "uuid", type: "string" },
-                  user_identity_id: { format: "uuid", type: "string" }
+                  acs_user_id: {
+                    description: "ID of the desired ACS user.",
+                    format: "uuid",
+                    type: "string"
+                  },
+                  user_identity_id: {
+                    description: "ID of the desired user identity.",
+                    format: "uuid",
+                    type: "string"
+                  }
                 },
                 required: ["user_identity_id", "acs_user_id"],
                 type: "object"
@@ -19788,11 +19863,13 @@ var openapi_default = {
         summary: "/user_identities/add_acs_user",
         tags: ["/user_identities"],
         "x-fern-ignore": true,
-        "x-response-key": null
+        "x-response-key": null,
+        "x-title": "Add an ACS User to a User Identity"
       }
     },
     "/user_identities/create": {
       post: {
+        description: "Creates a new [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).",
         operationId: "userIdentitiesCreatePost",
         requestBody: {
           content: {
@@ -19800,13 +19877,24 @@ var openapi_default = {
               schema: {
                 properties: {
                   email_address: {
+                    description: "Unique email address for the user identity.",
                     format: "email",
                     nullable: true,
                     type: "string"
                   },
-                  full_name: { minLength: 1, nullable: true, type: "string" },
-                  phone_number: { nullable: true, type: "string" },
+                  full_name: {
+                    description: "Full name of the user associated with the user identity.",
+                    minLength: 1,
+                    nullable: true,
+                    type: "string"
+                  },
+                  phone_number: {
+                    description: "Unique phone number for the user identity in E.164 format (for example, +15555550100).",
+                    nullable: true,
+                    type: "string"
+                  },
                   user_identity_key: {
+                    description: "Unique key for the user identity.",
                     minLength: 1,
                     nullable: true,
                     type: "string"
@@ -19848,18 +19936,24 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["user_identities"],
         "x-fern-sdk-method-name": "create",
         "x-fern-sdk-return-value": "user_identity",
-        "x-response-key": "user_identity"
+        "x-response-key": "user_identity",
+        "x-title": "Create a User Identity"
       }
     },
     "/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 [ACS 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.",
         operationId: "userIdentitiesDeletePost",
         requestBody: {
           content: {
             "application/json": {
               schema: {
                 properties: {
-                  user_identity_id: { format: "uuid", type: "string" }
+                  user_identity_id: {
+                    description: "ID of the desired user identity.",
+                    format: "uuid",
+                    type: "string"
+                  }
                 },
                 required: ["user_identity_id"],
                 type: "object"
@@ -19892,18 +19986,24 @@ var openapi_default = {
         tags: ["/user_identities"],
         "x-fern-sdk-group-name": ["user_identities"],
         "x-fern-sdk-method-name": "delete",
-        "x-response-key": null
+        "x-response-key": null,
+        "x-title": "Delete a User Identity"
       }
     },
     "/user_identities/enrollment_automations/delete": {
       post: {
+        description: "Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [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) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete).",
         operationId: "userIdentitiesEnrollmentAutomationsDeletePost",
         requestBody: {
           content: {
             "application/json": {
               schema: {
                 properties: {
-                  enrollment_automation_id: { format: "uuid", type: "string" }
+                  enrollment_automation_id: {
+                    description: "ID of the desired enrollment automation.",
+                    format: "uuid",
+                    type: "string"
+                  }
                 },
                 required: ["enrollment_automation_id"],
                 type: "object"
@@ -19936,18 +20036,24 @@ var openapi_default = {
         tags: ["/user_identities"],
         "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
         "x-fern-sdk-method-name": "delete",
-        "x-response-key": null
+        "x-response-key": null,
+        "x-title": "Delete an Enrollment Automation"
       }
     },
     "/user_identities/enrollment_automations/get": {
       post: {
+        description: "Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).",
         operationId: "userIdentitiesEnrollmentAutomationsGetPost",
         requestBody: {
           content: {
             "application/json": {
               schema: {
                 properties: {
-                  enrollment_automation_id: { format: "uuid", type: "string" }
+                  enrollment_automation_id: {
+                    description: "ID of the desired enrollment automation.",
+                    format: "uuid",
+                    type: "string"
+                  }
                 },
                 required: ["enrollment_automation_id"],
                 type: "object"
@@ -19987,28 +20093,43 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
         "x-fern-sdk-method-name": "get",
         "x-fern-sdk-return-value": "enrollment_automation",
-        "x-response-key": "enrollment_automation"
+        "x-response-key": "enrollment_automation",
+        "x-title": "Get an Enrollment Automation"
       }
     },
     "/user_identities/enrollment_automations/launch": {
       post: {
+        description: "Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for 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) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).",
         operationId: "userIdentitiesEnrollmentAutomationsLaunchPost",
         requestBody: {
           content: {
             "application/json": {
               schema: {
                 properties: {
-                  acs_credential_pool_id: { format: "uuid", type: "string" },
-                  create_credential_manager_user: { type: "boolean" },
+                  acs_credential_pool_id: {
+                    description: "ID of the ACS credential pool from which to obtain credentials for the user identity.",
+                    format: "uuid",
+                    type: "string"
+                  },
+                  create_credential_manager_user: {
+                    description: "Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`.",
+                    type: "boolean"
+                  },
                   credential_manager_acs_system_id: {
+                    description: "ID of the desired ACS system that serves as the credential manager.",
                     format: "uuid",
                     type: "string"
                   },
                   credential_manager_acs_user_id: {
+                    description: "ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`.",
                     format: "uuid",
                     type: "string"
                   },
-                  user_identity_id: { format: "uuid", type: "string" }
+                  user_identity_id: {
+                    description: "ID of the desired user identity.",
+                    format: "uuid",
+                    type: "string"
+                  }
                 },
                 required: [
                   "user_identity_id",
@@ -20075,18 +20196,24 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
         "x-fern-sdk-method-name": "launch",
         "x-fern-sdk-return-value": "enrollment_automation",
-        "x-response-key": "enrollment_automation"
+        "x-response-key": "enrollment_automation",
+        "x-title": "Launch an Enrollment Automation"
       }
     },
     "/user_identities/enrollment_automations/list": {
       post: {
+        description: "Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for 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).",
         operationId: "userIdentitiesEnrollmentAutomationsListPost",
         requestBody: {
           content: {
             "application/json": {
               schema: {
                 properties: {
-                  user_identity_id: { format: "uuid", type: "string" }
+                  user_identity_id: {
+                    description: "ID of the user identity for which you want to retrieve all enrollment automations.",
+                    format: "uuid",
+                    type: "string"
+                  }
                 },
                 required: ["user_identity_id"],
                 type: "object"
@@ -20129,11 +20256,13 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["user_identities", "enrollment_automations"],
         "x-fern-sdk-method-name": "list",
         "x-fern-sdk-return-value": "enrollment_automations",
-        "x-response-key": "enrollment_automations"
+        "x-response-key": "enrollment_automations",
+        "x-title": "List Enrollment Automations"
       }
     },
     "/user_identities/get": {
       post: {
+        description: "Returns 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).",
         operationId: "userIdentitiesGetPost",
         requestBody: {
           content: {
@@ -20142,7 +20271,11 @@ var openapi_default = {
                 oneOf: [
                   {
                     properties: {
-                      user_identity_id: { format: "uuid", type: "string" }
+                      user_identity_id: {
+                        description: "ID of the desired user identity.",
+                        format: "uuid",
+                        type: "string"
+                      }
                     },
                     required: ["user_identity_id"],
                     type: "object"
@@ -20188,19 +20321,29 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["user_identities"],
         "x-fern-sdk-method-name": "get",
         "x-fern-sdk-return-value": "user_identity",
-        "x-response-key": "user_identity"
+        "x-response-key": "user_identity",
+        "x-title": "Get a User Identity"
       }
     },
     "/user_identities/grant_access_to_device": {
       post: {
+        description: "Grants 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) access to a specified [device](https://docs.seam.co/latest/core-concepts/devices/).",
         operationId: "userIdentitiesGrantAccessToDevicePost",
         requestBody: {
           content: {
             "application/json": {
               schema: {
                 properties: {
-                  device_id: { format: "uuid", type: "string" },
-                  user_identity_id: { format: "uuid", type: "string" }
+                  device_id: {
+                    description: "ID of the desired managed device.",
+                    format: "uuid",
+                    type: "string"
+                  },
+                  user_identity_id: {
+                    description: "ID of the desired user identity.",
+                    format: "uuid",
+                    type: "string"
+                  }
                 },
                 required: ["user_identity_id", "device_id"],
                 type: "object"
@@ -20233,17 +20376,27 @@ var openapi_default = {
         tags: ["/user_identities"],
         "x-fern-sdk-group-name": ["user_identities"],
         "x-fern-sdk-method-name": "grant_access_to_device",
-        "x-response-key": null
+        "x-response-key": null,
+        "x-title": "Grant a User Identity Access to a Device"
       },
       put: {
+        description: "Grants 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) access to a specified [device](https://docs.seam.co/latest/core-concepts/devices/).",
         operationId: "userIdentitiesGrantAccessToDevicePut",
         requestBody: {
           content: {
             "application/json": {
               schema: {
                 properties: {
-                  device_id: { format: "uuid", type: "string" },
-                  user_identity_id: { format: "uuid", type: "string" }
+                  device_id: {
+                    description: "ID of the desired managed device.",
+                    format: "uuid",
+                    type: "string"
+                  },
+                  user_identity_id: {
+                    description: "ID of the desired user identity.",
+                    format: "uuid",
+                    type: "string"
+                  }
                 },
                 required: ["user_identity_id", "device_id"],
                 type: "object"
@@ -20275,11 +20428,13 @@ var openapi_default = {
         summary: "/user_identities/grant_access_to_device",
         tags: ["/user_identities"],
         "x-fern-ignore": true,
-        "x-response-key": null
+        "x-response-key": null,
+        "x-title": "Grant a User Identity Access to a Device"
       }
     },
     "/user_identities/list": {
       post: {
+        description: "Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
         operationId: "userIdentitiesListPost",
         requestBody: {
           content: {
@@ -20329,18 +20484,24 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["user_identities"],
         "x-fern-sdk-method-name": "list",
         "x-fern-sdk-return-value": "user_identities",
-        "x-response-key": "user_identities"
+        "x-response-key": "user_identities",
+        "x-title": "List User Identities"
       }
     },
     "/user_identities/list_accessible_devices": {
       post: {
+        description: "Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices) associated with 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).",
         operationId: "userIdentitiesListAccessibleDevicesPost",
         requestBody: {
           content: {
             "application/json": {
               schema: {
                 properties: {
-                  user_identity_id: { format: "uuid", type: "string" }
+                  user_identity_id: {
+                    description: "ID of the user identity for which you want to retrieve all accessible devices.",
+                    format: "uuid",
+                    type: "string"
+                  }
                 },
                 required: ["user_identity_id"],
                 type: "object"
@@ -20386,18 +20547,24 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["user_identities"],
         "x-fern-sdk-method-name": "list_accessible_devices",
         "x-fern-sdk-return-value": "devices",
-        "x-response-key": "devices"
+        "x-response-key": "devices",
+        "x-title": "List Accessible Devices for a User Identity"
       }
     },
     "/user_identities/list_acs_systems": {
       post: {
+        description: "Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with 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).",
         operationId: "userIdentitiesListAcsSystemsPost",
         requestBody: {
           content: {
             "application/json": {
               schema: {
                 properties: {
-                  user_identity_id: { format: "uuid", type: "string" }
+                  user_identity_id: {
+                    description: "ID of the user identity for which you want to retrieve all access control systems.",
+                    format: "uuid",
+                    type: "string"
+                  }
                 },
                 required: ["user_identity_id"],
                 type: "object"
@@ -20438,18 +20605,24 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["user_identities"],
         "x-fern-sdk-method-name": "list_acs_systems",
         "x-fern-sdk-return-value": "acs_systems",
-        "x-response-key": "acs_systems"
+        "x-response-key": "acs_systems",
+        "x-title": "List ACS Systems Associated with a User Identity"
       }
     },
     "/user_identities/list_acs_users": {
       post: {
+        description: "Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to 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).",
         operationId: "userIdentitiesListAcsUsersPost",
         requestBody: {
           content: {
             "application/json": {
               schema: {
                 properties: {
-                  user_identity_id: { format: "uuid", type: "string" }
+                  user_identity_id: {
+                    description: "ID of the user identity for which you want to retrieve all ACS users.",
+                    format: "uuid",
+                    type: "string"
+                  }
                 },
                 required: ["user_identity_id"],
                 type: "object"
@@ -20489,19 +20662,29 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["user_identities"],
         "x-fern-sdk-method-name": "list_acs_users",
         "x-fern-sdk-return-value": "acs_users",
-        "x-response-key": "acs_users"
+        "x-response-key": "acs_users",
+        "x-title": "List ACS Users Associated with a User Identity"
       }
     },
     "/user_identities/remove_acs_user": {
       post: {
+        description: "Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from 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).",
         operationId: "userIdentitiesRemoveAcsUserPost",
         requestBody: {
           content: {
             "application/json": {
               schema: {
                 properties: {
-                  acs_user_id: { format: "uuid", type: "string" },
-                  user_identity_id: { format: "uuid", type: "string" }
+                  acs_user_id: {
+                    description: "ID of the ACS user.",
+                    format: "uuid",
+                    type: "string"
+                  },
+                  user_identity_id: {
+                    description: "ID of the desired user identity.",
+                    format: "uuid",
+                    type: "string"
+                  }
                 },
                 required: ["user_identity_id", "acs_user_id"],
                 type: "object"
@@ -20534,19 +20717,29 @@ var openapi_default = {
         tags: ["/user_identities"],
         "x-fern-sdk-group-name": ["user_identities"],
         "x-fern-sdk-method-name": "remove_acs_user",
-        "x-response-key": null
+        "x-response-key": null,
+        "x-title": "Remove an ACS User from a User Identity"
       }
     },
     "/user_identities/revoke_access_to_device": {
       post: {
+        description: "Revokes access to a specified [device](https://docs.seam.co/latest/core-concepts/devices/) from 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).",
         operationId: "userIdentitiesRevokeAccessToDevicePost",
         requestBody: {
           content: {
             "application/json": {
               schema: {
                 properties: {
-                  device_id: { format: "uuid", type: "string" },
-                  user_identity_id: { format: "uuid", type: "string" }
+                  device_id: {
+                    description: "ID of the desired managed device.",
+                    format: "uuid",
+                    type: "string"
+                  },
+                  user_identity_id: {
+                    description: "ID of the desired user identity.",
+                    format: "uuid",
+                    type: "string"
+                  }
                 },
                 required: ["user_identity_id", "device_id"],
                 type: "object"
@@ -20579,7 +20772,8 @@ var openapi_default = {
         tags: ["/user_identities"],
         "x-fern-sdk-group-name": ["user_identities"],
         "x-fern-sdk-method-name": "revoke_access_to_device",
-        "x-response-key": null
+        "x-response-key": null,
+        "x-title": "Revoke Access to a Device from a User Identity"
       }
     },
     "/user_identities/update": {
@@ -20591,14 +20785,24 @@ var openapi_default = {
               schema: {
                 properties: {
                   email_address: {
+                    description: "Unique email address for the user identity.",
                     format: "email",
                     nullable: true,
                     type: "string"
                   },
                   full_name: { minLength: 1, nullable: true, type: "string" },
-                  phone_number: { nullable: true, type: "string" },
-                  user_identity_id: { format: "uuid", 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).",
+                    nullable: true,
+                    type: "string"
+                  },
+                  user_identity_id: {
+                    description: "ID of the user identity.",
+                    format: "uuid",
+                    type: "string"
+                  },
                   user_identity_key: {
+                    description: "Unique key for the user identity.",
                     minLength: 1,
                     nullable: true,
                     type: "string"
@@ -20644,14 +20848,24 @@ var openapi_default = {
               schema: {
                 properties: {
                   email_address: {
+                    description: "Unique email address for the user identity.",
                     format: "email",
                     nullable: true,
                     type: "string"
                   },
                   full_name: { minLength: 1, nullable: true, type: "string" },
-                  phone_number: { nullable: true, type: "string" },
-                  user_identity_id: { format: "uuid", 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).",
+                    nullable: true,
+                    type: "string"
+                  },
+                  user_identity_id: {
+                    description: "ID of the user identity.",
+                    format: "uuid",
+                    type: "string"
+                  },
                   user_identity_key: {
+                    description: "Unique key for the user identity.",
                     minLength: 1,
                     nullable: true,
                     type: "string"