@seamapi/types 1.804.0 → 1.806.0

package/dist/connect.d.cts

@@ -69291,6 +69291,38 @@ declare const _default: {
                 'x-route-path': string;
                 'x-undocumented': string;
             };
+            customer_portal: {
+                description: string;
+                properties: {
+                    created_at: {
+                        description: string;
+                        format: string;
+                        type: string;
+                    };
+                    customer_key: {
+                        description: string;
+                        type: string;
+                    };
+                    expires_at: {
+                        description: string;
+                        format: string;
+                        type: string;
+                    };
+                    url: {
+                        description: string;
+                        format: string;
+                        type: string;
+                    };
+                    workspace_id: {
+                        description: string;
+                        format: string;
+                        type: string;
+                    };
+                };
+                required: string[];
+                type: string;
+                'x-route-path': string;
+            };
             customization_profile: {
                 description: string;
                 properties: {
@@ -104389,36 +104421,7 @@ declare const _default: {
                                 schema: {
                                     properties: {
                                         customer_portal: {
-                                            description: string;
-                                            properties: {
-                                                created_at: {
-                                                    description: string;
-                                                    format: string;
-                                                    type: string;
-                                                };
-                                                customer_key: {
-                                                    description: string;
-                                                    type: string;
-                                                };
-                                                expires_at: {
-                                                    description: string;
-                                                    format: string;
-                                                    type: string;
-                                                };
-                                                url: {
-                                                    description: string;
-                                                    format: string;
-                                                    type: string;
-                                                };
-                                                workspace_id: {
-                                                    description: string;
-                                                    format: string;
-                                                    type: string;
-                                                };
-                                            };
-                                            required: string[];
-                                            type: string;
-                                            'x-route-path': string;
+                                            $ref: string;
                                         };
                                         magic_link: {
                                             $ref: string;
@@ -155713,7 +155716,7 @@ type Routes = {
           
           Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
           
-          To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). */
+          To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). */
             acs_access_group: {
                 /** ID of the access group. */
                 acs_access_group_id: string;
@@ -157061,7 +157064,7 @@ type Routes = {
             acs_system_id?: string | undefined;
             /** Access method for the new credential. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
             access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
-            /** Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview). */
+            /** Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides). */
             code?: string | undefined;
             /** Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
             is_multi_phone_sync_credential?: boolean;
@@ -159869,7 +159872,7 @@ type Routes = {
           
            See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).
           
-          To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). */
+          To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). */
             acs_encoder: {
                 /** ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. */
                 acs_encoder_id: string;
@@ -163694,7 +163697,7 @@ type Routes = {
           
           An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.
           
-          For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). */
+          For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). */
             acs_user: {
                 /** ID of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
                 acs_user_id: string;
@@ -163969,7 +163972,7 @@ type Routes = {
           
           An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.
           
-          For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). */
+          For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems). */
             acs_user: {
                 /** ID of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
                 acs_user_id: string;

package/dist/index.cjs

@@ -3216,7 +3216,7 @@ var acs_access_group = common_acs_access_group.extend({
 
     Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
 
-    To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).
+    To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).
   `);
 var unmanaged_acs_access_group = common_acs_access_group.extend({
   is_managed: zod.z.literal(false)
@@ -3633,7 +3633,7 @@ var acs_encoder = zod.z.object({
 
    See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).
 
-  To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).
+  To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).
 `);
 var acs_entrance_capability_flags = zod.z.object({
   can_unlock_with_mobile_key: zod.z.boolean().optional().describe(
@@ -4255,7 +4255,7 @@ var acs_user = common_acs_user.merge(
 
   An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.
 
-  For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).
+  For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).
 `);
 var unmanaged_acs_user = common_acs_user.merge(
   zod.z.object({
@@ -9533,7 +9533,7 @@ var openapi_default = {
         "x-route-path": "/access_methods"
       },
       acs_access_group: {
-        description: "Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\n\nSome access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.\n\nTo learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).",
+        description: "Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\n\nSome access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.\n\nTo learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).",
         properties: {
           access_group_type: {
             deprecated: true,
@@ -10461,7 +10461,7 @@ var openapi_default = {
         "x-undocumented": "Deprecated. Will be removed."
       },
       acs_encoder: {
-        description: "Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSome access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:\n\n1. Credential creation\n   Configure the access parameters for the credential.\n2. Card encoding\n   Write the credential data onto the card using a compatible card encoder.\n\nSeparately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.\n\n See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).\n\nTo verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).",
+        description: "Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSome access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:\n\n1. Credential creation\n   Configure the access parameters for the credential.\n2. Card encoding\n   Write the credential data onto the card using a compatible card encoder.\n\nSeparately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.\n\n See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).\n\nTo verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).",
         properties: {
           acs_encoder_id: {
             description: "ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners.",
@@ -11218,7 +11218,7 @@ var openapi_default = {
         "x-route-path": "/acs/systems"
       },
       acs_user: {
-        description: "Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.\n\nFor details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).",
+        description: "Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.\n\nFor details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems).",
         properties: {
           access_schedule: {
             description: "`starts_at` and `ends_at` timestamps for the [access system user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.",
@@ -16868,6 +16868,44 @@ var openapi_default = {
         "x-route-path": "/customers",
         "x-undocumented": "Internal resource."
       },
+      customer_portal: {
+        description: "Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product\u2014either by sharing a link with users or embedding a view in an iframe.\n\nWith Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.\n\nSeam hosts these flows, handling everything from account connection and device mapping to full-featured device control.",
+        properties: {
+          created_at: {
+            description: "Date and time at which the customer portal link was created.",
+            format: "date-time",
+            type: "string"
+          },
+          customer_key: {
+            description: "Customer key for the customer portal.",
+            type: "string"
+          },
+          expires_at: {
+            description: "Date and time at which the customer portal link expires.",
+            format: "date-time",
+            type: "string"
+          },
+          url: {
+            description: "URL for the customer portal.",
+            format: "uri",
+            type: "string"
+          },
+          workspace_id: {
+            description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal.",
+            format: "uuid",
+            type: "string"
+          }
+        },
+        required: [
+          "url",
+          "customer_key",
+          "expires_at",
+          "workspace_id",
+          "created_at"
+        ],
+        type: "object",
+        "x-route-path": "/customers"
+      },
       customization_profile: {
         description: "A customization profile.",
         properties: {
@@ -45371,7 +45409,7 @@ var openapi_default = {
                     type: "object"
                   },
                   code: {
-                    description: "Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview).",
+                    description: "Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides).",
                     pattern: "^\\d+$",
                     type: "string"
                   },
@@ -53638,42 +53676,7 @@ var openapi_default = {
                 schema: {
                   properties: {
                     customer_portal: {
-                      description: "Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product\u2014either by sharing a link with users or embedding a view in an iframe.\n\nWith Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.\n\nSeam hosts these flows, handling everything from account connection and device mapping to full-featured device control.",
-                      properties: {
-                        created_at: {
-                          description: "Date and time at which the customer portal link was created.",
-                          format: "date-time",
-                          type: "string"
-                        },
-                        customer_key: {
-                          description: "Customer key for the customer portal.",
-                          type: "string"
-                        },
-                        expires_at: {
-                          description: "Date and time at which the customer portal link expires.",
-                          format: "date-time",
-                          type: "string"
-                        },
-                        url: {
-                          description: "URL for the customer portal.",
-                          format: "uri",
-                          type: "string"
-                        },
-                        workspace_id: {
-                          description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal.",
-                          format: "uuid",
-                          type: "string"
-                        }
-                      },
-                      required: [
-                        "url",
-                        "customer_key",
-                        "expires_at",
-                        "workspace_id",
-                        "created_at"
-                      ],
-                      type: "object",
-                      "x-route-path": "/customers"
+                      $ref: "#/components/schemas/customer_portal"
                     },
                     magic_link: { $ref: "#/components/schemas/magic_link" },
                     ok: { type: "boolean" }