@seamapi/types 1.588.0 → 1.590.0

package/dist/connect.d.cts

@@ -10373,6 +10373,8 @@ declare const batch: z.ZodObject<{
         created_at: z.ZodString;
         device_count: z.ZodNumber;
         acs_entrance_count: z.ZodNumber;
+        parent_space_id: z.ZodOptional<z.ZodString>;
+        parent_space_key: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         name: string;
         display_name: string;
@@ -10382,6 +10384,8 @@ declare const batch: z.ZodObject<{
         space_id: string;
         acs_entrance_count: number;
         space_key?: string | undefined;
+        parent_space_id?: string | undefined;
+        parent_space_key?: string | undefined;
     }, {
         name: string;
         display_name: string;
@@ -10391,6 +10395,8 @@ declare const batch: z.ZodObject<{
         space_id: string;
         acs_entrance_count: number;
         space_key?: string | undefined;
+        parent_space_id?: string | undefined;
+        parent_space_key?: string | undefined;
     }>, "many">>;
     devices: z.ZodOptional<z.ZodArray<z.ZodObject<{
         device_id: z.ZodString;
@@ -30889,6 +30895,8 @@ declare const batch: z.ZodObject<{
         space_id: string;
         acs_entrance_count: number;
         space_key?: string | undefined;
+        parent_space_id?: string | undefined;
+        parent_space_key?: string | undefined;
     }[] | undefined;
     devices?: {
         display_name: string;
@@ -34786,6 +34794,8 @@ declare const batch: z.ZodObject<{
         space_id: string;
         acs_entrance_count: number;
         space_key?: string | undefined;
+        parent_space_id?: string | undefined;
+        parent_space_key?: string | undefined;
     }[] | undefined;
     devices?: {
         display_name: string;
@@ -50852,6 +50862,8 @@ declare const space: z.ZodObject<{
     created_at: z.ZodString;
     device_count: z.ZodNumber;
     acs_entrance_count: z.ZodNumber;
+    parent_space_id: z.ZodOptional<z.ZodString>;
+    parent_space_key: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     name: string;
     display_name: string;
@@ -50861,6 +50873,8 @@ declare const space: z.ZodObject<{
     space_id: string;
     acs_entrance_count: number;
     space_key?: string | undefined;
+    parent_space_id?: string | undefined;
+    parent_space_key?: string | undefined;
 }, {
     name: string;
     display_name: string;
@@ -50870,6 +50884,8 @@ declare const space: z.ZodObject<{
     space_id: string;
     acs_entrance_count: number;
     space_key?: string | undefined;
+    parent_space_id?: string | undefined;
+    parent_space_key?: string | undefined;
 }>;
 type Space = z.infer<typeof space>;
 
@@ -63469,6 +63485,15 @@ declare const _default: {
                         description: string;
                         type: string;
                     };
+                    parent_space_id: {
+                        format: string;
+                        type: string;
+                        'x-undocumented': string;
+                    };
+                    parent_space_key: {
+                        type: string;
+                        'x-undocumented': string;
+                    };
                     space_id: {
                         description: string;
                         format: string;
@@ -82405,6 +82430,11 @@ declare const _default: {
                                         description: string;
                                         type: string;
                                     };
+                                    customer_key: {
+                                        description: string;
+                                        minLength: number;
+                                        type: string;
+                                    };
                                 };
                                 required: string[];
                                 type: string;
@@ -94682,6 +94712,94 @@ declare const _default: {
                 'x-undocumented': string;
             };
         };
+        '/seam/customer/v1/spaces/create': {
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    acs_entrance_ids: {
+                                        description: string;
+                                        items: {
+                                            format: string;
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    device_ids: {
+                                        description: string;
+                                        items: {
+                                            format: string;
+                                            type: string;
+                                        };
+                                        type: string;
+                                    };
+                                    name: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                    parent_space_key: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                    parent_space_name: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                    space_key: {
+                                        description: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        ok: {
+                                            type: string;
+                                        };
+                                        space: {
+                                            $ref: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: {
+                    client_session_with_customer: never[];
+                }[];
+                summary: string;
+                tags: never[];
+                'x-draft': string;
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
+                'x-response-key': string;
+                'x-title': string;
+            };
+        };
         '/seam/instant_key/v1/client_sessions/exchange_short_code': {
             post: {
                 description: string;
@@ -116884,6 +117002,10 @@ 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. */
@@ -120195,6 +120317,10 @@ 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. */
@@ -137987,12 +138113,14 @@ 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: {};
@@ -165389,6 +165517,52 @@ 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';
@@ -166062,6 +166236,10 @@ 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;
             };
         };
     };
@@ -166109,6 +166287,10 @@ 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;
             };
         };
     };
@@ -166147,6 +166329,10 @@ 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. */
@@ -167754,6 +167940,10 @@ 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;
             }[];
         };
     };
@@ -167824,6 +168014,10 @@ 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;
             };
         };
     };
@@ -187191,6 +187385,10 @@ 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/dist/index.cjs

@@ -5347,7 +5347,17 @@ var space = zod.z.object({
   display_name: zod.z.string().describe("Display name for the space."),
   created_at: zod.z.string().datetime().describe("Date and time at which the space was created."),
   device_count: zod.z.number().describe("Number of devices in the space."),
-  acs_entrance_count: zod.z.number().describe("Number of entrances in the space.")
+  acs_entrance_count: zod.z.number().describe("Number of entrances in the space."),
+  parent_space_id: zod.z.string().uuid().optional().describe(`
+    ---
+    undocumented: Only used internally.
+    ---
+    `),
+  parent_space_key: zod.z.string().optional().describe(`
+    ---
+    undocumented: Only used internally.
+    ---
+    `)
 }).describe(`
   ---
   draft: Early access.
@@ -24415,6 +24425,15 @@ var openapi_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",
@@ -42441,8 +42460,13 @@ var openapi_default = {
                         { type: "boolean" }
                       ]
                     },
-                    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).",
+                    description: "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"],
@@ -54288,6 +54312,78 @@ var openapi_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: "Exchanges a short code for a client session token. Mobile apps use this endpoint to retrieve a client session token securely using a short code obtained from an Instant Key URL.",