@seamapi/types 1.693.0 → 1.695.0

package/lib/seam/connect/route-types.d.ts

@@ -32661,6 +32661,8 @@ export type Routes = {
                 event_type: 'lock.locked';
                 /** ID of the access code that was used to lock the device. */
                 access_code_id?: string | undefined;
+                /** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
+                access_code_is_managed?: boolean | undefined;
                 /** ID of the action attempt associated with the lock action. */
                 action_attempt_id?: string | undefined;
                 /** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
@@ -32689,6 +32691,8 @@ export type Routes = {
                 event_type: 'lock.unlocked';
                 /** ID of the access code that was used to unlock the affected device. */
                 access_code_id?: string | undefined;
+                /** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
+                access_code_is_managed?: boolean | undefined;
                 /** ID of the action attempt associated with the unlock action. */
                 action_attempt_id?: string | undefined;
                 /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
@@ -34655,6 +34659,8 @@ export type Routes = {
                 event_type: 'lock.locked';
                 /** ID of the access code that was used to lock the device. */
                 access_code_id?: string | undefined;
+                /** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
+                access_code_is_managed?: boolean | undefined;
                 /** ID of the action attempt associated with the lock action. */
                 action_attempt_id?: string | undefined;
                 /** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
@@ -34683,6 +34689,8 @@ export type Routes = {
                 event_type: 'lock.unlocked';
                 /** ID of the access code that was used to unlock the affected device. */
                 access_code_id?: string | undefined;
+                /** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
+                access_code_is_managed?: boolean | undefined;
                 /** ID of the action attempt associated with the unlock action. */
                 action_attempt_id?: string | undefined;
                 /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
@@ -52884,6 +52892,37 @@ export type Routes = {
         };
         maxDuration: undefined;
     };
+    '/seam/customer/v1/customers/open_portal': {
+        route: '/seam/customer/v1/customers/open_portal';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** The customer key to open a portal for. */
+            customer_key: string;
+        };
+        formData: {};
+        jsonResponse: {
+            /** 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—either by sharing a link with users or embedding a view in an iframe.
+          
+          With 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.
+          
+          Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control. */
+            magic_link: {
+                /** URL for the magic link. */
+                url: string;
+                /** Customer key for the magic link. */
+                customer_key: string;
+                /** Date and time at which the magic link expires. */
+                expires_at: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the magic link. */
+                workspace_id: string;
+                /** Date and time at which the magic link was created. */
+                created_at: string;
+            };
+        };
+        maxDuration: undefined;
+    };
     '/seam/customer/v1/events/list': {
         route: '/seam/customer/v1/events/list';
         method: 'GET' | 'POST';
@@ -54508,6 +54547,8 @@ export type Routes = {
                 event_type: 'lock.locked';
                 /** ID of the access code that was used to lock the device. */
                 access_code_id?: string | undefined;
+                /** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
+                access_code_is_managed?: boolean | undefined;
                 /** ID of the action attempt associated with the lock action. */
                 action_attempt_id?: string | undefined;
                 /** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
@@ -54536,6 +54577,8 @@ export type Routes = {
                 event_type: 'lock.unlocked';
                 /** ID of the access code that was used to unlock the affected device. */
                 access_code_id?: string | undefined;
+                /** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
+                access_code_is_managed?: boolean | undefined;
                 /** ID of the action attempt associated with the unlock action. */
                 action_attempt_id?: string | undefined;
                 /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
@@ -83231,6 +83274,8 @@ export type Routes = {
                     event_type: 'lock.locked';
                     /** ID of the access code that was used to lock the device. */
                     access_code_id?: string | undefined;
+                    /** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
+                    access_code_is_managed?: boolean | undefined;
                     /** ID of the action attempt associated with the lock action. */
                     action_attempt_id?: string | undefined;
                     /** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
@@ -83259,6 +83304,8 @@ export type Routes = {
                     event_type: 'lock.unlocked';
                     /** ID of the access code that was used to unlock the affected device. */
                     access_code_id?: string | undefined;
+                    /** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
+                    access_code_is_managed?: boolean | undefined;
                     /** ID of the action attempt associated with the unlock action. */
                     action_attempt_id?: string | undefined;
                     /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.693.0",
+  "version": "1.695.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/events/devices.ts

@@ -377,6 +377,12 @@ export const lock_locked_event = device_event.extend({
     .uuid()
     .optional()
     .describe('ID of the access code that was used to lock the device.'),
+  access_code_is_managed: z
+    .boolean()
+    .optional()
+    .describe(
+      'Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set.',
+    ),
   action_attempt_id: z
     .string()
     .uuid()
@@ -403,6 +409,12 @@ export const lock_unlocked_event = device_event.extend({
     .describe(
       'ID of the access code that was used to unlock the affected device.',
     ),
+  access_code_is_managed: z
+    .boolean()
+    .optional()
+    .describe(
+      'Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set.',
+    ),
   action_attempt_id: z
     .string()
     .uuid()

package/src/lib/seam/connect/openapi.ts

@@ -18809,6 +18809,11 @@ export default {
                 format: 'uuid',
                 type: 'string',
               },
+              access_code_is_managed: {
+                description:
+                  'Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set.',
+                type: 'boolean',
+              },
               action_attempt_id: {
                 description:
                   'ID of the action attempt associated with the lock action.',
@@ -18894,6 +18899,11 @@ export default {
                 format: 'uuid',
                 type: 'string',
               },
+              access_code_is_managed: {
+                description:
+                  'Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set.',
+                type: 'boolean',
+              },
               acs_entrance_id: {
                 description:
                   '\n      undocumented: Unreleased.\n      ---\n      ID of the ACS entrance associated with the unlock event.\n    ',
@@ -54927,6 +54937,61 @@ export default {
         'x-undocumented': 'Internal endpoint for Console.',
       },
     },
+    '/seam/customer/v1/customers/open_portal': {
+      post: {
+        description:
+          'Opens an existing customer portal or creates a new one if the previous portal has expired.\nReturns an error if no portal was ever created for this customer.',
+        operationId: 'seamCustomerV1CustomersOpenPortalPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  customer_key: {
+                    description: 'The customer key to open a portal for.',
+                    type: 'string',
+                  },
+                },
+                required: ['customer_key'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    magic_link: { $ref: '#/components/schemas/magic_link' },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['magic_link', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/seam/customer/v1/customers/open_portal',
+        tags: [],
+        'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'customers'],
+        'x-fern-sdk-method-name': 'open_portal',
+        'x-fern-sdk-return-value': 'magic_link',
+        'x-response-key': 'magic_link',
+        'x-title': 'Open Customer Portal',
+        'x-undocumented': 'Internal endpoint for Console.',
+      },
+    },
     '/seam/customer/v1/events/list': {
       get: {
         description:

package/src/lib/seam/connect/route-types.ts

@@ -38895,6 +38895,8 @@ export type Routes = {
                 event_type: 'lock.locked'
                 /** ID of the access code that was used to lock the device. */
                 access_code_id?: string | undefined
+                /** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
+                access_code_is_managed?: boolean | undefined
                 /** ID of the action attempt associated with the lock action. */
                 action_attempt_id?: string | undefined
                 /** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
@@ -38933,6 +38935,8 @@ export type Routes = {
                 event_type: 'lock.unlocked'
                 /** ID of the access code that was used to unlock the affected device. */
                 access_code_id?: string | undefined
+                /** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
+                access_code_is_managed?: boolean | undefined
                 /** ID of the action attempt associated with the unlock action. */
                 action_attempt_id?: string | undefined
                 /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
@@ -41423,6 +41427,8 @@ export type Routes = {
             event_type: 'lock.locked'
             /** ID of the access code that was used to lock the device. */
             access_code_id?: string | undefined
+            /** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
+            access_code_is_managed?: boolean | undefined
             /** ID of the action attempt associated with the lock action. */
             action_attempt_id?: string | undefined
             /** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
@@ -41456,6 +41462,8 @@ export type Routes = {
             event_type: 'lock.unlocked'
             /** ID of the access code that was used to unlock the affected device. */
             access_code_id?: string | undefined
+            /** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
+            access_code_is_managed?: boolean | undefined
             /** ID of the action attempt associated with the unlock action. */
             action_attempt_id?: string | undefined
             /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
@@ -63230,6 +63238,37 @@ export type Routes = {
     }
     maxDuration: undefined
   }
+  '/seam/customer/v1/customers/open_portal': {
+    route: '/seam/customer/v1/customers/open_portal'
+    method: 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      /** The customer key to open a portal for. */
+      customer_key: string
+    }
+    formData: {}
+    jsonResponse: {
+      /** 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—either by sharing a link with users or embedding a view in an iframe.
+    
+    With 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.
+    
+    Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control. */
+      magic_link: {
+        /** URL for the magic link. */
+        url: string
+        /** Customer key for the magic link. */
+        customer_key: string
+        /** Date and time at which the magic link expires. */
+        expires_at: string
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the magic link. */
+        workspace_id: string
+        /** Date and time at which the magic link was created. */
+        created_at: string
+      }
+    }
+    maxDuration: undefined
+  }
   '/seam/customer/v1/events/list': {
     route: '/seam/customer/v1/events/list'
     method: 'GET' | 'POST'
@@ -65319,6 +65358,8 @@ export type Routes = {
             event_type: 'lock.locked'
             /** ID of the access code that was used to lock the device. */
             access_code_id?: string | undefined
+            /** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
+            access_code_is_managed?: boolean | undefined
             /** ID of the action attempt associated with the lock action. */
             action_attempt_id?: string | undefined
             /** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
@@ -65352,6 +65393,8 @@ export type Routes = {
             event_type: 'lock.unlocked'
             /** ID of the access code that was used to unlock the affected device. */
             access_code_id?: string | undefined
+            /** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
+            access_code_is_managed?: boolean | undefined
             /** ID of the action attempt associated with the unlock action. */
             action_attempt_id?: string | undefined
             /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
@@ -99378,6 +99421,8 @@ export type Routes = {
                   event_type: 'lock.locked'
                   /** ID of the access code that was used to lock the device. */
                   access_code_id?: string | undefined
+                  /** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
+                  access_code_is_managed?: boolean | undefined
                   /** ID of the action attempt associated with the lock action. */
                   action_attempt_id?: string | undefined
                   /** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
@@ -99416,6 +99461,8 @@ export type Routes = {
                   event_type: 'lock.unlocked'
                   /** ID of the access code that was used to unlock the affected device. */
                   access_code_id?: string | undefined
+                  /** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
+                  access_code_is_managed?: boolean | undefined
                   /** ID of the action attempt associated with the unlock action. */
                   action_attempt_id?: string | undefined
                   /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */