@seamapi/types 1.445.1 → 1.446.0

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

@@ -9933,6 +9933,8 @@ export 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;
@@ -9970,6 +9972,8 @@ export 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;
                 /**
@@ -10023,6 +10027,9 @@ export 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: {
@@ -10032,6 +10039,8 @@ export 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;
                 /**
@@ -10082,6 +10091,8 @@ export 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: {
@@ -10090,6 +10101,8 @@ export 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;
                 /**
@@ -46574,6 +46587,8 @@ export 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. */
@@ -46588,6 +46603,8 @@ export 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. */
@@ -46621,6 +46638,9 @@ export 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: {
@@ -46630,6 +46650,8 @@ export 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. */
@@ -46664,6 +46686,8 @@ export 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. */
@@ -47942,6 +47966,8 @@ export 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: {
@@ -47950,6 +47976,8 @@ export 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. */
@@ -48010,6 +48038,8 @@ export 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. */
@@ -63463,6 +63493,8 @@ export 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;
                 /**
@@ -63525,6 +63557,8 @@ export 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;
                 /**
@@ -63583,6 +63617,8 @@ export 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/package.json

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

package/src/lib/seam/connect/models/access-grants/access-grant.ts

@@ -8,6 +8,10 @@ export const access_grant = z.object({
     .uuid()
     .describe('ID of the Seam workspace associated with the Access Grant.'),
   access_grant_id: z.string().uuid().describe('ID of the Access Grant.'),
+  access_grant_key: z
+    .string()
+    .optional()
+    .describe('Unique key for the access grant within the workspace.'),
   user_identity_id: z
     .string()
     .uuid()

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

@@ -8,6 +8,10 @@ export const space = z.object({
     .describe(
       'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space.',
     ),
+  space_key: z
+    .string()
+    .optional()
+    .describe('Unique key for the space within the workspace.'),
   name: z.string().describe('Name of the space.'),
   display_name: z.string().describe('Display name for the space.'),
   created_at: z

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

@@ -1822,6 +1822,11 @@ export 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.',
@@ -20059,6 +20064,10 @@ export 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.',
@@ -27559,6 +27568,11 @@ export default {
                   },
                   {
                     properties: {
+                      access_grant_key: {
+                        description:
+                          'Unique key for the access grant within the workspace.',
+                        type: 'string',
+                      },
                       acs_entrance_ids: {
                         default: [],
                         description:
@@ -27782,18 +27796,6 @@ export 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: {
@@ -27835,15 +27837,29 @@ export 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',
                   },
-                },
-                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',
+                  },
+                ],
               },
             },
           },
@@ -27938,6 +27954,14 @@ export default {
               type: 'string',
             },
           },
+          {
+            in: 'query',
+            name: 'access_grant_key',
+            schema: {
+              description: 'Filter Access Grants by access_grant_key.',
+              type: 'string',
+            },
+          },
         ],
         responses: {
           200: {
@@ -27984,6 +28008,10 @@ export 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.',
@@ -47025,6 +47053,11 @@ export default {
                     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'],
                 type: 'object',
@@ -47170,18 +47203,6 @@ export 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: {
@@ -47222,15 +47243,30 @@ export 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',
                   },
-                },
-                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',
+                  },
+                ],
               },
             },
           },
@@ -47469,6 +47505,14 @@ export default {
               type: 'string',
             },
           },
+          {
+            in: 'query',
+            name: 'space_key',
+            schema: {
+              description: 'Filter spaces by space_key.',
+              type: 'string',
+            },
+          },
         ],
         responses: {
           200: {
@@ -47520,6 +47564,10 @@ export default {
                     minLength: 1,
                     type: 'string',
                   },
+                  space_key: {
+                    description: 'Filter spaces by space_key.',
+                    type: 'string',
+                  },
                 },
                 type: 'object',
               },

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

@@ -11155,6 +11155,8 @@ export interface Routes {
           }
         }
     ) & {
+      /** Unique key for the access grant within the workspace. */
+      access_grant_key?: string | undefined
       /**
        * @deprecated Use `space_ids`. */
       location_ids?: string[] | undefined
@@ -11194,6 +11196,8 @@ export 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
         /**
@@ -11244,10 +11248,15 @@ export interface Routes {
     method: 'GET' | 'POST'
     queryParams: {}
     jsonBody: {}
-    commonParams: {
-      /** ID of Access Grant to get. */
-      access_grant_id: string
-    }
+    commonParams:
+      | {
+          /** ID of Access Grant to get. */
+          access_grant_id: string
+        }
+      | {
+          /** Unique key of Access Grant to get. */
+          access_grant_key: string
+        }
     formData: {}
     jsonResponse: {
       /** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
@@ -11256,6 +11265,8 @@ export 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
         /**
@@ -11306,6 +11317,8 @@ export 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: {
@@ -11314,6 +11327,8 @@ export 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
         /**
@@ -54931,6 +54946,8 @@ export 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. */
@@ -54945,6 +54962,8 @@ export 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. */
@@ -54975,10 +54994,15 @@ export interface Routes {
     method: 'GET' | 'POST'
     queryParams: {}
     jsonBody: {}
-    commonParams: {
-      /** ID of the space that you want to get. */
-      space_id: string
-    }
+    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: {
       /** 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. */
@@ -54987,6 +55011,8 @@ export 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. */
@@ -55022,6 +55048,8 @@ export 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. */
@@ -56644,6 +56672,8 @@ export 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: {
@@ -56652,6 +56682,8 @@ export 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. */
@@ -56712,6 +56744,8 @@ export 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. */
@@ -74730,6 +74764,8 @@ export 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
         /**
@@ -74792,6 +74828,8 @@ export 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
         /**
@@ -74850,6 +74888,8 @@ export 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
         /**