@seamapi/types 1.445.0 → 1.445.1

package/lib/seam/connect/models/access-grants/access-grant.js

@@ -4,12 +4,12 @@ export const access_grant = z.object({
     workspace_id: z
         .string()
         .uuid()
-        .describe('ID of the Seam workspace associated with the access grant.'),
-    access_grant_id: z.string().uuid().describe('ID of the access grant.'),
+        .describe('ID of the Seam workspace associated with the Access Grant.'),
+    access_grant_id: z.string().uuid().describe('ID of the Access Grant.'),
     user_identity_id: z
         .string()
         .uuid()
-        .describe('ID of user identity to which the access grant gives access.'),
+        .describe('ID of user identity to which the Access Grant gives access.'),
     location_ids: z.array(z.string().uuid()).describe(`
     ---
     deprecated: Use \`space_ids\`.
@@ -17,38 +17,38 @@ export const access_grant = z.object({
   `),
     space_ids: z
         .array(z.string().uuid())
-        .describe('IDs of the spaces to which the access grant gives access.'),
+        .describe('IDs of the spaces to which the Access Grant gives access.'),
     requested_access_methods: z
         .array(requested_access_method)
-        .describe('Access methods that the user requested for the access grant.'),
+        .describe('Access methods that the user requested for the Access Grant.'),
     access_method_ids: z
         .array(z.string().uuid())
-        .describe('IDs of the access methods created for the access grant.'),
-    display_name: z.string().describe('Display name of the access grant.'),
+        .describe('IDs of the access methods created for the Access Grant.'),
+    display_name: z.string().describe('Display name of the Access Grant.'),
     instant_key_url: z
         .string()
         .url()
         .optional()
-        .describe('Instant Key URL. Only returned if the access grant has a single mobile_key access_method. '),
+        .describe('Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. '),
     created_at: z
         .string()
         .datetime()
-        .describe('Date and time at which the access grant was created.'),
+        .describe('Date and time at which the Access Grant was created.'),
     starts_at: z
         .string()
         .datetime()
         .optional()
-        .describe('Date and time at which the access grant starts.'),
+        .describe('Date and time at which the Access Grant starts.'),
     ends_at: z
         .string()
         .datetime()
         .optional()
-        .describe('Date and time at which the access grant ends.'),
+        .describe('Date and time at which the Access Grant ends.'),
 }).describe(`
   ---
   draft: Early access.
   route_path: /access_grants
   ---
-  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.
   `);
 //# sourceMappingURL=access-grant.js.map

package/lib/seam/connect/models/access-grants/access-method.js

@@ -36,6 +36,6 @@ export const access_method = z.object({
   draft: Early access.
   route_path: /access_methods
   ---
-  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.
   `);
 //# sourceMappingURL=access-method.js.map

package/lib/seam/connect/models/access-grants/requested-access-method.js

@@ -7,7 +7,7 @@ export const requested_access_method = z.object({
     created_at: z
         .string()
         .datetime()
-        .describe('Date and time at which the requested access method was added to the access grant.'),
+        .describe('Date and time at which the requested access method was added to the Access Grant.'),
     created_access_method_ids: z
         .array(z.string().uuid())
         .describe('IDs of the access methods created for the requested access method.'),

package/lib/seam/connect/models/events/access-grants.js

@@ -4,7 +4,7 @@ const access_grant_event = common_event.extend({
     access_grant_id: z
         .string()
         .uuid()
-        .describe('ID of the affected access grant.'),
+        .describe('ID of the affected Access Grant.'),
 });
 export const access_grant_created_event = access_grant_event.extend({
     event_type: z.literal('access_grant.created'),
@@ -12,7 +12,7 @@ export const access_grant_created_event = access_grant_event.extend({
     ---
     route_path: /access_grants
     ---
-    An access grant was created.
+    An Access Grant was created.
   `);
 export const access_grant_deleted_event = access_grant_event.extend({
     event_type: z.literal('access_grant.deleted'),
@@ -20,7 +20,7 @@ export const access_grant_deleted_event = access_grant_event.extend({
     ---
     route_path: /access_grants
     ---
-    An access grant was deleted.
+    An Access Grant was deleted.
   `);
 export const access_grant_access_granted_to_all_doors_event = access_grant_event.extend({
     event_type: z.literal('access_grant.access_granted_to_all_doors'),
@@ -28,7 +28,7 @@ export const access_grant_access_granted_to_all_doors_event = access_grant_event
     ---
     route_path: /access_grants
     ---
-    All access requested for an access grant was successfully granted.
+    All access requested for an Access Grant was successfully granted.
   `);
 const acs_entrance_id = z
     .string()
@@ -41,7 +41,7 @@ export const access_grant_access_granted_to_door_event = access_grant_event.exte
     ---
     route_path: /access_grants
     ---
-    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.
   `);
 export const access_grant_access_to_door_lost_event = access_grant_event.extend({
     event_type: z.literal('access_grant.access_to_door_lost'),
@@ -50,7 +50,7 @@ export const access_grant_access_to_door_lost_event = access_grant_event.extend(
     ---
     route_path: /access_grants
     ---
-    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.
   `);
 export const access_grant_events = [
     access_grant_created_event,

package/lib/seam/connect/models/events/access-methods.js

@@ -44,7 +44,7 @@ export const access_method_reissued_event = access_method_event.extend({
     ---
     route_path: /access_methods
     ---
-    An access method was reissued due to an access grant update.
+    An access method was reissued due to an Access Grant update.
   `);
 export const access_method_events = [
     access_method_issued_event,

package/lib/seam/connect/openapi.js

@@ -1569,34 +1569,34 @@ export default {
                 'x-route-path': '/access_codes',
             },
             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.',
+                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.',
                 properties: {
                     access_grant_id: {
-                        description: 'ID of the access grant.',
+                        description: 'ID of the Access Grant.',
                         format: 'uuid',
                         type: 'string',
                     },
                     access_method_ids: {
-                        description: 'IDs of the access methods created for the access grant.',
+                        description: '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. ',
+                        description: 'Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. ',
                         format: 'uri',
                         type: 'string',
                     },
@@ -1607,7 +1607,7 @@ export default {
                         'x-deprecated': 'Use `space_ids`.',
                     },
                     requested_access_methods: {
-                        description: 'Access methods that the user requested for the access grant.',
+                        description: 'Access methods that the user requested for the Access Grant.',
                         items: {
                             properties: {
                                 created_access_method_ids: {
@@ -1616,7 +1616,7 @@ export default {
                                     type: 'array',
                                 },
                                 created_at: {
-                                    description: 'Date and time at which the requested access method was added to the access grant.',
+                                    description: 'Date and time at which the requested access method was added to the Access Grant.',
                                     format: 'date-time',
                                     type: 'string',
                                 },
@@ -1641,22 +1641,22 @@ export default {
                         type: 'array',
                     },
                     space_ids: {
-                        description: 'IDs of the spaces to which the access grant gives access.',
+                        description: '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.',
+                        description: '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.',
+                        description: 'ID of the Seam workspace associated with the Access Grant.',
                         format: 'uuid',
                         type: 'string',
                     },
@@ -1677,7 +1677,7 @@ export default {
                 'x-route-path': '/access_grants',
             },
             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.',
+                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.',
                 properties: {
                     access_method_id: {
                         description: 'ID of the access method.',
@@ -12648,10 +12648,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',
                             },
@@ -12689,10 +12689,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',
                             },
@@ -12730,10 +12730,10 @@ export default {
                         'x-route-path': '/access_grants',
                     },
                     {
-                        description: 'All access requested for an access grant was successfully granted.',
+                        description: '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',
                             },
@@ -12774,10 +12774,10 @@ export default {
                         'x-route-path': '/access_grants',
                     },
                     {
-                        description: 'Access requested as part of an access grant to a particular door was successfully granted.',
+                        description: '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',
                             },
@@ -12824,10 +12824,10 @@ export default {
                         'x-route-path': '/access_grants',
                     },
                     {
-                        description: 'Access to a particular door that was requested as part of an access grant was lost.',
+                        description: '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',
                             },
@@ -13041,7 +13041,7 @@ export default {
                         'x-route-path': '/access_methods',
                     },
                     {
-                        description: 'An access method was reissued due to an access grant update.',
+                        description: 'An access method was reissued due to an Access Grant update.',
                         properties: {
                             access_method_id: {
                                 description: 'ID of the affected access method.',
@@ -24694,7 +24694,7 @@ export default {
         },
         '/access_grants/create': {
             post: {
-                description: 'Creates a new access grant.',
+                description: 'Creates a new Access Grant.',
                 operationId: 'accessGrantsCreatePost',
                 requestBody: {
                     content: {
@@ -24861,7 +24861,7 @@ export default {
         },
         '/access_grants/delete': {
             delete: {
-                description: 'Delete an access grant.',
+                description: 'Delete an Access Grant.',
                 operationId: 'accessGrantsDeleteDelete',
                 parameters: [
                     {
@@ -24869,7 +24869,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',
                         },
@@ -24906,7 +24906,7 @@ export default {
                 'x-title': 'Delete an Access Grant',
             },
             post: {
-                description: 'Delete an access grant.',
+                description: 'Delete an Access Grant.',
                 operationId: 'accessGrantsDeletePost',
                 requestBody: {
                     content: {
@@ -24914,7 +24914,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',
                                     },
@@ -24958,7 +24958,7 @@ export default {
         },
         '/access_grants/get': {
             get: {
-                description: 'Get an access grant.',
+                description: 'Get an Access Grant.',
                 operationId: 'accessGrantsGetGet',
                 parameters: [
                     {
@@ -24966,7 +24966,7 @@ export default {
                         name: 'access_grant_id',
                         required: true,
                         schema: {
-                            description: 'ID of access grant to get.',
+                            description: 'ID of Access Grant to get.',
                             format: 'uuid',
                             type: 'string',
                         },
@@ -25007,7 +25007,7 @@ export default {
                 'x-title': 'Get an Access Grant',
             },
             post: {
-                description: 'Get an access grant.',
+                description: 'Get an Access Grant.',
                 operationId: 'accessGrantsGetPost',
                 requestBody: {
                     content: {
@@ -25015,7 +25015,7 @@ export default {
                             schema: {
                                 properties: {
                                     access_grant_id: {
-                                        description: 'ID of access grant to get.',
+                                        description: 'ID of Access Grant to get.',
                                         format: 'uuid',
                                         type: 'string',
                                     },
@@ -25063,14 +25063,14 @@ export default {
         },
         '/access_grants/list': {
             get: {
-                description: 'Get an access grant.',
+                description: 'Gets an Access Grant.',
                 operationId: 'accessGrantsListGet',
                 parameters: [
                     {
                         in: 'query',
                         name: 'user_identity_id',
                         schema: {
-                            description: 'ID of user identity to filter list of access grants by.',
+                            description: 'ID of user identity by which you want to filter the list of Access Grants.',
                             format: 'uuid',
                             type: 'string',
                         },
@@ -25079,7 +25079,7 @@ 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',
                         },
@@ -25088,7 +25088,7 @@ 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',
                         },
@@ -25107,7 +25107,7 @@ 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',
                         },
@@ -25151,7 +25151,7 @@ export default {
                 'x-title': 'List Access Grants',
             },
             post: {
-                description: 'Get an access grant.',
+                description: 'Gets an Access Grant.',
                 operationId: 'accessGrantsListPost',
                 requestBody: {
                     content: {
@@ -25159,12 +25159,12 @@ export default {
                             schema: {
                                 properties: {
                                     acs_entrance_id: {
-                                        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',
                                     },
                                     acs_system_id: {
-                                        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',
                                     },
@@ -25175,12 +25175,12 @@ export default {
                                         'x-deprecated': 'Use `space_id`.',
                                     },
                                     space_id: {
-                                        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',
                                     },
                                     user_identity_id: {
-                                        description: 'ID of user identity to filter list of access grants by.',
+                                        description: 'ID of user identity by which you want to filter the list of Access Grants.',
                                         format: 'uuid',
                                         type: 'string',
                                     },
@@ -25230,7 +25230,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: {
@@ -25238,7 +25238,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',
                                     },
@@ -25292,7 +25292,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: {
@@ -25300,7 +25300,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',
                                     },
@@ -25356,7 +25356,7 @@ export default {
         },
         '/access_methods/delete': {
             delete: {
-                description: 'Delete an access method.',
+                description: 'Deletes an access method.',
                 operationId: 'accessMethodsDeleteDelete',
                 parameters: [
                     {
@@ -25400,7 +25400,7 @@ export default {
                 'x-title': 'Delete an Access Method',
             },
             post: {
-                description: 'Delete an access method.',
+                description: 'Deletes an access method.',
                 operationId: 'accessMethodsDeletePost',
                 requestBody: {
                     content: {
@@ -25451,7 +25451,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).',
+                description: '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: {
@@ -25464,7 +25464,7 @@ export default {
                                         type: 'string',
                                     },
                                     acs_encoder_id: {
-                                        description: 'ID of the `acs_encoder` to use to encode the `acs_credential`.',
+                                        description: 'ID of the `acs_encoder` to use to encode the `access_method`.',
                                         format: 'uuid',
                                         type: 'string',
                                     },
@@ -25513,7 +25513,7 @@ export default {
         },
         '/access_methods/get': {
             get: {
-                description: 'Get an access method.',
+                description: 'Gets an access method.',
                 operationId: 'accessMethodsGetGet',
                 parameters: [
                     {
@@ -25563,7 +25563,7 @@ export default {
                 'x-title': 'Get an Access Method',
             },
             post: {
-                description: 'Get an access method.',
+                description: 'Gets an access method.',
                 operationId: 'accessMethodsGetPost',
                 requestBody: {
                     content: {
@@ -25620,7 +25620,7 @@ export default {
         },
         '/access_methods/list': {
             get: {
-                description: 'List all access methods, usually filtered by access grant.',
+                description: 'Lists all access methods, usually filtered by Access Grant.',
                 operationId: 'accessMethodsListGet',
                 parameters: [
                     {
@@ -25628,7 +25628,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',
                         },
@@ -25701,7 +25701,7 @@ export default {
                 'x-title': 'List Access Methods',
             },
             post: {
-                description: 'List all access methods, usually filtered by access grant.',
+                description: 'Lists all access methods, usually filtered by Access Grant.',
                 operationId: 'accessMethodsListPost',
                 requestBody: {
                     content: {
@@ -25709,7 +25709,7 @@ export default {
                             schema: {
                                 properties: {
                                     access_grant_id: {
-                                        description: 'ID of access grant to list access methods for.',
+                                        description: 'ID of Access Grant to list access methods for.',
                                         format: 'uuid',
                                         type: 'string',
                                     },