@seamapi/types 1.502.0 → 1.504.0

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

@@ -1301,6 +1301,8 @@ export type Routes = {
           
           In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
             access_code: {
+                /** Unique identifier for the Seam workspace associated with the access code. */
+                workspace_id: string;
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
                 /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -1855,6 +1857,8 @@ export type Routes = {
         formData: {};
         jsonResponse: {
             access_codes: {
+                /** Unique identifier for the Seam workspace associated with the access code. */
+                workspace_id: string;
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
                 /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -3663,6 +3667,8 @@ export type Routes = {
           
           In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
             access_code: {
+                /** Unique identifier for the Seam workspace associated with the access code. */
+                workspace_id: string;
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
                 /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -4190,6 +4196,8 @@ export type Routes = {
         formData: {};
         jsonResponse: {
             access_codes: {
+                /** Unique identifier for the Seam workspace associated with the access code. */
+                workspace_id: string;
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
                 /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -4724,6 +4732,8 @@ export type Routes = {
           
           In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
             backup_access_code: {
+                /** Unique identifier for the Seam workspace associated with the access code. */
+                workspace_id: string;
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
                 /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -5236,6 +5246,8 @@ export type Routes = {
           
           In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
             access_code: {
+                /** Unique identifier for the Seam workspace associated with the access code. */
+                workspace_id: string;
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
                 /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -5787,6 +5799,8 @@ export type Routes = {
           
           - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) */
             access_code: {
+                /** Unique identifier for the Seam workspace associated with the access code. */
+                workspace_id: string;
                 /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
                 type: 'time_bound' | 'ongoing';
                 /** Unique identifier for the access code. */
@@ -7582,6 +7596,8 @@ export type Routes = {
           
           - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) */
             access_code: {
+                /** Unique identifier for the Seam workspace associated with the access code. */
+                workspace_id: string;
                 /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
                 type: 'time_bound' | 'ongoing';
                 /** Unique identifier for the access code. */
@@ -8088,6 +8104,8 @@ export type Routes = {
         formData: {};
         jsonResponse: {
             access_codes: {
+                /** Unique identifier for the Seam workspace associated with the access code. */
+                workspace_id: string;
                 /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
                 type: 'time_bound' | 'ongoing';
                 /** Unique identifier for the access code. */
@@ -19030,6 +19048,8 @@ export type Routes = {
                     } | undefined;
                 }[] | undefined;
                 access_codes?: {
+                    /** Unique identifier for the Seam workspace associated with the access code. */
+                    workspace_id: string;
                     /** Unique identifier for a group of access codes that share the same code. */
                     common_code_key: string | null;
                     /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -19535,6 +19555,8 @@ export type Routes = {
                     is_offline_access_code: boolean;
                 }[] | undefined;
                 unmanaged_access_codes?: {
+                    /** Unique identifier for the Seam workspace associated with the access code. */
+                    workspace_id: string;
                     /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
                     type: 'time_bound' | 'ongoing';
                     /** Unique identifier for the access code. */
@@ -31179,6 +31201,50 @@ export type Routes = {
             };
         };
     };
+    '/customers/delete_data': {
+        route: '/customers/delete_data';
+        method: 'DELETE' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** List of space keys to delete. */
+            space_keys?: string[] | undefined;
+            /** List of property keys to delete. */
+            property_keys?: string[] | undefined;
+            /** List of room keys to delete. */
+            room_keys?: string[] | undefined;
+            /** List of common area keys to delete. */
+            common_area_keys?: string[] | undefined;
+            /** List of unit keys to delete. */
+            unit_keys?: string[] | undefined;
+            /** List of facility keys to delete. */
+            facility_keys?: string[] | undefined;
+            /** List of building keys to delete. */
+            building_keys?: string[] | undefined;
+            /** List of listing keys to delete. */
+            listing_keys?: string[] | undefined;
+            /** List of property listing keys to delete. */
+            property_listing_keys?: string[] | undefined;
+            /** List of guest keys to delete. */
+            guest_keys?: string[] | undefined;
+            /** List of tenant keys to delete. */
+            tenant_keys?: string[] | undefined;
+            /** List of resident keys to delete. */
+            resident_keys?: string[] | undefined;
+            /** List of user keys to delete. */
+            user_keys?: string[] | undefined;
+            /** List of user identity keys to delete. */
+            user_identity_keys?: string[] | undefined;
+            /** List of reservation keys to delete. */
+            reservation_keys?: string[] | undefined;
+            /** List of booking keys to delete. */
+            booking_keys?: string[] | undefined;
+            /** List of access grant keys to delete. */
+            access_grant_keys?: string[] | undefined;
+        };
+        formData: {};
+        jsonResponse: {};
+    };
     '/customers/push_data': {
         route: '/customers/push_data';
         method: 'POST';
@@ -84435,6 +84501,8 @@ export type Routes = {
                     } | undefined;
                 }[] | undefined;
                 access_codes?: {
+                    /** Unique identifier for the Seam workspace associated with the access code. */
+                    workspace_id: string;
                     /** Unique identifier for a group of access codes that share the same code. */
                     common_code_key: string | null;
                     /** Indicates whether the code is set on the device according to a preconfigured schedule. */
@@ -84940,6 +85008,8 @@ export type Routes = {
                     is_offline_access_code: boolean;
                 }[] | undefined;
                 unmanaged_access_codes?: {
+                    /** Unique identifier for the Seam workspace associated with the access code. */
+                    workspace_id: string;
                     /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
                     type: 'time_bound' | 'ongoing';
                     /** Unique identifier for the access code. */

package/package.json

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

package/src/lib/seam/connect/models/access-codes/managed-access-code.ts

@@ -495,6 +495,12 @@ const _access_code_warning_map = z.object({
 export type AccessCodeWarningMap = z.infer<typeof _access_code_warning_map>
 
 export const access_code = z.object({
+  workspace_id: z
+    .string()
+    .uuid()
+    .describe(
+      'Unique identifier for the Seam workspace associated with the access code.',
+    ),
   common_code_key: z
     .string()
     .nullable()

package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts

@@ -4,6 +4,7 @@ import { access_code } from './managed-access-code.js'
 
 export const unmanaged_access_code = access_code
   .pick({
+    workspace_id: true,
     type: true,
     access_code_id: true,
     device_id: true,

package/src/lib/seam/connect/models/customer/customer-delete-data.ts

@@ -0,0 +1,79 @@
+import { z } from 'zod'
+
+export const customer_delete_data = z.object({
+  // Location resources to delete
+  space_keys: z
+    .array(z.string())
+    .optional()
+    .describe('List of space keys to delete.'),
+  property_keys: z
+    .array(z.string())
+    .optional()
+    .describe('List of property keys to delete.'),
+  room_keys: z
+    .array(z.string())
+    .optional()
+    .describe('List of room keys to delete.'),
+  common_area_keys: z
+    .array(z.string())
+    .optional()
+    .describe('List of common area keys to delete.'),
+  unit_keys: z
+    .array(z.string())
+    .optional()
+    .describe('List of unit keys to delete.'),
+  facility_keys: z
+    .array(z.string())
+    .optional()
+    .describe('List of facility keys to delete.'),
+  building_keys: z
+    .array(z.string())
+    .optional()
+    .describe('List of building keys to delete.'),
+  listing_keys: z
+    .array(z.string())
+    .optional()
+    .describe('List of listing keys to delete.'),
+  property_listing_keys: z
+    .array(z.string())
+    .optional()
+    .describe('List of property listing keys to delete.'),
+
+  // User identity resources to delete
+  guest_keys: z
+    .array(z.string())
+    .optional()
+    .describe('List of guest keys to delete.'),
+  tenant_keys: z
+    .array(z.string())
+    .optional()
+    .describe('List of tenant keys to delete.'),
+  resident_keys: z
+    .array(z.string())
+    .optional()
+    .describe('List of resident keys to delete.'),
+  user_keys: z
+    .array(z.string())
+    .optional()
+    .describe('List of user keys to delete.'),
+  user_identity_keys: z
+    .array(z.string())
+    .optional()
+    .describe('List of user identity keys to delete.'),
+
+  // Access grant resources to delete
+  reservation_keys: z
+    .array(z.string())
+    .optional()
+    .describe('List of reservation keys to delete.'),
+  booking_keys: z
+    .array(z.string())
+    .optional()
+    .describe('List of booking keys to delete.'),
+  access_grant_keys: z
+    .array(z.string())
+    .optional()
+    .describe('List of access grant keys to delete.'),
+})
+
+export type CustomerDeleteData = z.infer<typeof customer_delete_data>

package/src/lib/seam/connect/models/customer/index.ts

@@ -1,3 +1,4 @@
 export * from './business-vertical.js'
 export * from './customer-data.js'
+export * from './customer-delete-data.js'
 export * from './customer-portal.js'

package/src/lib/seam/connect/models/index.ts

@@ -10,6 +10,7 @@ export * from './connect-webviews/index.js'
 export * from './connected-accounts/index.js'
 export * from './custom-metadata.js'
 export * from './customer/access-grant-resources.js'
+export * from './customer/customer-delete-data.js'
 export * from './customer/index.js'
 export * from './customer/location-resources.js'
 export * from './customer/user-identity-resources.js'

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

@@ -1792,8 +1792,15 @@ export default {
               thermostats: { name: 'Thermostats' },
             },
           },
+          workspace_id: {
+            description:
+              'Unique identifier for the Seam workspace associated with the access code.',
+            format: 'uuid',
+            type: 'string',
+          },
         },
         required: [
+          'workspace_id',
           'common_code_key',
           'type',
           'access_code_id',
@@ -22266,8 +22273,15 @@ export default {
               thermostats: { name: 'Thermostats' },
             },
           },
+          workspace_id: {
+            description:
+              'Unique identifier for the Seam workspace associated with the access code.',
+            format: 'uuid',
+            type: 'string',
+          },
         },
         required: [
+          'workspace_id',
           'type',
           'access_code_id',
           'device_id',
@@ -38929,6 +38943,323 @@ export default {
         'x-title': 'Create Customer Portal',
       },
     },
+    '/customers/delete_data': {
+      delete: {
+        description:
+          'Deletes customer data including resources like spaces, properties, rooms, users, etc.\nThis will delete the partner resources and any related Seam resources (user identities, access grants, spaces).',
+        operationId: 'customersDeleteDataDelete',
+        parameters: [
+          {
+            in: 'query',
+            name: 'space_keys',
+            schema: {
+              description: 'List of space keys to delete.',
+              items: { type: 'string' },
+              type: 'array',
+            },
+          },
+          {
+            in: 'query',
+            name: 'property_keys',
+            schema: {
+              description: 'List of property keys to delete.',
+              items: { type: 'string' },
+              type: 'array',
+            },
+          },
+          {
+            in: 'query',
+            name: 'room_keys',
+            schema: {
+              description: 'List of room keys to delete.',
+              items: { type: 'string' },
+              type: 'array',
+            },
+          },
+          {
+            in: 'query',
+            name: 'common_area_keys',
+            schema: {
+              description: 'List of common area keys to delete.',
+              items: { type: 'string' },
+              type: 'array',
+            },
+          },
+          {
+            in: 'query',
+            name: 'unit_keys',
+            schema: {
+              description: 'List of unit keys to delete.',
+              items: { type: 'string' },
+              type: 'array',
+            },
+          },
+          {
+            in: 'query',
+            name: 'facility_keys',
+            schema: {
+              description: 'List of facility keys to delete.',
+              items: { type: 'string' },
+              type: 'array',
+            },
+          },
+          {
+            in: 'query',
+            name: 'building_keys',
+            schema: {
+              description: 'List of building keys to delete.',
+              items: { type: 'string' },
+              type: 'array',
+            },
+          },
+          {
+            in: 'query',
+            name: 'listing_keys',
+            schema: {
+              description: 'List of listing keys to delete.',
+              items: { type: 'string' },
+              type: 'array',
+            },
+          },
+          {
+            in: 'query',
+            name: 'property_listing_keys',
+            schema: {
+              description: 'List of property listing keys to delete.',
+              items: { type: 'string' },
+              type: 'array',
+            },
+          },
+          {
+            in: 'query',
+            name: 'guest_keys',
+            schema: {
+              description: 'List of guest keys to delete.',
+              items: { type: 'string' },
+              type: 'array',
+            },
+          },
+          {
+            in: 'query',
+            name: 'tenant_keys',
+            schema: {
+              description: 'List of tenant keys to delete.',
+              items: { type: 'string' },
+              type: 'array',
+            },
+          },
+          {
+            in: 'query',
+            name: 'resident_keys',
+            schema: {
+              description: 'List of resident keys to delete.',
+              items: { type: 'string' },
+              type: 'array',
+            },
+          },
+          {
+            in: 'query',
+            name: 'user_keys',
+            schema: {
+              description: 'List of user keys to delete.',
+              items: { type: 'string' },
+              type: 'array',
+            },
+          },
+          {
+            in: 'query',
+            name: 'user_identity_keys',
+            schema: {
+              description: 'List of user identity keys to delete.',
+              items: { type: 'string' },
+              type: 'array',
+            },
+          },
+          {
+            in: 'query',
+            name: 'reservation_keys',
+            schema: {
+              description: 'List of reservation keys to delete.',
+              items: { type: 'string' },
+              type: 'array',
+            },
+          },
+          {
+            in: 'query',
+            name: 'booking_keys',
+            schema: {
+              description: 'List of booking keys to delete.',
+              items: { type: 'string' },
+              type: 'array',
+            },
+          },
+          {
+            in: 'query',
+            name: 'access_grant_keys',
+            schema: {
+              description: 'List of access grant keys to delete.',
+              items: { type: 'string' },
+              type: 'array',
+            },
+          },
+        ],
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: { ok: { type: 'boolean' } },
+                  required: ['ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/customers/delete_data',
+        tags: [],
+        'x-fern-sdk-group-name': ['customers'],
+        'x-fern-sdk-method-name': 'delete_data',
+        'x-response-key': null,
+        'x-title': 'Delete Customer Data',
+      },
+      post: {
+        description:
+          'Deletes customer data including resources like spaces, properties, rooms, users, etc.\nThis will delete the partner resources and any related Seam resources (user identities, access grants, spaces).',
+        operationId: 'customersDeleteDataPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  access_grant_keys: {
+                    description: 'List of access grant keys to delete.',
+                    items: { type: 'string' },
+                    type: 'array',
+                  },
+                  booking_keys: {
+                    description: 'List of booking keys to delete.',
+                    items: { type: 'string' },
+                    type: 'array',
+                  },
+                  building_keys: {
+                    description: 'List of building keys to delete.',
+                    items: { type: 'string' },
+                    type: 'array',
+                  },
+                  common_area_keys: {
+                    description: 'List of common area keys to delete.',
+                    items: { type: 'string' },
+                    type: 'array',
+                  },
+                  facility_keys: {
+                    description: 'List of facility keys to delete.',
+                    items: { type: 'string' },
+                    type: 'array',
+                  },
+                  guest_keys: {
+                    description: 'List of guest keys to delete.',
+                    items: { type: 'string' },
+                    type: 'array',
+                  },
+                  listing_keys: {
+                    description: 'List of listing keys to delete.',
+                    items: { type: 'string' },
+                    type: 'array',
+                  },
+                  property_keys: {
+                    description: 'List of property keys to delete.',
+                    items: { type: 'string' },
+                    type: 'array',
+                  },
+                  property_listing_keys: {
+                    description: 'List of property listing keys to delete.',
+                    items: { type: 'string' },
+                    type: 'array',
+                  },
+                  reservation_keys: {
+                    description: 'List of reservation keys to delete.',
+                    items: { type: 'string' },
+                    type: 'array',
+                  },
+                  resident_keys: {
+                    description: 'List of resident keys to delete.',
+                    items: { type: 'string' },
+                    type: 'array',
+                  },
+                  room_keys: {
+                    description: 'List of room keys to delete.',
+                    items: { type: 'string' },
+                    type: 'array',
+                  },
+                  space_keys: {
+                    description: 'List of space keys to delete.',
+                    items: { type: 'string' },
+                    type: 'array',
+                  },
+                  tenant_keys: {
+                    description: 'List of tenant keys to delete.',
+                    items: { type: 'string' },
+                    type: 'array',
+                  },
+                  unit_keys: {
+                    description: 'List of unit keys to delete.',
+                    items: { type: 'string' },
+                    type: 'array',
+                  },
+                  user_identity_keys: {
+                    description: 'List of user identity keys to delete.',
+                    items: { type: 'string' },
+                    type: 'array',
+                  },
+                  user_keys: {
+                    description: 'List of user keys to delete.',
+                    items: { type: 'string' },
+                    type: 'array',
+                  },
+                },
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: { ok: { type: 'boolean' } },
+                  required: ['ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/customers/delete_data',
+        tags: [],
+        'x-fern-sdk-group-name': ['customers'],
+        'x-fern-sdk-method-name': 'delete_data',
+        'x-response-key': null,
+        'x-title': 'Delete Customer Data',
+      },
+    },
     '/customers/push_data': {
       post: {
         description: