@seamapi/types 1.404.0 → 1.404.2

package/dist/connect.cjs

@@ -522,24 +522,31 @@ zod.z.record(
   zod.z.union([zod.z.string().max(500), zod.z.boolean(), zod.z.null()])
 ).refine((val) => Object.keys(val).length <= 50, {
   message: "Custom metadata is limited to a maximum of 50 keys"
-});
-var custom_metadata = zod.z.record(
-  zod.z.string(),
-  zod.z.union([zod.z.string(), zod.z.boolean()])
+}).describe(
+  "Set of up to 50 key:value pairs, with key names up to 40 characters long. Accepts string or Boolean values. Strings are limited to 500 characters.  Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application."
+);
+var custom_metadata = zod.z.record(zod.z.string(), zod.z.union([zod.z.string(), zod.z.boolean()])).describe(
+  "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application."
 );
 
 // src/lib/seam/connect/models/connected-accounts/connected-account.ts
 var common_connected_account_error = zod.z.object({
   created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error."),
-  message: zod.z.string(),
-  is_connected_account_error: zod.z.boolean().optional(),
-  is_bridge_error: zod.z.boolean().optional()
+  message: zod.z.string().describe(
+    "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
+  ),
+  is_connected_account_error: zod.z.boolean().optional().describe(
+    "Indicates whether the error is related specifically to the connected account."
+  ),
+  is_bridge_error: zod.z.boolean().optional().describe("Indicates whether the error is related to Seam Bridge.")
 });
 var error_code_description = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
 var warning_code_description = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
 var common_connected_account_warning = zod.z.object({
   created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
-  message: zod.z.string()
+  message: zod.z.string().describe(
+    "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
+  )
 });
 var account_disconnected = common_connected_account_error.extend({
   error_code: zod.z.literal("account_disconnected").describe(error_code_description)
@@ -549,20 +556,35 @@ var invalid_credentials = common_connected_account_error.extend({
 }).describe("Credentials provided were invalid.");
 var bridge_disconnected = common_connected_account_error.extend({
   error_code: zod.z.literal("bridge_disconnected").describe(error_code_description)
-}).describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
-  See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`);
+}).describe(
+  "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected)."
+);
 var salto_ks_subscription_limit_exceeded = common_connected_account_error.extend({
   error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description),
   salto_ks_metadata: zod.z.object({
     sites: zod.z.array(
       zod.z.object({
-        site_id: zod.z.string(),
-        site_name: zod.z.string(),
-        subscribed_site_user_count: zod.z.number().int().min(0),
-        site_user_subscription_limit: zod.z.number().int().min(0)
-      })
+        site_id: zod.z.string().describe(
+          "ID of a Salto site associated with the connected account that has an error."
+        ),
+        site_name: zod.z.string().describe(
+          "Name of a Salto site associated with the connected account that has an error."
+        ),
+        subscribed_site_user_count: zod.z.number().int().min(0).describe(
+          "Count of subscribed site users for a Salto site associated with the connected account that has an error."
+        ),
+        site_user_subscription_limit: zod.z.number().int().min(0).describe(
+          "Subscription limit of site users for a Salto site associated with the connected account that has an error."
+        )
+      }).describe(
+        "Salto site associated with the connected account that has an error."
+      )
+    ).describe(
+      "Salto sites associated with the connected account that has an error."
     )
-  })
+  }).describe(
+    "Salto KS metadata associated with the connected account that has an error."
+  )
 }).describe(
   "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."
 );
@@ -581,52 +603,78 @@ zod.z.object({
 var unknown_issue_with_connected_account = common_connected_account_warning.extend({
   warning_code: zod.z.literal("unknown_issue_with_connected_account").describe(warning_code_description)
 }).describe(
-  "An unknown issue occurred while syncing the state of this connected account with the provider. This issue may affect the proper functioning of one or more resources in this account."
+  "An unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account."
 );
 var scheduled_maintenance_window = common_connected_account_warning.extend({
   warning_code: zod.z.literal("scheduled_maintenance_window").describe(warning_code_description)
-}).describe("Scheduled downtime for account planned.");
+}).describe("Scheduled downtime planned for the connected account.");
 var salto_ks_subscription_limit_almost_reached = common_connected_account_warning.extend({
   warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(warning_code_description),
   salto_ks_metadata: zod.z.object({
     sites: zod.z.array(
       zod.z.object({
-        site_id: zod.z.string(),
-        site_name: zod.z.string(),
-        site_user_subscription_limit: zod.z.number().int().min(0),
-        subscribed_site_user_count: zod.z.number().int().min(0)
-      })
+        site_id: zod.z.string().describe(
+          "ID of a Salto site associated with the connected account that has a warning."
+        ),
+        site_name: zod.z.string().describe(
+          "Name of a Salto site associated with the connected account that has a warning."
+        ),
+        site_user_subscription_limit: zod.z.number().int().min(0).describe(
+          "Subscription limit of site users for a Salto site associated with the connected account that has a warning."
+        ),
+        subscribed_site_user_count: zod.z.number().int().min(0).describe(
+          "Count of subscribed site users for a Salto site associated with the connected account that has a warning."
+        )
+      }).describe(
+        "Salto site associated with the connected account that has a warning."
+      )
+    ).describe(
+      "Salto sites associated with the connected account that has a warning."
     )
-  })
+  }).describe(
+    "Salto KS metadata associated with the connected account that has a warning."
+  )
 }).describe(
-  "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this."
+  "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site."
 );
 var connected_account_warning = zod.z.discriminatedUnion("warning_code", [
   scheduled_maintenance_window,
   unknown_issue_with_connected_account,
   salto_ks_subscription_limit_almost_reached
-]).describe("Warning associated with the `connected_account`.");
+]).describe("Warning associated with the connected account.");
 zod.z.object({
   scheduled_maintenance_window: scheduled_maintenance_window.nullable().optional(),
   unknown_issue_with_connected_account: unknown_issue_with_connected_account.nullable().optional(),
   salto_ks_subscription_limit_almost_reached: salto_ks_subscription_limit_almost_reached.nullable().optional()
 });
 var connected_account = zod.z.object({
-  connected_account_id: zod.z.string().uuid().optional(),
-  created_at: zod.z.string().datetime().optional(),
+  connected_account_id: zod.z.string().uuid().optional().describe("Unique identifier for the connected account."),
+  created_at: zod.z.string().datetime().optional().describe("Date and time at which the connected account was created."),
   user_identifier: zod.z.object({
-    username: zod.z.string().optional(),
-    api_url: zod.z.string().optional(),
-    email: zod.z.string().optional(),
-    phone: zod.z.string().optional(),
-    exclusive: zod.z.boolean().optional()
-  }).optional(),
-  account_type: zod.z.string().optional(),
-  account_type_display_name: zod.z.string(),
-  errors: zod.z.array(connected_account_error),
-  warnings: zod.z.array(connected_account_warning),
+    username: zod.z.string().optional().describe(
+      "Username of the user identifier associated with the connected account."
+    ),
+    api_url: zod.z.string().optional().describe(
+      "API URL for the user identifier associated with the connected account."
+    ),
+    email: zod.z.string().optional().describe(
+      "Email address of the user identifier associated with the connected account."
+    ),
+    phone: zod.z.string().optional().describe(
+      "Phone number of the user identifier associated with the connected account."
+    ),
+    exclusive: zod.z.boolean().optional().describe(
+      "Indicates whether the user identifier associated with the connected account is exclusive."
+    )
+  }).optional().describe("User identifier associated with the connected account."),
+  account_type: zod.z.string().optional().describe("Type of connected account."),
+  account_type_display_name: zod.z.string().describe("Display name for the connected account type."),
+  errors: zod.z.array(connected_account_error).describe("Errors associated with the connected account."),
+  warnings: zod.z.array(connected_account_warning).describe("Warnings associated with the connected account."),
   custom_metadata,
-  automatically_manage_new_devices: zod.z.boolean()
+  automatically_manage_new_devices: zod.z.boolean().describe(
+    "Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API."
+  )
 }).describe(`
   ---
   route_path: /connected_accounts
@@ -3342,14 +3390,22 @@ var connect_webview_device_selection_mode = zod.z.enum([
   "multiple"
 ]);
 var connect_webview = zod.z.object({
-  connect_webview_id: zod.z.string().uuid(),
-  workspace_id: zod.z.string().uuid(),
-  created_at: zod.z.string().datetime(),
-  connected_account_id: zod.z.string().uuid().nullable(),
-  url: zod.z.string().url(),
+  connect_webview_id: zod.z.string().uuid().describe("ID of the Connect Webview."),
+  workspace_id: zod.z.string().uuid().describe(
+    "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview."
+  ),
+  created_at: zod.z.string().datetime().describe("Date and time at which the Connect Webview was created."),
+  connected_account_id: zod.z.string().uuid().nullable().describe(
+    "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview."
+  ),
+  url: zod.z.string().url().describe(
+    "URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user."
+  ),
   device_selection_mode: connect_webview_device_selection_mode,
   // TODO: Use enum value.
-  accepted_providers: zod.z.array(zod.z.string()),
+  accepted_providers: zod.z.array(zod.z.string()).describe(
+    "List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews)."
+  ),
   accepted_devices: zod.z.array(zod.z.string()).describe(
     `
       ---
@@ -3366,16 +3422,32 @@ var connect_webview = zod.z.object({
       ---
       `
   ),
-  any_provider_allowed: zod.z.boolean(),
-  login_successful: zod.z.boolean(),
-  status: zod.z.enum(["pending", "failed", "authorized"]),
-  custom_redirect_url: zod.z.string().url().nullable(),
-  custom_redirect_failure_url: zod.z.string().url().nullable(),
+  any_provider_allowed: zod.z.boolean().describe("Indicates whether any provider is allowed."),
+  login_successful: zod.z.boolean().describe(
+    "Indicates whether the user logged in successfully using the Connect Webview."
+  ),
+  status: zod.z.enum(["pending", "failed", "authorized"]).describe(
+    "Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview."
+  ),
+  custom_redirect_url: zod.z.string().url().nullable().describe(
+    "URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs."
+  ),
+  custom_redirect_failure_url: zod.z.string().url().nullable().describe(
+    "URL to which the Connect Webview should redirect when an unexpected error occurs."
+  ),
   custom_metadata,
-  automatically_manage_new_devices: zod.z.boolean(),
-  wait_for_device_creation: zod.z.boolean(),
-  authorized_at: zod.z.string().datetime().nullable(),
-  selected_provider: zod.z.string().nullable()
+  automatically_manage_new_devices: zod.z.boolean().describe(
+    "Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API."
+  ),
+  wait_for_device_creation: zod.z.boolean().describe(
+    "Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview."
+  ),
+  authorized_at: zod.z.string().datetime().nullable().describe(
+    "Date and time at which the user authorized (through the Connect Webview) the management of their devices."
+  ),
+  selected_provider: zod.z.string().nullable().describe(
+    "Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews)."
+  )
 }).describe(`
   ---
   route_path: /connect_webviews
@@ -5583,15 +5655,24 @@ var openapi_default = {
                       enum: ["invalid_credentials"],
                       type: "string"
                     },
-                    is_bridge_error: { type: "boolean" },
-                    is_connected_account_error: { type: "boolean" },
-                    message: { type: "string" }
+                    is_bridge_error: {
+                      description: "Indicates whether the error is related to Seam Bridge.",
+                      type: "boolean"
+                    },
+                    is_connected_account_error: {
+                      description: "Indicates whether the error is related specifically to the connected account.",
+                      type: "boolean"
+                    },
+                    message: {
+                      description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    }
                   },
                   required: ["created_at", "message", "error_code"],
                   type: "object"
                 },
                 {
-                  description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n  See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
+                  description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the error.",
@@ -5603,9 +5684,18 @@ var openapi_default = {
                       enum: ["bridge_disconnected"],
                       type: "string"
                     },
-                    is_bridge_error: { type: "boolean" },
-                    is_connected_account_error: { type: "boolean" },
-                    message: { type: "string" }
+                    is_bridge_error: {
+                      description: "Indicates whether the error is related to Seam Bridge.",
+                      type: "boolean"
+                    },
+                    is_connected_account_error: {
+                      description: "Indicates whether the error is related specifically to the connected account.",
+                      type: "boolean"
+                    },
+                    message: {
+                      description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    }
                   },
                   required: ["created_at", "message", "error_code"],
                   type: "object"
@@ -11056,39 +11146,62 @@ var openapi_default = {
             "x-deprecated": "Unused. Will be removed.",
             "x-undocumented": "Unused. Will be removed."
           },
-          accepted_providers: { items: { type: "string" }, type: "array" },
+          accepted_providers: {
+            description: "List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).",
+            items: { type: "string" },
+            type: "array"
+          },
           any_device_allowed: {
             deprecated: true,
             type: "boolean",
             "x-deprecated": "Unused. Will be removed.",
             "x-undocumented": "Unused. Will be removed."
           },
-          any_provider_allowed: { type: "boolean" },
+          any_provider_allowed: {
+            description: "Indicates whether any provider is allowed.",
+            type: "boolean"
+          },
           authorized_at: {
+            description: "Date and time at which the user authorized (through the Connect Webview) the management of their devices.",
             format: "date-time",
             nullable: true,
             type: "string"
           },
-          automatically_manage_new_devices: { type: "boolean" },
-          connect_webview_id: { format: "uuid", type: "string" },
+          automatically_manage_new_devices: {
+            description: "Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.",
+            type: "boolean"
+          },
+          connect_webview_id: {
+            description: "ID of the Connect Webview.",
+            format: "uuid",
+            type: "string"
+          },
           connected_account_id: {
+            description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview.",
             format: "uuid",
             nullable: true,
             type: "string"
           },
-          created_at: { format: "date-time", type: "string" },
+          created_at: {
+            description: "Date and time at which the Connect Webview was created.",
+            format: "date-time",
+            type: "string"
+          },
           custom_metadata: {
             additionalProperties: {
               oneOf: [{ type: "string" }, { type: "boolean" }]
             },
+            description: "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.",
             type: "object"
           },
           custom_redirect_failure_url: {
+            description: "URL to which the Connect Webview should redirect when an unexpected error occurs.",
             format: "uri",
             nullable: true,
             type: "string"
           },
           custom_redirect_url: {
+            description: "URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs.",
             format: "uri",
             nullable: true,
             type: "string"
@@ -11097,12 +11210,34 @@ var openapi_default = {
             enum: ["none", "single", "multiple"],
             type: "string"
           },
-          login_successful: { type: "boolean" },
-          selected_provider: { nullable: true, type: "string" },
-          status: { enum: ["pending", "failed", "authorized"], type: "string" },
-          url: { format: "uri", type: "string" },
-          wait_for_device_creation: { type: "boolean" },
-          workspace_id: { format: "uuid", type: "string" }
+          login_successful: {
+            description: "Indicates whether the user logged in successfully using the Connect Webview.",
+            type: "boolean"
+          },
+          selected_provider: {
+            description: "Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).",
+            nullable: true,
+            type: "string"
+          },
+          status: {
+            description: "Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview.",
+            enum: ["pending", "failed", "authorized"],
+            type: "string"
+          },
+          url: {
+            description: "URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.",
+            format: "uri",
+            type: "string"
+          },
+          wait_for_device_creation: {
+            description: "Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview.",
+            type: "boolean"
+          },
+          workspace_id: {
+            description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview.",
+            format: "uuid",
+            type: "string"
+          }
         },
         required: [
           "connect_webview_id",
@@ -11131,18 +11266,37 @@ var openapi_default = {
       connected_account: {
         description: "Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.",
         properties: {
-          account_type: { type: "string" },
-          account_type_display_name: { type: "string" },
-          automatically_manage_new_devices: { type: "boolean" },
-          connected_account_id: { format: "uuid", type: "string" },
-          created_at: { format: "date-time", type: "string" },
+          account_type: {
+            description: "Type of connected account.",
+            type: "string"
+          },
+          account_type_display_name: {
+            description: "Display name for the connected account type.",
+            type: "string"
+          },
+          automatically_manage_new_devices: {
+            description: "Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.",
+            type: "boolean"
+          },
+          connected_account_id: {
+            description: "Unique identifier for the connected account.",
+            format: "uuid",
+            type: "string"
+          },
+          created_at: {
+            description: "Date and time at which the connected account was created.",
+            format: "date-time",
+            type: "string"
+          },
           custom_metadata: {
             additionalProperties: {
               oneOf: [{ type: "string" }, { type: "boolean" }]
             },
+            description: "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.",
             type: "object"
           },
           errors: {
+            description: "Errors associated with the connected account.",
             items: {
               discriminator: { propertyName: "error_code" },
               oneOf: [
@@ -11159,9 +11313,18 @@ var openapi_default = {
                       enum: ["account_disconnected"],
                       type: "string"
                     },
-                    is_bridge_error: { type: "boolean" },
-                    is_connected_account_error: { type: "boolean" },
-                    message: { type: "string" }
+                    is_bridge_error: {
+                      description: "Indicates whether the error is related to Seam Bridge.",
+                      type: "boolean"
+                    },
+                    is_connected_account_error: {
+                      description: "Indicates whether the error is related specifically to the connected account.",
+                      type: "boolean"
+                    },
+                    message: {
+                      description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    }
                   },
                   required: ["created_at", "message", "error_code"],
                   type: "object"
@@ -11179,15 +11342,24 @@ var openapi_default = {
                       enum: ["invalid_credentials"],
                       type: "string"
                     },
-                    is_bridge_error: { type: "boolean" },
-                    is_connected_account_error: { type: "boolean" },
-                    message: { type: "string" }
+                    is_bridge_error: {
+                      description: "Indicates whether the error is related to Seam Bridge.",
+                      type: "boolean"
+                    },
+                    is_connected_account_error: {
+                      description: "Indicates whether the error is related specifically to the connected account.",
+                      type: "boolean"
+                    },
+                    message: {
+                      description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    }
                   },
                   required: ["created_at", "message", "error_code"],
                   type: "object"
                 },
                 {
-                  description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n  See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
+                  description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the error.",
@@ -11199,9 +11371,18 @@ var openapi_default = {
                       enum: ["bridge_disconnected"],
                       type: "string"
                     },
-                    is_bridge_error: { type: "boolean" },
-                    is_connected_account_error: { type: "boolean" },
-                    message: { type: "string" }
+                    is_bridge_error: {
+                      description: "Indicates whether the error is related to Seam Bridge.",
+                      type: "boolean"
+                    },
+                    is_connected_account_error: {
+                      description: "Indicates whether the error is related specifically to the connected account.",
+                      type: "boolean"
+                    },
+                    message: {
+                      description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    }
                   },
                   required: ["created_at", "message", "error_code"],
                   type: "object"
@@ -11219,21 +11400,41 @@ var openapi_default = {
                       enum: ["salto_ks_subscription_limit_exceeded"],
                       type: "string"
                     },
-                    is_bridge_error: { type: "boolean" },
-                    is_connected_account_error: { type: "boolean" },
-                    message: { type: "string" },
+                    is_bridge_error: {
+                      description: "Indicates whether the error is related to Seam Bridge.",
+                      type: "boolean"
+                    },
+                    is_connected_account_error: {
+                      description: "Indicates whether the error is related specifically to the connected account.",
+                      type: "boolean"
+                    },
+                    message: {
+                      description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    },
                     salto_ks_metadata: {
+                      description: "Salto KS metadata associated with the connected account that has an error.",
                       properties: {
                         sites: {
+                          description: "Salto sites associated with the connected account that has an error.",
                           items: {
+                            description: "Salto site associated with the connected account that has an error.",
                             properties: {
-                              site_id: { type: "string" },
-                              site_name: { type: "string" },
+                              site_id: {
+                                description: "ID of a Salto site associated with the connected account that has an error.",
+                                type: "string"
+                              },
+                              site_name: {
+                                description: "Name of a Salto site associated with the connected account that has an error.",
+                                type: "string"
+                              },
                               site_user_subscription_limit: {
+                                description: "Subscription limit of site users for a Salto site associated with the connected account that has an error.",
                                 minimum: 0,
                                 type: "integer"
                               },
                               subscribed_site_user_count: {
+                                description: "Count of subscribed site users for a Salto site associated with the connected account that has an error.",
                                 minimum: 0,
                                 type: "integer"
                               }
@@ -11266,29 +11467,49 @@ var openapi_default = {
             type: "array"
           },
           user_identifier: {
+            description: "User identifier associated with the connected account.",
             properties: {
-              api_url: { type: "string" },
-              email: { type: "string" },
-              exclusive: { type: "boolean" },
-              phone: { type: "string" },
-              username: { type: "string" }
+              api_url: {
+                description: "API URL for the user identifier associated with the connected account.",
+                type: "string"
+              },
+              email: {
+                description: "Email address of the user identifier associated with the connected account.",
+                type: "string"
+              },
+              exclusive: {
+                description: "Indicates whether the user identifier associated with the connected account is exclusive.",
+                type: "boolean"
+              },
+              phone: {
+                description: "Phone number of the user identifier associated with the connected account.",
+                type: "string"
+              },
+              username: {
+                description: "Username of the user identifier associated with the connected account.",
+                type: "string"
+              }
             },
             type: "object"
           },
           warnings: {
+            description: "Warnings associated with the connected account.",
             items: {
-              description: "Warning associated with the `connected_account`.",
+              description: "Warning associated with the connected account.",
               discriminator: { propertyName: "warning_code" },
               oneOf: [
                 {
-                  description: "Scheduled downtime for account planned.",
+                  description: "Scheduled downtime planned for the connected account.",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the warning.",
                       format: "date-time",
                       type: "string"
                     },
-                    message: { 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: ["scheduled_maintenance_window"],
@@ -11299,14 +11520,17 @@ var openapi_default = {
                   type: "object"
                 },
                 {
-                  description: "An unknown issue occurred while syncing the state of this connected account with the provider. This issue may affect the proper functioning of one or more resources in this account.",
+                  description: "An unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account.",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the warning.",
                       format: "date-time",
                       type: "string"
                     },
-                    message: { 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: ["unknown_issue_with_connected_account"],
@@ -11317,26 +11541,40 @@ var openapi_default = {
                   type: "object"
                 },
                 {
-                  description: "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this.",
+                  description: "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the warning.",
                       format: "date-time",
                       type: "string"
                     },
-                    message: { type: "string" },
+                    message: {
+                      description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    },
                     salto_ks_metadata: {
+                      description: "Salto KS metadata associated with the connected account that has a warning.",
                       properties: {
                         sites: {
+                          description: "Salto sites associated with the connected account that has a warning.",
                           items: {
+                            description: "Salto site associated with the connected account that has a warning.",
                             properties: {
-                              site_id: { type: "string" },
-                              site_name: { type: "string" },
+                              site_id: {
+                                description: "ID of a Salto site associated with the connected account that has a warning.",
+                                type: "string"
+                              },
+                              site_name: {
+                                description: "Name of a Salto site associated with the connected account that has a warning.",
+                                type: "string"
+                              },
                               site_user_subscription_limit: {
+                                description: "Subscription limit of site users for a Salto site associated with the connected account that has a warning.",
                                 minimum: 0,
                                 type: "integer"
                               },
                               subscribed_site_user_count: {
+                                description: "Count of subscribed site users for a Salto site associated with the connected account that has a warning.",
                                 minimum: 0,
                                 type: "integer"
                               }
@@ -11427,6 +11665,7 @@ var openapi_default = {
             additionalProperties: {
               oneOf: [{ type: "string" }, { type: "boolean" }]
             },
+            description: "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.",
             type: "object"
           },
           device_id: {
@@ -11783,15 +12022,24 @@ var openapi_default = {
                       enum: ["invalid_credentials"],
                       type: "string"
                     },
-                    is_bridge_error: { type: "boolean" },
-                    is_connected_account_error: { type: "boolean" },
-                    message: { type: "string" }
+                    is_bridge_error: {
+                      description: "Indicates whether the error is related to Seam Bridge.",
+                      type: "boolean"
+                    },
+                    is_connected_account_error: {
+                      description: "Indicates whether the error is related specifically to the connected account.",
+                      type: "boolean"
+                    },
+                    message: {
+                      description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    }
                   },
                   required: ["created_at", "message", "error_code"],
                   type: "object"
                 },
                 {
-                  description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n  See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
+                  description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the error.",
@@ -11803,9 +12051,18 @@ var openapi_default = {
                       enum: ["bridge_disconnected"],
                       type: "string"
                     },
-                    is_bridge_error: { type: "boolean" },
-                    is_connected_account_error: { type: "boolean" },
-                    message: { type: "string" }
+                    is_bridge_error: {
+                      description: "Indicates whether the error is related to Seam Bridge.",
+                      type: "boolean"
+                    },
+                    is_connected_account_error: {
+                      description: "Indicates whether the error is related specifically to the connected account.",
+                      type: "boolean"
+                    },
+                    message: {
+                      description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    }
                   },
                   required: ["created_at", "message", "error_code"],
                   type: "object"
@@ -20076,15 +20333,24 @@ var openapi_default = {
                       enum: ["invalid_credentials"],
                       type: "string"
                     },
-                    is_bridge_error: { type: "boolean" },
-                    is_connected_account_error: { type: "boolean" },
-                    message: { type: "string" }
+                    is_bridge_error: {
+                      description: "Indicates whether the error is related to Seam Bridge.",
+                      type: "boolean"
+                    },
+                    is_connected_account_error: {
+                      description: "Indicates whether the error is related specifically to the connected account.",
+                      type: "boolean"
+                    },
+                    message: {
+                      description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    }
                   },
                   required: ["created_at", "message", "error_code"],
                   type: "object"
                 },
                 {
-                  description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n  See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
+                  description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the error.",
@@ -20096,9 +20362,18 @@ var openapi_default = {
                       enum: ["bridge_disconnected"],
                       type: "string"
                     },
-                    is_bridge_error: { type: "boolean" },
-                    is_connected_account_error: { type: "boolean" },
-                    message: { type: "string" }
+                    is_bridge_error: {
+                      description: "Indicates whether the error is related to Seam Bridge.",
+                      type: "boolean"
+                    },
+                    is_connected_account_error: {
+                      description: "Indicates whether the error is related specifically to the connected account.",
+                      type: "boolean"
+                    },
+                    message: {
+                      description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    }
                   },
                   required: ["created_at", "message", "error_code"],
                   type: "object"
@@ -21798,15 +22073,24 @@ var openapi_default = {
                       enum: ["invalid_credentials"],
                       type: "string"
                     },
-                    is_bridge_error: { type: "boolean" },
-                    is_connected_account_error: { type: "boolean" },
-                    message: { type: "string" }
+                    is_bridge_error: {
+                      description: "Indicates whether the error is related to Seam Bridge.",
+                      type: "boolean"
+                    },
+                    is_connected_account_error: {
+                      description: "Indicates whether the error is related specifically to the connected account.",
+                      type: "boolean"
+                    },
+                    message: {
+                      description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    }
                   },
                   required: ["created_at", "message", "error_code"],
                   type: "object"
                 },
                 {
-                  description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n  See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
+                  description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the error.",
@@ -21818,9 +22102,18 @@ var openapi_default = {
                       enum: ["bridge_disconnected"],
                       type: "string"
                     },
-                    is_bridge_error: { type: "boolean" },
-                    is_connected_account_error: { type: "boolean" },
-                    message: { type: "string" }
+                    is_bridge_error: {
+                      description: "Indicates whether the error is related to Seam Bridge.",
+                      type: "boolean"
+                    },
+                    is_connected_account_error: {
+                      description: "Indicates whether the error is related specifically to the connected account.",
+                      type: "boolean"
+                    },
+                    message: {
+                      description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    }
                   },
                   required: ["created_at", "message", "error_code"],
                   type: "object"
@@ -27239,13 +27532,22 @@ var openapi_default = {
             "application/json": {
               schema: {
                 properties: {
+                  acs_system_id: {
+                    description: "ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id.",
+                    format: "uuid",
+                    type: "string"
+                  },
                   acs_user_id: {
-                    description: "ID of the access system user that you want to delete.",
+                    description: "ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id",
+                    format: "uuid",
+                    type: "string"
+                  },
+                  user_identity_id: {
+                    description: "ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.",
                     format: "uuid",
                     type: "string"
                   }
                 },
-                required: ["acs_user_id"],
                 type: "object"
               }
             }
@@ -27289,13 +27591,22 @@ var openapi_default = {
             "application/json": {
               schema: {
                 properties: {
+                  acs_system_id: {
+                    description: "ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id.",
+                    format: "uuid",
+                    type: "string"
+                  },
                   acs_user_id: {
-                    description: "ID of the access system user that you want to get.",
+                    description: "ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id.",
+                    format: "uuid",
+                    type: "string"
+                  },
+                  user_identity_id: {
+                    description: "ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.",
                     format: "uuid",
                     type: "string"
                   }
                 },
-                required: ["acs_user_id"],
                 type: "object"
               }
             }
@@ -27509,12 +27820,17 @@ var openapi_default = {
                     type: "string"
                   },
                   acs_user_id: {
-                    description: "ID of the access system user that you want to remove from an access group.",
+                    description: "ID of the access system user that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.",
+                    format: "uuid",
+                    type: "string"
+                  },
+                  user_identity_id: {
+                    description: "ID of the user identity that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.",
                     format: "uuid",
                     type: "string"
                   }
                 },
-                required: ["acs_user_id", "acs_access_group_id"],
+                required: ["acs_access_group_id"],
                 type: "object"
               }
             }
@@ -27558,13 +27874,22 @@ var openapi_default = {
             "application/json": {
               schema: {
                 properties: {
+                  acs_system_id: {
+                    description: "ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id.",
+                    format: "uuid",
+                    type: "string"
+                  },
                   acs_user_id: {
-                    description: "ID of the access system user for whom you want to revoke access.",
+                    description: "ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.",
+                    format: "uuid",
+                    type: "string"
+                  },
+                  user_identity_id: {
+                    description: "ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.",
                     format: "uuid",
                     type: "string"
                   }
                 },
-                required: ["acs_user_id"],
                 type: "object"
               }
             }
@@ -27608,13 +27933,22 @@ var openapi_default = {
             "application/json": {
               schema: {
                 properties: {
+                  acs_system_id: {
+                    description: "ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.",
+                    format: "uuid",
+                    type: "string"
+                  },
                   acs_user_id: {
-                    description: "ID of the access system user that you want to suspend.",
+                    description: "ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.",
+                    format: "uuid",
+                    type: "string"
+                  },
+                  user_identity_id: {
+                    description: "ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.",
                     format: "uuid",
                     type: "string"
                   }
                 },
-                required: ["acs_user_id"],
                 type: "object"
               }
             }
@@ -27793,13 +28127,22 @@ var openapi_default = {
             "application/json": {
               schema: {
                 properties: {
+                  acs_system_id: {
+                    description: "ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id.",
+                    format: "uuid",
+                    type: "string"
+                  },
                   acs_user_id: {
-                    description: "ID of the access system user that you want to unsuspend.",
+                    description: "ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.",
+                    format: "uuid",
+                    type: "string"
+                  },
+                  user_identity_id: {
+                    description: "ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.",
                     format: "uuid",
                     type: "string"
                   }
                 },
-                required: ["acs_user_id"],
                 type: "object"
               }
             }
@@ -27861,8 +28204,13 @@ var openapi_default = {
                     required: ["starts_at", "ends_at"],
                     type: "object"
                   },
+                  acs_system_id: {
+                    description: "ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.",
+                    format: "uuid",
+                    type: "string"
+                  },
                   acs_user_id: {
-                    description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
+                    description: "ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.",
                     format: "uuid",
                     type: "string"
                   },
@@ -27886,9 +28234,13 @@ var openapi_default = {
                   phone_number: {
                     description: "Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
                     type: "string"
+                  },
+                  user_identity_id: {
+                    description: "ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.",
+                    format: "uuid",
+                    type: "string"
                   }
                 },
-                required: ["acs_user_id"],
                 type: "object"
               }
             }
@@ -27947,8 +28299,13 @@ var openapi_default = {
                     required: ["starts_at", "ends_at"],
                     type: "object"
                   },
+                  acs_system_id: {
+                    description: "ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.",
+                    format: "uuid",
+                    type: "string"
+                  },
                   acs_user_id: {
-                    description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
+                    description: "ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.",
                     format: "uuid",
                     type: "string"
                   },
@@ -27972,9 +28329,13 @@ var openapi_default = {
                   phone_number: {
                     description: "Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
                     type: "string"
+                  },
+                  user_identity_id: {
+                    description: "ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.",
+                    format: "uuid",
+                    type: "string"
                   }
                 },
-                required: ["acs_user_id"],
                 type: "object"
               }
             }