@seamapi/types 1.445.0 → 1.446.0

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

@@ -1815,36 +1815,41 @@ export default {
       },
       access_grant: {
         description:
-          '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.',
+          '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.',
         properties: {
           access_grant_id: {
-            description: 'ID of the access grant.',
+            description: 'ID of the Access Grant.',
             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.',
+              'IDs of the access methods created for the Access Grant.',
             items: { format: 'uuid', type: 'string' },
             type: 'array',
           },
           created_at: {
-            description: 'Date and time at which the access grant was created.',
+            description: 'Date and time at which the Access Grant was created.',
             format: 'date-time',
             type: 'string',
           },
           display_name: {
-            description: 'Display name of the access grant.',
+            description: 'Display name of the Access Grant.',
             type: 'string',
           },
           ends_at: {
-            description: 'Date and time at which the access grant ends.',
+            description: 'Date and time at which the Access Grant ends.',
             format: 'date-time',
             type: 'string',
           },
           instant_key_url: {
             description:
-              'Instant Key URL. Only returned if the access grant has a single mobile_key access_method. ',
+              'Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. ',
             format: 'uri',
             type: 'string',
           },
@@ -1856,7 +1861,7 @@ export default {
           },
           requested_access_methods: {
             description:
-              'Access methods that the user requested for the access grant.',
+              'Access methods that the user requested for the Access Grant.',
             items: {
               properties: {
                 created_access_method_ids: {
@@ -1867,7 +1872,7 @@ export default {
                 },
                 created_at: {
                   description:
-                    'Date and time at which the requested access method was added to the access grant.',
+                    'Date and time at which the requested access method was added to the Access Grant.',
                   format: 'date-time',
                   type: 'string',
                 },
@@ -1894,24 +1899,24 @@ export default {
           },
           space_ids: {
             description:
-              'IDs of the spaces to which the access grant gives access.',
+              'IDs of the spaces to which the Access Grant gives access.',
             items: { format: 'uuid', type: 'string' },
             type: 'array',
           },
           starts_at: {
-            description: 'Date and time at which the access grant starts.',
+            description: 'Date and time at which the Access Grant starts.',
             format: 'date-time',
             type: 'string',
           },
           user_identity_id: {
             description:
-              'ID of user identity to which the access grant gives access.',
+              'ID of user identity to which the Access Grant gives access.',
             format: 'uuid',
             type: 'string',
           },
           workspace_id: {
             description:
-              'ID of the Seam workspace associated with the access grant.',
+              'ID of the Seam workspace associated with the Access Grant.',
             format: 'uuid',
             type: 'string',
           },
@@ -1933,7 +1938,7 @@ export default {
       },
       access_method: {
         description:
-          'Represents an access method for an access grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.',
+          'Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.',
         properties: {
           access_method_id: {
             description: 'ID of the access method.',
@@ -14227,10 +14232,10 @@ export default {
             'x-route-path': '/access_codes/unmanaged',
           },
           {
-            description: 'An access grant was created.',
+            description: 'An Access Grant was created.',
             properties: {
               access_grant_id: {
-                description: 'ID of the affected access grant.',
+                description: 'ID of the affected Access Grant.',
                 format: 'uuid',
                 type: 'string',
               },
@@ -14269,10 +14274,10 @@ export default {
             'x-route-path': '/access_grants',
           },
           {
-            description: 'An access grant was deleted.',
+            description: 'An Access Grant was deleted.',
             properties: {
               access_grant_id: {
-                description: 'ID of the affected access grant.',
+                description: 'ID of the affected Access Grant.',
                 format: 'uuid',
                 type: 'string',
               },
@@ -14312,10 +14317,10 @@ export default {
           },
           {
             description:
-              'All access requested for an access grant was successfully granted.',
+              'All access requested for an Access Grant was successfully granted.',
             properties: {
               access_grant_id: {
-                description: 'ID of the affected access grant.',
+                description: 'ID of the affected Access Grant.',
                 format: 'uuid',
                 type: 'string',
               },
@@ -14358,10 +14363,10 @@ export default {
           },
           {
             description:
-              'Access requested as part of an access grant to a particular door was successfully granted.',
+              'Access requested as part of an Access Grant to a particular door was successfully granted.',
             properties: {
               access_grant_id: {
-                description: 'ID of the affected access grant.',
+                description: 'ID of the affected Access Grant.',
                 format: 'uuid',
                 type: 'string',
               },
@@ -14411,10 +14416,10 @@ export default {
           },
           {
             description:
-              'Access to a particular door that was requested as part of an access grant was lost.',
+              'Access to a particular door that was requested as part of an Access Grant was lost.',
             properties: {
               access_grant_id: {
-                description: 'ID of the affected access grant.',
+                description: 'ID of the affected Access Grant.',
                 format: 'uuid',
                 type: 'string',
               },
@@ -14636,7 +14641,7 @@ export default {
           },
           {
             description:
-              'An access method was reissued due to an access grant update.',
+              'An access method was reissued due to an Access Grant update.',
             properties: {
               access_method_id: {
                 description: 'ID of the affected access method.',
@@ -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.',
@@ -27503,7 +27512,7 @@ export default {
     },
     '/access_grants/create': {
       post: {
-        description: 'Creates a new access grant.',
+        description: 'Creates a new Access Grant.',
         operationId: 'accessGrantsCreatePost',
         requestBody: {
           content: {
@@ -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:
@@ -27683,7 +27697,7 @@ export default {
     },
     '/access_grants/delete': {
       delete: {
-        description: 'Delete an access grant.',
+        description: 'Delete an Access Grant.',
         operationId: 'accessGrantsDeleteDelete',
         parameters: [
           {
@@ -27691,7 +27705,7 @@ export default {
             name: 'access_grant_id',
             required: true,
             schema: {
-              description: 'ID of access grant to delete.',
+              description: 'ID of Access Grant to delete.',
               format: 'uuid',
               type: 'string',
             },
@@ -27728,7 +27742,7 @@ export default {
         'x-title': 'Delete an Access Grant',
       },
       post: {
-        description: 'Delete an access grant.',
+        description: 'Delete an Access Grant.',
         operationId: 'accessGrantsDeletePost',
         requestBody: {
           content: {
@@ -27736,7 +27750,7 @@ export default {
               schema: {
                 properties: {
                   access_grant_id: {
-                    description: 'ID of access grant to delete.',
+                    description: 'ID of Access Grant to delete.',
                     format: 'uuid',
                     type: 'string',
                   },
@@ -27780,20 +27794,8 @@ export default {
     },
     '/access_grants/get': {
       get: {
-        description: 'Get an access grant.',
+        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: {
@@ -27829,21 +27831,35 @@ export default {
         'x-title': 'Get an Access Grant',
       },
       post: {
-        description: 'Get an access grant.',
+        description: 'Get an Access Grant.',
         operationId: 'accessGrantsGetPost',
         requestBody: {
           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',
+                  },
+                ],
               },
             },
           },
@@ -27885,7 +27901,7 @@ export default {
     },
     '/access_grants/list': {
       get: {
-        description: 'Get an access grant.',
+        description: 'Gets an Access Grant.',
         operationId: 'accessGrantsListGet',
         parameters: [
           {
@@ -27893,7 +27909,7 @@ export default {
             name: 'user_identity_id',
             schema: {
               description:
-                'ID of user identity to filter list of access grants by.',
+                'ID of user identity by which you want to filter the list of Access Grants.',
               format: 'uuid',
               type: 'string',
             },
@@ -27902,7 +27918,8 @@ export default {
             in: 'query',
             name: 'acs_system_id',
             schema: {
-              description: 'ID of system to filter list of access grants by.',
+              description:
+                'ID of the access system by which you want to filter the list of Access Grants.',
               format: 'uuid',
               type: 'string',
             },
@@ -27911,7 +27928,8 @@ export default {
             in: 'query',
             name: 'acs_entrance_id',
             schema: {
-              description: 'ID of entrance to filter list of access grants by.',
+              description:
+                'ID of the entrance by which you want to filter the list of Access Grants.',
               format: 'uuid',
               type: 'string',
             },
@@ -27930,11 +27948,20 @@ export default {
             in: 'query',
             name: 'space_id',
             schema: {
-              description: 'ID of space to filter list of access grants by.',
+              description:
+                'ID of the space by which you want to filter the list of Access Grants.',
               format: 'uuid',
               type: 'string',
             },
           },
+          {
+            in: 'query',
+            name: 'access_grant_key',
+            schema: {
+              description: 'Filter Access Grants by access_grant_key.',
+              type: 'string',
+            },
+          },
         ],
         responses: {
           200: {
@@ -27974,22 +28001,26 @@ export default {
         'x-title': 'List Access Grants',
       },
       post: {
-        description: 'Get an access grant.',
+        description: 'Gets an Access Grant.',
         operationId: 'accessGrantsListPost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
                 properties: {
+                  access_grant_key: {
+                    description: 'Filter Access Grants by access_grant_key.',
+                    type: 'string',
+                  },
                   acs_entrance_id: {
                     description:
-                      'ID of entrance to filter list of access grants by.',
+                      'ID of the entrance by which you want to filter the list of Access Grants.',
                     format: 'uuid',
                     type: 'string',
                   },
                   acs_system_id: {
                     description:
-                      'ID of system to filter list of access grants by.',
+                      'ID of the access system by which you want to filter the list of Access Grants.',
                     format: 'uuid',
                     type: 'string',
                   },
@@ -28001,13 +28032,13 @@ export default {
                   },
                   space_id: {
                     description:
-                      'ID of space to filter list of access grants by.',
+                      'ID of the space by which you want to filter the list of Access Grants.',
                     format: 'uuid',
                     type: 'string',
                   },
                   user_identity_id: {
                     description:
-                      'ID of user identity to filter list of access grants by.',
+                      'ID of user identity by which you want to filter the list of Access Grants.',
                     format: 'uuid',
                     type: 'string',
                   },
@@ -28057,7 +28088,7 @@ export default {
     },
     '/access_grants/update': {
       patch: {
-        description: "Updates an existing access grant's time window.",
+        description: "Updates an existing Access Grant's time window.",
         operationId: 'accessGrantsUpdatePatch',
         requestBody: {
           content: {
@@ -28065,7 +28096,7 @@ export default {
               schema: {
                 properties: {
                   access_grant_id: {
-                    description: 'ID of the access grant to update.',
+                    description: 'ID of the Access Grant to update.',
                     format: 'uuid',
                     type: 'string',
                   },
@@ -28121,7 +28152,7 @@ export default {
         'x-title': 'Update an Access Grant',
       },
       post: {
-        description: "Updates an existing access grant's time window.",
+        description: "Updates an existing Access Grant's time window.",
         operationId: 'accessGrantsUpdatePost',
         requestBody: {
           content: {
@@ -28129,7 +28160,7 @@ export default {
               schema: {
                 properties: {
                   access_grant_id: {
-                    description: 'ID of the access grant to update.',
+                    description: 'ID of the Access Grant to update.',
                     format: 'uuid',
                     type: 'string',
                   },
@@ -28187,7 +28218,7 @@ export default {
     },
     '/access_methods/delete': {
       delete: {
-        description: 'Delete an access method.',
+        description: 'Deletes an access method.',
         operationId: 'accessMethodsDeleteDelete',
         parameters: [
           {
@@ -28231,7 +28262,7 @@ export default {
         'x-title': 'Delete an Access Method',
       },
       post: {
-        description: 'Delete an access method.',
+        description: 'Deletes an access method.',
         operationId: 'accessMethodsDeletePost',
         requestBody: {
           content: {
@@ -28283,7 +28314,7 @@ export default {
     '/access_methods/encode': {
       post: {
         description:
-          'Encodes an existing [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
+          'Encodes an existing access method onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
         operationId: 'accessMethodsEncodePost',
         requestBody: {
           content: {
@@ -28298,7 +28329,7 @@ export default {
                   },
                   acs_encoder_id: {
                     description:
-                      'ID of the `acs_encoder` to use to encode the `acs_credential`.',
+                      'ID of the `acs_encoder` to use to encode the `access_method`.',
                     format: 'uuid',
                     type: 'string',
                   },
@@ -28347,7 +28378,7 @@ export default {
     },
     '/access_methods/get': {
       get: {
-        description: 'Get an access method.',
+        description: 'Gets an access method.',
         operationId: 'accessMethodsGetGet',
         parameters: [
           {
@@ -28397,7 +28428,7 @@ export default {
         'x-title': 'Get an Access Method',
       },
       post: {
-        description: 'Get an access method.',
+        description: 'Gets an access method.',
         operationId: 'accessMethodsGetPost',
         requestBody: {
           content: {
@@ -28455,7 +28486,7 @@ export default {
     '/access_methods/list': {
       get: {
         description:
-          'List all access methods, usually filtered by access grant.',
+          'Lists all access methods, usually filtered by Access Grant.',
         operationId: 'accessMethodsListGet',
         parameters: [
           {
@@ -28463,7 +28494,7 @@ export default {
             name: 'access_grant_id',
             required: true,
             schema: {
-              description: 'ID of access grant to list access methods for.',
+              description: 'ID of Access Grant to list access methods for.',
               format: 'uuid',
               type: 'string',
             },
@@ -28540,7 +28571,7 @@ export default {
       },
       post: {
         description:
-          'List all access methods, usually filtered by access grant.',
+          'Lists all access methods, usually filtered by Access Grant.',
         operationId: 'accessMethodsListPost',
         requestBody: {
           content: {
@@ -28549,7 +28580,7 @@ export default {
                 properties: {
                   access_grant_id: {
                     description:
-                      'ID of access grant to list access methods for.',
+                      'ID of Access Grant to list access methods for.',
                     format: 'uuid',
                     type: 'string',
                   },
@@ -47022,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',
@@ -47167,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: {
@@ -47219,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',
+                  },
+                ],
               },
             },
           },
@@ -47466,6 +47505,14 @@ export default {
               type: 'string',
             },
           },
+          {
+            in: 'query',
+            name: 'space_key',
+            schema: {
+              description: 'Filter spaces by space_key.',
+              type: 'string',
+            },
+          },
         ],
         responses: {
           200: {
@@ -47517,6 +47564,10 @@ export default {
                     minLength: 1,
                     type: 'string',
                   },
+                  space_key: {
+                    description: 'Filter spaces by space_key.',
+                    type: 'string',
+                  },
                 },
                 type: 'object',
               },