@seamapi/types 1.445.1 → 1.446.0

package/dist/connect.d.cts

@@ -3603,6 +3603,7 @@ type UnmanagedAccessCode = z.infer<typeof unmanaged_access_code>;
 declare const access_grant: z.ZodObject<{
     workspace_id: z.ZodString;
     access_grant_id: z.ZodString;
+    access_grant_key: z.ZodOptional<z.ZodString>;
     user_identity_id: z.ZodString;
     location_ids: z.ZodArray<z.ZodString, "many">;
     space_ids: z.ZodArray<z.ZodString, "many">;
@@ -3645,6 +3646,7 @@ declare const access_grant: z.ZodObject<{
     access_method_ids: string[];
     starts_at?: string | undefined;
     ends_at?: string | undefined;
+    access_grant_key?: string | undefined;
     instant_key_url?: string | undefined;
 }, {
     display_name: string;
@@ -3663,6 +3665,7 @@ declare const access_grant: z.ZodObject<{
     access_method_ids: string[];
     starts_at?: string | undefined;
     ends_at?: string | undefined;
+    access_grant_key?: string | undefined;
     instant_key_url?: string | undefined;
 }>;
 type AccessGrant = z.infer<typeof access_grant>;
@@ -10124,6 +10127,7 @@ declare const batch: z.ZodObject<{
     spaces: z.ZodOptional<z.ZodArray<z.ZodObject<{
         space_id: z.ZodString;
         workspace_id: z.ZodString;
+        space_key: z.ZodOptional<z.ZodString>;
         name: z.ZodString;
         display_name: z.ZodString;
         created_at: z.ZodString;
@@ -10137,6 +10141,7 @@ declare const batch: z.ZodObject<{
         space_id: string;
         device_count: number;
         acs_entrance_count: number;
+        space_key?: string | undefined;
     }, {
         name: string;
         display_name: string;
@@ -10145,6 +10150,7 @@ declare const batch: z.ZodObject<{
         space_id: string;
         device_count: number;
         acs_entrance_count: number;
+        space_key?: string | undefined;
     }>, "many">>;
     devices: z.ZodOptional<z.ZodArray<z.ZodObject<{
         device_id: z.ZodString;
@@ -14403,6 +14409,7 @@ declare const batch: z.ZodObject<{
         space_id: string;
         device_count: number;
         acs_entrance_count: number;
+        space_key?: string | undefined;
     }[] | undefined;
     devices?: {
         display_name: string;
@@ -15103,6 +15110,7 @@ declare const batch: z.ZodObject<{
         space_id: string;
         device_count: number;
         acs_entrance_count: number;
+        space_key?: string | undefined;
     }[] | undefined;
     devices?: {
         display_name: string;
@@ -27583,6 +27591,7 @@ type MagicLink = z.infer<typeof magic_link>;
 declare const space: z.ZodObject<{
     space_id: z.ZodString;
     workspace_id: z.ZodString;
+    space_key: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
     display_name: z.ZodString;
     created_at: z.ZodString;
@@ -27596,6 +27605,7 @@ declare const space: z.ZodObject<{
     space_id: string;
     device_count: number;
     acs_entrance_count: number;
+    space_key?: string | undefined;
 }, {
     name: string;
     display_name: string;
@@ -27604,6 +27614,7 @@ declare const space: z.ZodObject<{
     space_id: string;
     device_count: number;
     acs_entrance_count: number;
+    space_key?: string | undefined;
 }>;
 type Space = z.infer<typeof space>;
 
@@ -28410,6 +28421,10 @@ declare const _default: {
                         format: string;
                         type: string;
                     };
+                    access_grant_key: {
+                        description: string;
+                        type: string;
+                    };
                     access_method_ids: {
                         description: string;
                         items: {
@@ -39107,6 +39122,10 @@ declare const _default: {
                         format: string;
                         type: string;
                     };
+                    space_key: {
+                        description: string;
+                        type: string;
+                    };
                     workspace_id: {
                         description: string;
                         format: string;
@@ -44333,6 +44352,10 @@ declare const _default: {
                                     type?: never;
                                 } | {
                                     properties: {
+                                        access_grant_key: {
+                                            description: string;
+                                            type: string;
+                                        };
                                         acs_entrance_ids: {
                                             default: never[];
                                             description: string;
@@ -44632,16 +44655,6 @@ declare const _default: {
             get: {
                 description: string;
                 operationId: string;
-                parameters: {
-                    in: string;
-                    name: string;
-                    required: boolean;
-                    schema: {
-                        description: string;
-                        format: string;
-                        type: string;
-                    };
-                }[];
                 responses: {
                     200: {
                         content: {
@@ -44706,15 +44719,28 @@ declare const _default: {
                     content: {
                         'application/json': {
                             schema: {
-                                properties: {
-                                    access_grant_id: {
-                                        description: string;
-                                        format: string;
-                                        type: string;
+                                oneOf: ({
+                                    properties: {
+                                        access_grant_id: {
+                                            description: string;
+                                            format: string;
+                                            type: string;
+                                        };
+                                        access_grant_key?: never;
                                     };
-                                };
-                                required: string[];
-                                type: string;
+                                    required: string[];
+                                    type: string;
+                                } | {
+                                    properties: {
+                                        access_grant_key: {
+                                            description: string;
+                                            type: string;
+                                        };
+                                        access_grant_id?: never;
+                                    };
+                                    required: string[];
+                                    type: string;
+                                })[];
                             };
                         };
                     };
@@ -44801,6 +44827,16 @@ declare const _default: {
                         'x-deprecated': string;
                         description?: never;
                     };
+                } | {
+                    in: string;
+                    name: string;
+                    schema: {
+                        description: string;
+                        type: string;
+                        format?: never;
+                        deprecated?: never;
+                        'x-deprecated'?: never;
+                    };
                 })[];
                 responses: {
                     200: {
@@ -44870,6 +44906,10 @@ declare const _default: {
                         'application/json': {
                             schema: {
                                 properties: {
+                                    access_grant_key: {
+                                        description: string;
+                                        type: string;
+                                    };
                                     acs_entrance_id: {
                                         description: string;
                                         format: string;
@@ -65555,6 +65595,10 @@ declare const _default: {
                                         description: string;
                                         type: string;
                                     };
+                                    space_key: {
+                                        description: string;
+                                        type: string;
+                                    };
                                 };
                                 required: string[];
                                 type: string;
@@ -65748,16 +65792,6 @@ declare const _default: {
             get: {
                 description: string;
                 operationId: string;
-                parameters: {
-                    in: string;
-                    name: string;
-                    required: boolean;
-                    schema: {
-                        description: string;
-                        format: string;
-                        type: string;
-                    };
-                }[];
                 responses: {
                     200: {
                         content: {
@@ -65814,15 +65848,28 @@ declare const _default: {
                     content: {
                         'application/json': {
                             schema: {
-                                properties: {
-                                    space_id: {
-                                        description: string;
-                                        format: string;
-                                        type: string;
+                                oneOf: ({
+                                    properties: {
+                                        space_id: {
+                                            description: string;
+                                            format: string;
+                                            type: string;
+                                        };
+                                        space_key?: never;
                                     };
-                                };
-                                required: string[];
-                                type: string;
+                                    required: string[];
+                                    type: string;
+                                } | {
+                                    properties: {
+                                        space_key: {
+                                            description: string;
+                                            type: string;
+                                        };
+                                        space_id?: never;
+                                    };
+                                    required: string[];
+                                    type: string;
+                                })[];
                             };
                         };
                     };
@@ -66104,7 +66151,7 @@ declare const _default: {
             get: {
                 description: string;
                 operationId: string;
-                parameters: {
+                parameters: ({
                     in: string;
                     name: string;
                     schema: {
@@ -66112,7 +66159,15 @@ declare const _default: {
                         minLength: number;
                         type: string;
                     };
-                }[];
+                } | {
+                    in: string;
+                    name: string;
+                    schema: {
+                        description: string;
+                        type: string;
+                        minLength?: never;
+                    };
+                })[];
                 responses: {
                     200: {
                         content: {
@@ -66178,6 +66233,10 @@ declare const _default: {
                                         minLength: number;
                                         type: string;
                                     };
+                                    space_key: {
+                                        description: string;
+                                        type: string;
+                                    };
                                 };
                                 type: string;
                             };
@@ -86690,6 +86749,8 @@ interface Routes {
                 full_name?: (string | null) | undefined;
             };
         }) & {
+            /** Unique key for the access grant within the workspace. */
+            access_grant_key?: string | undefined;
             /**
              * @deprecated Use `space_ids`. */
             location_ids?: string[] | undefined;
@@ -86727,6 +86788,8 @@ interface Routes {
                 workspace_id: string;
                 /** ID of the Access Grant. */
                 access_grant_id: string;
+                /** Unique key for the access grant within the workspace. */
+                access_grant_key?: string | undefined;
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
@@ -86780,6 +86843,9 @@ interface Routes {
         commonParams: {
             /** ID of Access Grant to get. */
             access_grant_id: string;
+        } | {
+            /** Unique key of Access Grant to get. */
+            access_grant_key: string;
         };
         formData: {};
         jsonResponse: {
@@ -86789,6 +86855,8 @@ interface Routes {
                 workspace_id: string;
                 /** ID of the Access Grant. */
                 access_grant_id: string;
+                /** Unique key for the access grant within the workspace. */
+                access_grant_key?: string | undefined;
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
@@ -86839,6 +86907,8 @@ interface Routes {
             location_id?: string | undefined;
             /** ID of the space by which you want to filter the list of Access Grants. */
             space_id?: string | undefined;
+            /** Filter Access Grants by access_grant_key. */
+            access_grant_key?: string | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -86847,6 +86917,8 @@ interface Routes {
                 workspace_id: string;
                 /** ID of the Access Grant. */
                 access_grant_id: string;
+                /** Unique key for the access grant within the workspace. */
+                access_grant_key?: string | undefined;
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
@@ -123331,6 +123403,8 @@ interface Routes {
         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. */
@@ -123345,6 +123419,8 @@ interface Routes {
                 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. */
@@ -123378,6 +123454,9 @@ interface Routes {
         commonParams: {
             /** ID of the space that you want to get. */
             space_id: string;
+        } | {
+            /** Unique key of the space that you want to get. */
+            space_key: string;
         };
         formData: {};
         jsonResponse: {
@@ -123387,6 +123466,8 @@ interface Routes {
                 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. */
@@ -123421,6 +123502,8 @@ interface Routes {
                     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. */
@@ -124699,6 +124782,8 @@ interface Routes {
         commonParams: {
             /** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`. */
             search?: string | undefined;
+            /** Filter spaces by space_key. */
+            space_key?: string | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -124707,6 +124792,8 @@ interface Routes {
                 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. */
@@ -124767,6 +124854,8 @@ interface Routes {
                 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. */
@@ -140220,6 +140309,8 @@ interface Routes {
                 workspace_id: string;
                 /** ID of the Access Grant. */
                 access_grant_id: string;
+                /** Unique key for the access grant within the workspace. */
+                access_grant_key?: string | undefined;
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
@@ -140282,6 +140373,8 @@ interface Routes {
                 workspace_id: string;
                 /** ID of the Access Grant. */
                 access_grant_id: string;
+                /** Unique key for the access grant within the workspace. */
+                access_grant_key?: string | undefined;
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**
@@ -140340,6 +140433,8 @@ interface Routes {
                 workspace_id: string;
                 /** ID of the Access Grant. */
                 access_grant_id: string;
+                /** Unique key for the access grant within the workspace. */
+                access_grant_key?: string | undefined;
                 /** ID of user identity to which the Access Grant gives access. */
                 user_identity_id: string;
                 /**

package/dist/index.cjs

@@ -3966,6 +3966,7 @@ var space = zod.z.object({
   workspace_id: zod.z.string().uuid().describe(
     "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space."
   ),
+  space_key: zod.z.string().optional().describe("Unique key for the space within the workspace."),
   name: zod.z.string().describe("Name of the space."),
   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."),
@@ -7101,6 +7102,10 @@ var openapi_default = {
             format: "uuid",
             type: "string"
           },
+          access_grant_key: {
+            description: "Unique key for the access grant within the workspace.",
+            type: "string"
+          },
           access_method_ids: {
             description: "IDs of the access methods created for the Access Grant.",
             items: { format: "uuid", type: "string" },
@@ -23567,6 +23572,10 @@ var openapi_default = {
             format: "uuid",
             type: "string"
           },
+          space_key: {
+            description: "Unique key for the space within the workspace.",
+            type: "string"
+          },
           workspace_id: {
             description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space.",
             format: "uuid",
@@ -30271,6 +30280,10 @@ var openapi_default = {
                   },
                   {
                     properties: {
+                      access_grant_key: {
+                        description: "Unique key for the access grant within the workspace.",
+                        type: "string"
+                      },
                       acs_entrance_ids: {
                         default: [],
                         description: "Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to which access is being granted.",
@@ -30485,18 +30498,6 @@ var openapi_default = {
       get: {
         description: "Get an Access Grant.",
         operationId: "accessGrantsGetGet",
-        parameters: [
-          {
-            in: "query",
-            name: "access_grant_id",
-            required: true,
-            schema: {
-              description: "ID of Access Grant to get.",
-              format: "uuid",
-              type: "string"
-            }
-          }
-        ],
         responses: {
           200: {
             content: {
@@ -30538,15 +30539,29 @@ var openapi_default = {
           content: {
             "application/json": {
               schema: {
-                properties: {
-                  access_grant_id: {
-                    description: "ID of Access Grant to get.",
-                    format: "uuid",
-                    type: "string"
+                oneOf: [
+                  {
+                    properties: {
+                      access_grant_id: {
+                        description: "ID of Access Grant to get.",
+                        format: "uuid",
+                        type: "string"
+                      }
+                    },
+                    required: ["access_grant_id"],
+                    type: "object"
+                  },
+                  {
+                    properties: {
+                      access_grant_key: {
+                        description: "Unique key of Access Grant to get.",
+                        type: "string"
+                      }
+                    },
+                    required: ["access_grant_key"],
+                    type: "object"
                   }
-                },
-                required: ["access_grant_id"],
-                type: "object"
+                ]
               }
             }
           }
@@ -30636,6 +30651,14 @@ var openapi_default = {
               format: "uuid",
               type: "string"
             }
+          },
+          {
+            in: "query",
+            name: "access_grant_key",
+            schema: {
+              description: "Filter Access Grants by access_grant_key.",
+              type: "string"
+            }
           }
         ],
         responses: {
@@ -30683,6 +30706,10 @@ var openapi_default = {
             "application/json": {
               schema: {
                 properties: {
+                  access_grant_key: {
+                    description: "Filter Access Grants by access_grant_key.",
+                    type: "string"
+                  },
                   acs_entrance_id: {
                     description: "ID of the entrance by which you want to filter the list of Access Grants.",
                     format: "uuid",
@@ -48722,6 +48749,10 @@ var openapi_default = {
                   name: {
                     description: "Name of the space that you want to create.",
                     type: "string"
+                  },
+                  space_key: {
+                    description: "Unique key for the space within the workspace.",
+                    type: "string"
                   }
                 },
                 required: ["name"],
@@ -48868,18 +48899,6 @@ var openapi_default = {
       get: {
         description: "Gets a space.",
         operationId: "spacesGetGet",
-        parameters: [
-          {
-            in: "query",
-            name: "space_id",
-            required: true,
-            schema: {
-              description: "ID of the space that you want to get.",
-              format: "uuid",
-              type: "string"
-            }
-          }
-        ],
         responses: {
           200: {
             content: {
@@ -48920,15 +48939,29 @@ var openapi_default = {
           content: {
             "application/json": {
               schema: {
-                properties: {
-                  space_id: {
-                    description: "ID of the space that you want to get.",
-                    format: "uuid",
-                    type: "string"
+                oneOf: [
+                  {
+                    properties: {
+                      space_id: {
+                        description: "ID of the space that you want to get.",
+                        format: "uuid",
+                        type: "string"
+                      }
+                    },
+                    required: ["space_id"],
+                    type: "object"
+                  },
+                  {
+                    properties: {
+                      space_key: {
+                        description: "Unique key of the space that you want to get.",
+                        type: "string"
+                      }
+                    },
+                    required: ["space_key"],
+                    type: "object"
                   }
-                },
-                required: ["space_id"],
-                type: "object"
+                ]
               }
             }
           }
@@ -49163,6 +49196,14 @@ var openapi_default = {
               minLength: 1,
               type: "string"
             }
+          },
+          {
+            in: "query",
+            name: "space_key",
+            schema: {
+              description: "Filter spaces by space_key.",
+              type: "string"
+            }
           }
         ],
         responses: {
@@ -49213,6 +49254,10 @@ var openapi_default = {
                     description: "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.",
                     minLength: 1,
                     type: "string"
+                  },
+                  space_key: {
+                    description: "Filter spaces by space_key.",
+                    type: "string"
                   }
                 },
                 type: "object"