@seamapi/types 1.588.0 → 1.590.0

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

@@ -10083,6 +10083,10 @@ export type Routes = {
                     device_count: number;
                     /** Number of entrances in the space. */
                     acs_entrance_count: number;
+                    /**  */
+                    parent_space_id?: string | undefined;
+                    /**  */
+                    parent_space_key?: string | undefined;
                 }[] | undefined;
                 devices?: {
                     /** ID of the device. */
@@ -13394,6 +13398,10 @@ export type Routes = {
                     device_count: number;
                     /** Number of entrances in the space. */
                     acs_entrance_count: number;
+                    /**  */
+                    parent_space_id?: string | undefined;
+                    /**  */
+                    parent_space_key?: string | undefined;
                 }[] | undefined;
                 devices?: {
                     /** ID of the device. */
@@ -31186,12 +31194,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: {};
@@ -58588,6 +58598,52 @@ export type Routes = {
         formData: {};
         jsonResponse: {};
     };
+    '/seam/customer/v1/spaces/create': {
+        route: '/seam/customer/v1/spaces/create';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            /** Name of the space that you want to create. */
+            name: string;
+            /** Unique key for the space within the workspace. */
+            space_key?: string | undefined;
+            /** IDs of the devices that you want to add to the new space. */
+            device_ids?: string[] | undefined;
+            /** IDs of the entrances that you want to add to the new space. */
+            acs_entrance_ids?: string[] | undefined;
+            /** Space key of the parent space for this space. */
+            parent_space_key?: string | undefined;
+            /** Name of the parent space for this space. */
+            parent_space_name?: string | undefined;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            /** Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient. */
+            space: {
+                /** ID of the space. */
+                space_id: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
+                workspace_id: string;
+                /** Unique key for the space within the workspace. */
+                space_key?: string | undefined;
+                /** Name of the space. */
+                name: string;
+                /** Display name for the space. */
+                display_name: string;
+                /** Date and time at which the space was created. */
+                created_at: string;
+                /** Number of devices in the space. */
+                device_count: number;
+                /** Number of entrances in the space. */
+                acs_entrance_count: number;
+                /**  */
+                parent_space_id?: string | undefined;
+                /**  */
+                parent_space_key?: string | undefined;
+            };
+        };
+    };
     '/seam/instant_key/v1/client_sessions/exchange_short_code': {
         route: '/seam/instant_key/v1/client_sessions/exchange_short_code';
         method: 'POST';
@@ -59261,6 +59317,10 @@ export type Routes = {
                 device_count: number;
                 /** Number of entrances in the space. */
                 acs_entrance_count: number;
+                /**  */
+                parent_space_id?: string | undefined;
+                /**  */
+                parent_space_key?: string | undefined;
             };
         };
     };
@@ -59308,6 +59368,10 @@ export type Routes = {
                 device_count: number;
                 /** Number of entrances in the space. */
                 acs_entrance_count: number;
+                /**  */
+                parent_space_id?: string | undefined;
+                /**  */
+                parent_space_key?: string | undefined;
             };
         };
     };
@@ -59346,6 +59410,10 @@ export type Routes = {
                     device_count: number;
                     /** Number of entrances in the space. */
                     acs_entrance_count: number;
+                    /**  */
+                    parent_space_id?: string | undefined;
+                    /**  */
+                    parent_space_key?: string | undefined;
                 }[] | undefined;
                 devices?: {
                     /** ID of the device. */
@@ -60953,6 +61021,10 @@ export type Routes = {
                 device_count: number;
                 /** Number of entrances in the space. */
                 acs_entrance_count: number;
+                /**  */
+                parent_space_id?: string | undefined;
+                /**  */
+                parent_space_key?: string | undefined;
             }[];
         };
     };
@@ -61023,6 +61095,10 @@ export type Routes = {
                 device_count: number;
                 /** Number of entrances in the space. */
                 acs_entrance_count: number;
+                /**  */
+                parent_space_id?: string | undefined;
+                /**  */
+                parent_space_key?: string | undefined;
             };
         };
     };
@@ -80390,6 +80466,10 @@ export type Routes = {
                     device_count: number;
                     /** Number of entrances in the space. */
                     acs_entrance_count: number;
+                    /**  */
+                    parent_space_id?: string | undefined;
+                    /**  */
+                    parent_space_key?: string | undefined;
                 }[] | undefined;
                 devices?: {
                     /** ID of the device. */

package/package.json

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

package/src/lib/seam/connect/models/spaces/space.ts

@@ -20,6 +20,16 @@ export const space = z.object({
     .describe('Date and time at which the space was created.'),
   device_count: z.number().describe('Number of devices in the space.'),
   acs_entrance_count: z.number().describe('Number of entrances in the space.'),
+  parent_space_id: z.string().uuid().optional().describe(`
+    ---
+    undocumented: Only used internally.
+    ---
+    `),
+  parent_space_key: z.string().optional().describe(`
+    ---
+    undocumented: Only used internally.
+    ---
+    `),
 }).describe(`
   ---
   draft: Early access.

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

@@ -20775,6 +20775,15 @@ export default {
             type: 'string',
           },
           name: { description: 'Name of the space.', type: 'string' },
+          parent_space_id: {
+            format: 'uuid',
+            type: 'string',
+            'x-undocumented': 'Only used internally.',
+          },
+          parent_space_key: {
+            type: 'string',
+            'x-undocumented': 'Only used internally.',
+          },
           space_id: {
             description: 'ID of the space.',
             format: 'uuid',
@@ -40267,9 +40276,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',
@@ -52674,6 +52689,82 @@ export default {
         'x-undocumented': 'Internal endpoint for customer portals.',
       },
     },
+    '/seam/customer/v1/spaces/create': {
+      post: {
+        description: 'Creates a new space with optional parent space support.',
+        operationId: 'seamCustomerV1SpacesCreatePost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  acs_entrance_ids: {
+                    description:
+                      'IDs of the entrances that you want to add to the new space.',
+                    items: { format: 'uuid', type: 'string' },
+                    type: 'array',
+                  },
+                  device_ids: {
+                    description:
+                      'IDs of the devices that you want to add to the new space.',
+                    items: { format: 'uuid', type: 'string' },
+                    type: 'array',
+                  },
+                  name: {
+                    description: 'Name of the space that you want to create.',
+                    type: 'string',
+                  },
+                  parent_space_key: {
+                    description:
+                      'Space key of the parent space for this space.',
+                    type: 'string',
+                  },
+                  parent_space_name: {
+                    description: 'Name of the parent space for this space.',
+                    type: 'string',
+                  },
+                  space_key: {
+                    description:
+                      'Unique key for the space within the workspace.',
+                    type: 'string',
+                  },
+                },
+                required: ['name'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    ok: { type: 'boolean' },
+                    space: { $ref: '#/components/schemas/space' },
+                  },
+                  required: ['space', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ client_session_with_customer: [] }],
+        summary: '/seam/customer/v1/spaces/create',
+        tags: [],
+        'x-draft': 'Early access.',
+        'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'spaces'],
+        'x-fern-sdk-method-name': 'create',
+        'x-fern-sdk-return-value': 'space',
+        'x-response-key': 'space',
+        'x-title': 'Create a Space',
+      },
+    },
     '/seam/instant_key/v1/client_sessions/exchange_short_code': {
       post: {
         description:

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

@@ -11353,6 +11353,10 @@ export type Routes = {
               device_count: number
               /** Number of entrances in the space. */
               acs_entrance_count: number
+              /**  */
+              parent_space_id?: string | undefined
+              /**  */
+              parent_space_key?: string | undefined
             }[]
           | undefined
         devices?:
@@ -15339,6 +15343,10 @@ export type Routes = {
               device_count: number
               /** Number of entrances in the space. */
               acs_entrance_count: number
+              /**  */
+              parent_space_id?: string | undefined
+              /**  */
+              parent_space_key?: string | undefined
             }[]
           | undefined
         devices?:
@@ -36243,7 +36251,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 +36261,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: {}
@@ -69837,6 +69847,52 @@ export type Routes = {
     formData: {}
     jsonResponse: {}
   }
+  '/seam/customer/v1/spaces/create': {
+    route: '/seam/customer/v1/spaces/create'
+    method: 'POST'
+    queryParams: {}
+    jsonBody: {
+      /** Name of the space that you want to create. */
+      name: string
+      /** Unique key for the space within the workspace. */
+      space_key?: string | undefined
+      /** IDs of the devices that you want to add to the new space. */
+      device_ids?: string[] | undefined
+      /** IDs of the entrances that you want to add to the new space. */
+      acs_entrance_ids?: string[] | undefined
+      /** Space key of the parent space for this space. */
+      parent_space_key?: string | undefined
+      /** Name of the parent space for this space. */
+      parent_space_name?: string | undefined
+    }
+    commonParams: {}
+    formData: {}
+    jsonResponse: {
+      /** Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient. */
+      space: {
+        /** ID of the space. */
+        space_id: string
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
+        workspace_id: string
+        /** Unique key for the space within the workspace. */
+        space_key?: string | undefined
+        /** Name of the space. */
+        name: string
+        /** Display name for the space. */
+        display_name: string
+        /** Date and time at which the space was created. */
+        created_at: string
+        /** Number of devices in the space. */
+        device_count: number
+        /** Number of entrances in the space. */
+        acs_entrance_count: number
+        /**  */
+        parent_space_id?: string | undefined
+        /**  */
+        parent_space_key?: string | undefined
+      }
+    }
+  }
   '/seam/instant_key/v1/client_sessions/exchange_short_code': {
     route: '/seam/instant_key/v1/client_sessions/exchange_short_code'
     method: 'POST'
@@ -70601,6 +70657,10 @@ export type Routes = {
         device_count: number
         /** Number of entrances in the space. */
         acs_entrance_count: number
+        /**  */
+        parent_space_id?: string | undefined
+        /**  */
+        parent_space_key?: string | undefined
       }
     }
   }
@@ -70650,6 +70710,10 @@ export type Routes = {
         device_count: number
         /** Number of entrances in the space. */
         acs_entrance_count: number
+        /**  */
+        parent_space_id?: string | undefined
+        /**  */
+        parent_space_key?: string | undefined
       }
     }
   }
@@ -70705,6 +70769,10 @@ export type Routes = {
               device_count: number
               /** Number of entrances in the space. */
               acs_entrance_count: number
+              /**  */
+              parent_space_id?: string | undefined
+              /**  */
+              parent_space_key?: string | undefined
             }[]
           | undefined
         devices?:
@@ -72749,6 +72817,10 @@ export type Routes = {
         device_count: number
         /** Number of entrances in the space. */
         acs_entrance_count: number
+        /**  */
+        parent_space_id?: string | undefined
+        /**  */
+        parent_space_key?: string | undefined
       }[]
     }
   }
@@ -72819,6 +72891,10 @@ export type Routes = {
         device_count: number
         /** Number of entrances in the space. */
         acs_entrance_count: number
+        /**  */
+        parent_space_id?: string | undefined
+        /**  */
+        parent_space_key?: string | undefined
       }
     }
   }
@@ -95651,6 +95727,10 @@ export type Routes = {
               device_count: number
               /** Number of entrances in the space. */
               acs_entrance_count: number
+              /**  */
+              parent_space_id?: string | undefined
+              /**  */
+              parent_space_key?: string | undefined
             }[]
           | undefined
         devices?: