@seamapi/types 1.445.0 → 1.446.0

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

@@ -6,12 +6,16 @@ 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.'),
+  access_grant_key: z
+    .string()
+    .optional()
+    .describe('Unique key for the access grant within the workspace.'),
   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\`.
@@ -19,41 +23,41 @@ 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. ',
+      '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.
   `)
 
 export type AccessGrant = z.infer<typeof access_grant>

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

@@ -41,7 +41,7 @@ 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.
   `)
 
 export type AccessMethod = z.infer<typeof access_method>

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

@@ -11,7 +11,7 @@ export const requested_access_method = z.object({
     .string()
     .datetime()
     .describe(
-      '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.',
     ),
   created_access_method_ids: z
     .array(z.string().uuid())

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

@@ -6,7 +6,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({
@@ -15,7 +15,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({
@@ -24,7 +24,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 =
@@ -34,7 +34,7 @@ export const access_grant_access_granted_to_all_doors_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.
   `)
 
 export type AccessGrantAccessGrantedToAllDoorsEvent = z.infer<
@@ -56,7 +56,7 @@ export const access_grant_access_granted_to_door_event =
     ---
     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 type AccessGrantAccessGrantedToDoorEvent = z.infer<
@@ -72,7 +72,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 type AccessGrantAccessToDoorLostEvent = z.infer<

package/src/lib/seam/connect/models/events/access-methods.ts

@@ -58,7 +58,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 type AccessMethodRevokedEvent = z.infer<

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