@seamapi/types 1.587.0 → 1.589.0

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

@@ -31186,12 +31186,14 @@ export type Routes = {
             connected_account_id: string;
             /** Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). */
             automatically_manage_new_devices?: boolean | undefined;
-            /** Custom metadata that you want to associate with the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). */
+            /** Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). */
             custom_metadata?: {
                 [x: string]: string | boolean | null;
             } | undefined;
             /** List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are `lock`, `thermostat`, `noise_sensor`, and `access_control`. */
             accepted_capabilities?: ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[] | undefined;
+            /** The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer.  */
+            customer_key?: string | undefined;
         };
         commonParams: {};
         formData: {};
@@ -31381,6 +31383,8 @@ export type Routes = {
                     listing_key: string;
                 } | {
                     property_listing_key: string;
+                } | {
+                    site_key: string;
                 }) | ({
                     reservation_key: string;
                 } | {
@@ -31400,6 +31404,13 @@ export type Routes = {
                     /** Your unique identifier for the space. */
                     space_key: string;
                 }[] | undefined;
+                /** List of general sites or areas. */
+                sites?: {
+                    /** Your display name for this location resource. */
+                    name: string;
+                    /** Your unique identifier for the site. */
+                    site_key: string;
+                }[] | undefined;
                 /** List of short-term rental properties. */
                 properties?: {
                     /** Your display name for this location resource. */
@@ -31413,6 +31424,8 @@ export type Routes = {
                     name: string;
                     /** Your unique identifier for the room. */
                     room_key: string;
+                    /** Your unique identifier for the site. */
+                    parent_site_key?: string | undefined;
                 }[] | undefined;
                 /** List of shared common areas. */
                 common_areas?: {
@@ -31420,6 +31433,8 @@ export type Routes = {
                     name: string;
                     /** Your unique identifier for the common area. */
                     common_area_key: string;
+                    /** Your unique identifier for the site. */
+                    parent_site_key?: string | undefined;
                 }[] | undefined;
                 /** List of multi-family residential units. */
                 units?: {
@@ -31427,6 +31442,8 @@ export type Routes = {
                     name: string;
                     /** Your unique identifier for the unit. */
                     unit_key: string;
+                    /** Your unique identifier for the site. */
+                    parent_site_key?: string | undefined;
                 }[] | undefined;
                 /** List of gym or fitness facilities. */
                 facilities?: {
@@ -31712,6 +31729,13 @@ export type Routes = {
                 /** Your unique identifier for the space. */
                 space_key: string;
             }[] | undefined;
+            /** List of general sites or areas. */
+            sites?: {
+                /** Your display name for this location resource. */
+                name: string;
+                /** Your unique identifier for the site. */
+                site_key: string;
+            }[] | undefined;
             /** List of short-term rental properties. */
             properties?: {
                 /** Your display name for this location resource. */
@@ -31725,6 +31749,8 @@ export type Routes = {
                 name: string;
                 /** Your unique identifier for the room. */
                 room_key: string;
+                /** Your unique identifier for the site. */
+                parent_site_key?: string | undefined;
             }[] | undefined;
             /** List of shared common areas. */
             common_areas?: {
@@ -31732,6 +31758,8 @@ export type Routes = {
                 name: string;
                 /** Your unique identifier for the common area. */
                 common_area_key: string;
+                /** Your unique identifier for the site. */
+                parent_site_key?: string | undefined;
             }[] | undefined;
             /** List of multi-family residential units. */
             units?: {
@@ -31739,6 +31767,8 @@ export type Routes = {
                 name: string;
                 /** Your unique identifier for the unit. */
                 unit_key: string;
+                /** Your unique identifier for the site. */
+                parent_site_key?: string | undefined;
             }[] | undefined;
             /** List of gym or fitness facilities. */
             facilities?: {
@@ -58436,6 +58466,8 @@ export type Routes = {
                         listing_key: string;
                     } | {
                         property_listing_key: string;
+                    } | {
+                        site_key: string;
                     }) | ({
                         reservation_key: string;
                     } | {
@@ -59151,6 +59183,7 @@ export type Routes = {
             spaces: {
                 name: string;
                 partner_resource_key: string;
+                parent_partner_resource_key?: string | undefined;
                 devices: {
                     device_id: string;
                     device_type: 'lock' | 'thermostat' | 'sensor';

package/package.json

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

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

@@ -14,6 +14,7 @@ import {
   property_listing_resource,
   property_resource,
   room_resource,
+  site_resource,
   unit_resource,
 } from './location-resources.js'
 import {
@@ -32,6 +33,10 @@ export const customer_data = z.object({
     .array(neutral_resource)
     .optional()
     .describe('List of general spaces or areas.'),
+  sites: z
+    .array(site_resource)
+    .optional()
+    .describe('List of general sites or areas.'),
   properties: z
     .array(property_resource)
     .optional()

package/src/lib/seam/connect/models/customer/location-resources.ts

@@ -16,16 +16,28 @@ export const property_resource = base_location_resource.extend({
 
 export const room_resource = base_location_resource.extend({
   room_key: z.string().describe('Your unique identifier for the room.'),
+  parent_site_key: z
+    .string()
+    .optional()
+    .describe('Your unique identifier for the site.'),
 })
 
 export const common_area_resource = base_location_resource.extend({
   common_area_key: z
     .string()
     .describe('Your unique identifier for the common area.'),
+  parent_site_key: z
+    .string()
+    .optional()
+    .describe('Your unique identifier for the site.'),
 })
 
 export const unit_resource = base_location_resource.extend({
   unit_key: z.string().describe('Your unique identifier for the unit.'),
+  parent_site_key: z
+    .string()
+    .optional()
+    .describe('Your unique identifier for the site.'),
 })
 
 export const facility_resource = base_location_resource.extend({
@@ -46,6 +58,10 @@ export const property_listing_resource = base_location_resource.extend({
     .describe('Your unique identifier for the property listing.'),
 })
 
+export const site_resource = base_location_resource.extend({
+  site_key: z.string().describe('Your unique identifier for the site.'),
+})
+
 // Union of all location resource types
 export const location_resource = z.union([
   neutral_resource,
@@ -57,6 +73,7 @@ export const location_resource = z.union([
   building_resource,
   listing_resource,
   property_listing_resource,
+  site_resource,
 ])
 
 // All location key aliases for use in references
@@ -70,6 +87,7 @@ export const location_key_aliases = z.union([
   z.object({ building_key: z.string() }),
   z.object({ listing_key: z.string() }),
   z.object({ property_listing_key: z.string() }),
+  z.object({ site_key: z.string() }),
 ])
 
 // Export types
@@ -84,3 +102,4 @@ export type ListingResource = z.infer<typeof listing_resource>
 export type PropertyListingResource = z.infer<typeof property_listing_resource>
 export type LocationResource = z.infer<typeof location_resource>
 export type LocationKeyAliases = z.infer<typeof location_key_aliases>
+export type SiteResource = z.infer<typeof site_resource>

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

@@ -40267,9 +40267,15 @@ export default {
                       ],
                     },
                     description:
-                      'Custom metadata that you want to associate with the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata).',
+                      'Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata).',
                     type: 'object',
                   },
+                  customer_key: {
+                    description:
+                      'The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. ',
+                    minLength: 1,
+                    type: 'string',
+                  },
                 },
                 required: ['connected_account_id'],
                 type: 'object',
@@ -40494,6 +40500,13 @@ export default {
                                     required: ['property_listing_key'],
                                     type: 'object',
                                   },
+                                  {
+                                    properties: {
+                                      site_key: { type: 'string' },
+                                    },
+                                    required: ['site_key'],
+                                    type: 'object',
+                                  },
                                 ],
                               },
                               {
@@ -40783,6 +40796,11 @@ export default {
                                     'Your display name for this location resource.',
                                   type: 'string',
                                 },
+                                parent_site_key: {
+                                  description:
+                                    'Your unique identifier for the site.',
+                                  type: 'string',
+                                },
                               },
                               required: ['name', 'common_area_key'],
                               type: 'object',
@@ -41052,6 +41070,11 @@ export default {
                                     'Your display name for this location resource.',
                                   type: 'string',
                                 },
+                                parent_site_key: {
+                                  description:
+                                    'Your unique identifier for the site.',
+                                  type: 'string',
+                                },
                                 room_key: {
                                   description:
                                     'Your unique identifier for the room.',
@@ -41063,6 +41086,26 @@ export default {
                             },
                             type: 'array',
                           },
+                          sites: {
+                            description: 'List of general sites or areas.',
+                            items: {
+                              properties: {
+                                name: {
+                                  description:
+                                    'Your display name for this location resource.',
+                                  type: 'string',
+                                },
+                                site_key: {
+                                  description:
+                                    'Your unique identifier for the site.',
+                                  type: 'string',
+                                },
+                              },
+                              required: ['name', 'site_key'],
+                              type: 'object',
+                            },
+                            type: 'array',
+                          },
                           spaces: {
                             description: 'List of general spaces or areas.',
                             items: {
@@ -41123,6 +41166,11 @@ export default {
                                     'Your display name for this location resource.',
                                   type: 'string',
                                 },
+                                parent_site_key: {
+                                  description:
+                                    'Your unique identifier for the site.',
+                                  type: 'string',
+                                },
                                 unit_key: {
                                   description:
                                     'Your unique identifier for the unit.',
@@ -41831,6 +41879,10 @@ export default {
                             'Your display name for this location resource.',
                           type: 'string',
                         },
+                        parent_site_key: {
+                          description: 'Your unique identifier for the site.',
+                          type: 'string',
+                        },
                       },
                       required: ['name', 'common_area_key'],
                       type: 'object',
@@ -42097,6 +42149,10 @@ export default {
                             'Your display name for this location resource.',
                           type: 'string',
                         },
+                        parent_site_key: {
+                          description: 'Your unique identifier for the site.',
+                          type: 'string',
+                        },
                         room_key: {
                           description: 'Your unique identifier for the room.',
                           type: 'string',
@@ -42107,6 +42163,25 @@ export default {
                     },
                     type: 'array',
                   },
+                  sites: {
+                    description: 'List of general sites or areas.',
+                    items: {
+                      properties: {
+                        name: {
+                          description:
+                            'Your display name for this location resource.',
+                          type: 'string',
+                        },
+                        site_key: {
+                          description: 'Your unique identifier for the site.',
+                          type: 'string',
+                        },
+                      },
+                      required: ['name', 'site_key'],
+                      type: 'object',
+                    },
+                    type: 'array',
+                  },
                   spaces: {
                     description: 'List of general spaces or areas.',
                     items: {
@@ -42164,6 +42239,10 @@ export default {
                             'Your display name for this location resource.',
                           type: 'string',
                         },
+                        parent_site_key: {
+                          description: 'Your unique identifier for the site.',
+                          type: 'string',
+                        },
                         unit_key: {
                           description: 'Your unique identifier for the unit.',
                           type: 'string',
@@ -51641,6 +51720,13 @@ export default {
                                       required: ['property_listing_key'],
                                       type: 'object',
                                     },
+                                    {
+                                      properties: {
+                                        site_key: { type: 'string' },
+                                      },
+                                      required: ['site_key'],
+                                      type: 'object',
+                                    },
                                   ],
                                 },
                                 {
@@ -51846,6 +51932,13 @@ export default {
                                       required: ['property_listing_key'],
                                       type: 'object',
                                     },
+                                    {
+                                      properties: {
+                                        site_key: { type: 'string' },
+                                      },
+                                      required: ['site_key'],
+                                      type: 'object',
+                                    },
                                   ],
                                 },
                                 {
@@ -53139,6 +53232,7 @@ export default {
                           is_draft: { type: 'boolean' },
                           name: { type: 'string' },
                           needs_review: { type: 'boolean' },
+                          parent_partner_resource_key: { type: 'string' },
                           partner_resource_key: { type: 'string' },
                         },
                         required: [
@@ -53239,6 +53333,7 @@ export default {
                           is_draft: { type: 'boolean' },
                           name: { type: 'string' },
                           needs_review: { type: 'boolean' },
+                          parent_partner_resource_key: { type: 'string' },
                           partner_resource_key: { type: 'string' },
                         },
                         required: [

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

@@ -36243,7 +36243,7 @@ export type Routes = {
       connected_account_id: string
       /** Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). */
       automatically_manage_new_devices?: boolean | undefined
-      /** Custom metadata that you want to associate with the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). */
+      /** Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). */
       custom_metadata?:
         | {
             [x: string]: string | boolean | null
@@ -36253,6 +36253,8 @@ export type Routes = {
       accepted_capabilities?:
         | ('lock' | 'thermostat' | 'noise_sensor' | 'access_control')[]
         | undefined
+      /** The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer.  */
+      customer_key?: string | undefined
     }
     commonParams: {}
     formData: {}
@@ -36471,6 +36473,9 @@ export type Routes = {
                       | {
                           property_listing_key: string
                         }
+                      | {
+                          site_key: string
+                        }
                     )
                   | (
                       | {
@@ -36501,6 +36506,15 @@ export type Routes = {
                   space_key: string
                 }[]
               | undefined
+            /** List of general sites or areas. */
+            sites?:
+              | {
+                  /** Your display name for this location resource. */
+                  name: string
+                  /** Your unique identifier for the site. */
+                  site_key: string
+                }[]
+              | undefined
             /** List of short-term rental properties. */
             properties?:
               | {
@@ -36517,6 +36531,8 @@ export type Routes = {
                   name: string
                   /** Your unique identifier for the room. */
                   room_key: string
+                  /** Your unique identifier for the site. */
+                  parent_site_key?: string | undefined
                 }[]
               | undefined
             /** List of shared common areas. */
@@ -36526,6 +36542,8 @@ export type Routes = {
                   name: string
                   /** Your unique identifier for the common area. */
                   common_area_key: string
+                  /** Your unique identifier for the site. */
+                  parent_site_key?: string | undefined
                 }[]
               | undefined
             /** List of multi-family residential units. */
@@ -36535,6 +36553,8 @@ export type Routes = {
                   name: string
                   /** Your unique identifier for the unit. */
                   unit_key: string
+                  /** Your unique identifier for the site. */
+                  parent_site_key?: string | undefined
                 }[]
               | undefined
             /** List of gym or fitness facilities. */
@@ -36848,6 +36868,15 @@ export type Routes = {
             space_key: string
           }[]
         | undefined
+      /** List of general sites or areas. */
+      sites?:
+        | {
+            /** Your display name for this location resource. */
+            name: string
+            /** Your unique identifier for the site. */
+            site_key: string
+          }[]
+        | undefined
       /** List of short-term rental properties. */
       properties?:
         | {
@@ -36864,6 +36893,8 @@ export type Routes = {
             name: string
             /** Your unique identifier for the room. */
             room_key: string
+            /** Your unique identifier for the site. */
+            parent_site_key?: string | undefined
           }[]
         | undefined
       /** List of shared common areas. */
@@ -36873,6 +36904,8 @@ export type Routes = {
             name: string
             /** Your unique identifier for the common area. */
             common_area_key: string
+            /** Your unique identifier for the site. */
+            parent_site_key?: string | undefined
           }[]
         | undefined
       /** List of multi-family residential units. */
@@ -36882,6 +36915,8 @@ export type Routes = {
             name: string
             /** Your unique identifier for the unit. */
             unit_key: string
+            /** Your unique identifier for the site. */
+            parent_site_key?: string | undefined
           }[]
         | undefined
       /** List of gym or fitness facilities. */
@@ -69647,6 +69682,9 @@ export type Routes = {
                         | {
                             property_listing_key: string
                           }
+                        | {
+                            site_key: string
+                          }
                       )
                     | (
                         | {
@@ -70485,6 +70523,7 @@ export type Routes = {
       spaces: {
         name: string
         partner_resource_key: string
+        parent_partner_resource_key?: string | undefined
         devices: {
           device_id: string
           device_type: 'lock' | 'thermostat' | 'sensor'