@seamapi/types 1.403.0 → 1.404.1

package/dist/connect.cjs

@@ -522,10 +522,11 @@ 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
@@ -3342,14 +3343,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 +3375,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
@@ -11056,39 +11081,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 +11145,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",
@@ -11140,6 +11210,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"
           },
           errors: {
@@ -11427,6 +11498,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: {
@@ -27436,13 +27508,22 @@ var openapi_default = {
             "application/json": {
               schema: {
                 properties: {
+                  acs_system_id: {
+                    description: "ID of the access system for which you want to list accessible entrances. 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 list accessible entrances.",
+                    description: "ID of the access system user for whom you want to list accessible entrances. 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 list accessible entrances. You can only provide acs_user_id or user_identity_id.",
                     format: "uuid",
                     type: "string"
                   }
                 },
-                required: ["acs_user_id"],
                 type: "object"
               }
             }
@@ -27500,12 +27581,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"
               }
             }