@seamapi/types 1.966.0 → 1.968.0

package/dist/connect.d.cts

@@ -6646,6 +6646,13 @@ declare const acs_user: z.ZodObject<{
         user_id?: string | undefined;
         audit_openings?: boolean | undefined;
     }>>;
+    salto_ks_metadata: z.ZodOptional<z.ZodObject<{
+        is_subscribed: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
+    }, "strip", z.ZodTypeAny, {
+        is_subscribed?: boolean | undefined;
+    }, {
+        is_subscribed?: boolean | undefined;
+    }>>;
 } & {
     full_name: z.ZodOptional<z.ZodString>;
     email: z.ZodOptional<z.ZodString>;
@@ -6704,6 +6711,9 @@ declare const acs_user: z.ZodObject<{
     acs_user_id: string;
     acs_system_id: string;
     last_successful_sync_at: string | null;
+    salto_ks_metadata?: {
+        is_subscribed?: boolean | undefined;
+    } | undefined;
     email?: string | undefined;
     pending_mutations?: ({
         message: string;
@@ -6851,6 +6861,9 @@ declare const acs_user: z.ZodObject<{
     acs_user_id: string;
     acs_system_id: string;
     last_successful_sync_at: string | null;
+    salto_ks_metadata?: {
+        is_subscribed?: boolean | undefined;
+    } | undefined;
     email?: string | undefined;
     pending_mutations?: ({
         message: string;
@@ -7403,6 +7416,13 @@ declare const unmanaged_acs_user: z.ZodObject<{
         user_id?: string | undefined;
         audit_openings?: boolean | undefined;
     }>>;
+    salto_ks_metadata: z.ZodOptional<z.ZodObject<{
+        is_subscribed: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
+    }, "strip", z.ZodTypeAny, {
+        is_subscribed?: boolean | undefined;
+    }, {
+        is_subscribed?: boolean | undefined;
+    }>>;
 } & {
     full_name: z.ZodOptional<z.ZodString>;
     email: z.ZodOptional<z.ZodString>;
@@ -7461,6 +7481,9 @@ declare const unmanaged_acs_user: z.ZodObject<{
     acs_user_id: string;
     acs_system_id: string;
     last_successful_sync_at: string | null;
+    salto_ks_metadata?: {
+        is_subscribed?: boolean | undefined;
+    } | undefined;
     email?: string | undefined;
     pending_mutations?: ({
         message: string;
@@ -7608,6 +7631,9 @@ declare const unmanaged_acs_user: z.ZodObject<{
     acs_user_id: string;
     acs_system_id: string;
     last_successful_sync_at: string | null;
+    salto_ks_metadata?: {
+        is_subscribed?: boolean | undefined;
+    } | undefined;
     email?: string | undefined;
     pending_mutations?: ({
         message: string;
@@ -53610,6 +53636,11 @@ type Routes = {
                     /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
                     audit_openings?: (boolean | undefined) | undefined;
                 } | undefined;
+                /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
+                salto_ks_metadata?: {
+                    /** Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked. */
+                    is_subscribed?: (boolean | undefined) | undefined;
+                } | undefined;
                 /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -64204,6 +64235,11 @@ type Routes = {
                     /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
                     audit_openings?: (boolean | undefined) | undefined;
                 } | undefined;
+                /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
+                salto_ks_metadata?: {
+                    /** Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked. */
+                    is_subscribed?: (boolean | undefined) | undefined;
+                } | undefined;
                 /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -64498,6 +64534,11 @@ type Routes = {
                     /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
                     audit_openings?: (boolean | undefined) | undefined;
                 } | undefined;
+                /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
+                salto_ks_metadata?: {
+                    /** Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked. */
+                    is_subscribed?: (boolean | undefined) | undefined;
+                } | undefined;
                 /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -64780,6 +64821,11 @@ type Routes = {
                     /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
                     audit_openings?: (boolean | undefined) | undefined;
                 } | undefined;
+                /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
+                salto_ks_metadata?: {
+                    /** Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked. */
+                    is_subscribed?: (boolean | undefined) | undefined;
+                } | undefined;
                 /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -65316,6 +65362,11 @@ type Routes = {
                     /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
                     audit_openings?: (boolean | undefined) | undefined;
                 } | undefined;
+                /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
+                salto_ks_metadata?: {
+                    /** Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked. */
+                    is_subscribed?: (boolean | undefined) | undefined;
+                } | undefined;
                 /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -65593,6 +65644,11 @@ type Routes = {
                     /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
                     audit_openings?: (boolean | undefined) | undefined;
                 } | undefined;
+                /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
+                salto_ks_metadata?: {
+                    /** Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked. */
+                    is_subscribed?: (boolean | undefined) | undefined;
+                } | undefined;
                 /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -113669,6 +113725,32 @@ type Routes = {
         };
         maxDuration: undefined;
     };
+    '/seam/mcp/v1/create_ro_token': {
+        route: '/seam/mcp/v1/create_ro_token';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            /** ID of the workspace the token will be bound to. */
+            workspace_id: string;
+            /** Identity of the automation minting the token (e.g. an agent session ID), recorded for auditing. */
+            created_by?: string | undefined;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            support_read_only_token: {
+                /** Support read-only token to use as a Bearer token. */
+                token: string;
+                /** ID of the workspace the token is bound to. */
+                workspace_id: string;
+                /** Date and time at which the token was created. */
+                created_at: string;
+                /** Date and time at which the token expires. Tokens live for one hour. */
+                expires_at: string;
+            };
+        };
+        maxDuration: undefined;
+    };
     '/seam/mobile_sdk/v1/acs/credentials/list': {
         route: '/seam/mobile_sdk/v1/acs/credentials/list';
         method: 'GET' | 'POST';
@@ -141272,6 +141354,11 @@ type Routes = {
                     /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
                     audit_openings?: (boolean | undefined) | undefined;
                 } | undefined;
+                /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
+                salto_ks_metadata?: {
+                    /** Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked. */
+                    is_subscribed?: (boolean | undefined) | undefined;
+                } | undefined;
                 /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -143945,6 +144032,11 @@ type Routes = {
                         /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
                         audit_openings?: (boolean | undefined) | undefined;
                     } | undefined;
+                    /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
+                    salto_ks_metadata?: {
+                        /** Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked. */
+                        is_subscribed?: (boolean | undefined) | undefined;
+                    } | undefined;
                     /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
                     full_name?: string | undefined;
                     /**
@@ -146102,6 +146194,11 @@ type Routes = {
                         /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
                         audit_openings?: (boolean | undefined) | undefined;
                     } | undefined;
+                    /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
+                    salto_ks_metadata?: {
+                        /** Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked. */
+                        is_subscribed?: (boolean | undefined) | undefined;
+                    } | undefined;
                     /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
                     full_name?: string | undefined;
                     /**

package/dist/index.cjs

@@ -3619,6 +3619,13 @@ var acs_entrance_salto_ks_metadata = zod.z.object({
   intrusion_alarm: zod.z.boolean().optional().describe("Indicates whether an intrusion alarm is active on the door."),
   privacy_mode: zod.z.boolean().optional().describe("Indicates whether privacy mode is enabled for the lock.")
 }).partial().describe("Salto KS-specific metadata associated with the entrance.");
+var acs_user_salto_ks_metadata = zod.z.object({
+  is_subscribed: zod.z.boolean().optional().describe(
+    "Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked."
+  )
+}).partial().describe(
+  "Salto KS-specific metadata associated with the access system user."
+);
 var acs_entrance_salto_space_metadata = zod.z.object({
   door_id: zod.z.string().optional().describe("Door ID in the Salto Space access system."),
   door_name: zod.z.string().optional().describe("Name of the door in the Salto Space access system."),
@@ -4741,6 +4748,9 @@ var common_acs_user = zod.z.object({
     `),
   salto_space_metadata: acs_user_salto_space_metadata.optional().describe(
     "Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management)."
+  ),
+  salto_ks_metadata: acs_user_salto_ks_metadata.optional().describe(
+    "Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management)."
   )
 }).merge(user_fields);
 var acs_user = common_acs_user.merge(
@@ -12515,6 +12525,16 @@ var openapi = {
             description: "Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
             type: "string"
           },
+          salto_ks_metadata: {
+            description: "Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).",
+            properties: {
+              is_subscribed: {
+                description: "Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked.",
+                type: "boolean"
+              }
+            },
+            type: "object"
+          },
           salto_space_metadata: {
             description: "Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).",
             properties: {
@@ -36535,6 +36555,16 @@ var openapi = {
             description: "Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
             type: "string"
           },
+          salto_ks_metadata: {
+            description: "Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).",
+            properties: {
+              is_subscribed: {
+                description: "Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked.",
+                type: "boolean"
+              }
+            },
+            type: "object"
+          },
           salto_space_metadata: {
             description: "Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).",
             properties: {
@@ -38490,6 +38520,11 @@ var openapi = {
         scheme: "bearer",
         type: "http"
       },
+      internal_service_agent: {
+        bearerFormat: "Internal Service Agent Key",
+        scheme: "bearer",
+        type: "http"
+      },
       pat_with_workspace: {
         bearerFormat: "API Token",
         scheme: "bearer",
@@ -38510,7 +38545,12 @@ var openapi = {
         name: "seam-client-session-token",
         type: "apiKey"
       },
-      seam_workspace: { in: "header", name: "seam-workspace", type: "apiKey" }
+      seam_workspace: { in: "header", name: "seam-workspace", type: "apiKey" },
+      support_read_only_token: {
+        bearerFormat: "Support Read-Only Token",
+        scheme: "bearer",
+        type: "http"
+      }
     }
   },
   info: { title: "Seam Connect", version: "1.0.0" },
@@ -82072,6 +82112,88 @@ var openapi = {
         "x-undocumented": "Seam Instant Key only."
       }
     },
+    "/seam/mcp/v1/create_ro_token": {
+      post: {
+        description: "Mints a short-lived, read-only token bound to a single workspace. Used by the Seam support agent to inspect a customer workspace via read-only public API endpoints.",
+        operationId: "seamMcpV1CreateRoTokenPost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  created_by: {
+                    description: "Identity of the automation minting the token (e.g. an agent session ID), recorded for auditing.",
+                    type: "string"
+                  },
+                  workspace_id: {
+                    description: "ID of the workspace the token will be bound to.",
+                    format: "uuid",
+                    type: "string"
+                  }
+                },
+                required: ["workspace_id"],
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    ok: { type: "boolean" },
+                    support_read_only_token: {
+                      properties: {
+                        created_at: {
+                          description: "Date and time at which the token was created.",
+                          type: "string"
+                        },
+                        expires_at: {
+                          description: "Date and time at which the token expires. Tokens live for one hour.",
+                          type: "string"
+                        },
+                        token: {
+                          description: "Support read-only token to use as a Bearer token.",
+                          type: "string"
+                        },
+                        workspace_id: {
+                          description: "ID of the workspace the token is bound to.",
+                          format: "uuid",
+                          type: "string"
+                        }
+                      },
+                      required: [
+                        "token",
+                        "workspace_id",
+                        "created_at",
+                        "expires_at"
+                      ],
+                      type: "object"
+                    }
+                  },
+                  required: ["support_read_only_token", "ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [{ internal_service_agent: [] }],
+        summary: "/seam/mcp/v1/create_ro_token",
+        tags: [],
+        "x-fern-sdk-group-name": ["seam", "mcp", "v1"],
+        "x-fern-sdk-method-name": "create_ro_token",
+        "x-fern-sdk-return-value": "support_read_only_token",
+        "x-response-key": "support_read_only_token",
+        "x-title": "Create Support Read-Only Token",
+        "x-undocumented": "Seam support agent only."
+      }
+    },
     "/seam/mobile_sdk/v1/acs/credentials/list": {
       get: {
         description: "Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).",